# Module signing tool

**URL:** <https://forum.inductiveautomation.com/t/module-signing-tool/18885>\
**Category:** Module Development\
**Created:** [July 18, 2018, 8:18pm UTC](https://forum.inductiveautomation.com/t/module-signing-tool/18885 "2018-07-18T20:18:48Z")\
**Posts on this page:** 5\
**Page:** 2

<div class="post-metadata">

**Author:** ![PRAMANJ](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pramanj/32/66935_2.png) [@PRAMANJ](https://forum.inductiveautomation.com/u/PRAMANJ)\
**Post date:** [August 13, 2018, 6:46pm UTC](https://forum.inductiveautomation.com/t/module-signing-tool/18885/21 "2018-08-13T18:46:15Z")

</div>

Thanks a lot. I am able to see the LicenseState class. , I will be able to implement the feature.

Thanks for the JAVADOCS link, it will be handy.

---

<div class="post-metadata">

**Author:** ![PRAMANJ](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pramanj/32/66935_2.png) [@PRAMANJ](https://forum.inductiveautomation.com/u/PRAMANJ)\
**Post date:** [August 14, 2018, 5:18am UTC](https://forum.inductiveautomation.com/t/module-signing-tool/18885/22 "2018-08-14T05:18:19Z")

</div>

The documentation says

- **description optional.** A description for the module.
- **license** - optional. Name of an HTML file to be found in the root level of the modl file. Should define the license for the module. This is the license that a user would agree to upon installing the module.
- **documentation** - optional. Name of an HTML file which is the root of a user manual for the module. If present, this file must be located under a folder named "doc" in the modl file. Other HTML, image, and CSS files may be located in there as well. These webpages will be mounted when the module is installed.

I have put a one line text description in description field of xml , but its not visible anywhere in Ignition after installing it!  
I have put a license.html file in the folder where the .modl file is generated on build, but its not bundled in .modl file? Where should it exist , the documentation is not clear! Where does the user see the License file in Ignition Module configuration page!  
Similarly where should the /doc/manual.html be kept for documentation!

---

<div class="post-metadata">

**Author:** ![pturmel](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pturmel/32/3295_2.png) [@pturmel](https://forum.inductiveautomation.com/u/pturmel)\
**Post date:** [August 14, 2018, 11:26am UTC](https://forum.inductiveautomation.com/t/module-signing-tool/18885/23 "2018-08-14T11:26:24Z")

</div>

> [@PRAMANJ](#):
>
> I have put a one line text description in description field of xml , but its not visible anywhere in Ignition after installing it!

Mine show up in the list of modules under the configuration pages of the gateway. In the description column.

> [@PRAMANJ](#):
>
> I have put a license.html file in the folder where the .modl file is generated on build, but its not bundled in .modl file?

I don't know how it's done in maven, but in ant I specifically include the license html file .modl file in the root of the .modl. I keep it in the "Build" subproject. It is shown to the user during installation, where they have to accept it before installation, but only if the user has never accepted that license before. A hash over the license appears to be stored in Ignition's internal database to skip repeats.

> [@PRAMANJ](#):
>
> Similarly where should the /doc/manual.html be kept for documentation!

I don't know about for maven, but with ant you are on your own. I keep my doc hierarchy or pdf files in the doc folder of my Build subproject, and have entries in ant to include the appropriate parts of that folder in the .modl file.

---

<div class="post-metadata">

**Author:** ![PRAMANJ](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/pramanj/32/66935_2.png) [@PRAMANJ](https://forum.inductiveautomation.com/u/PRAMANJ)\
**Post date:** [August 14, 2018, 12:19pm UTC](https://forum.inductiveautomation.com/t/module-signing-tool/18885/24 "2018-08-14T12:19:26Z")

</div>

Yes it was working fine with earlier version using ant, but in maven I am missing some thing. The html files have to be kept in some resource folder I guess in the project setup I guess. Hope I am able to figure it out soon.

Thanks for your reply.

b/r

---

<div class="post-metadata">

**Author:** ![paul-griffith](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/paul-griffith/32/37249_2.png) [@paul-griffith](https://forum.inductiveautomation.com/u/paul-griffith)\
**Post date:** [October 11, 2018, 2:49pm UTC](https://forum.inductiveautomation.com/t/module-signing-tool/18885/25 "2018-10-11T14:49:50Z")

</div>

Split this topic on October 11, 2018, 2:49pm UTC

A post was split to a new topic: [Module signing questions](https://forum.inductiveautomation.com/t/module-signing-questions/20089)

[Previous page](https://forum.inductiveautomation.com/t/module-signing-tool/18885.md?page=1)
