Home » Documentation » Extending » How to build Add-ons » Add-on deployment package
Add-ons are uploaded to Litium Studio/Scensum Knowledge Center in a zip-package. This article describes the required format of the zip-package.
File name
The file name of the zip-package should be equal to the Add-on name (including Add-on version) + ".zip". Example: "Page Type Blog 2.zip"
File contents
The zip-file should have the following contents:
| / |
|
| /Readme.txt |
Installation instructions and general information |
| /DB |
SQL-scripts and database backups (optional) |
| /Definitions |
XML-files needed to install (optional) |
| /Deploy |
Files to deploy |
| /Docs |
Documentation (optional) |
| /Source |
Source code (optional) |
Readme.txt
Instructions (in plain text format) on
- how to install the Add-on (mandatory). In it's simplest form, installation means copying the contents of the "Deploy" folder to the destination www-root folder.
- how to upgrade between different versions of the Add-on, and between different versions of Litium Studio/Litium Scensum (optional).
- whether the Add-on is a free or commercial Add-on (mandatory).
- contact information and URL to the Add-on on Litium Studio/Scensum Knowledge Center (mandatory).
Se the attached example, "Readme.txt."
/DB-folder
Place sql-scripts and database backups needed during installation in this folder.
/Definitions-folder
Place xml-definition files such as page type definitions, translations etc ni this folder.
/Deploy
Place all the deployement files in this folder. The contents of this folder (not the folder itself) is to be copied to the destination www-root folder.
/Docs
Place additional documentation in this folder (optional). Use plain .txt format or pdf-files if possible.
/Source
Place source code in this folder (optional).
Comments made
No comments are made
You need to be logged in to make a comment