App Center - .ini file

From Univention Wiki

Revision as of 19:31, 10 December 2012 by Sgohmann (talk | contribs)
Jump to: navigation, search

Template:UCS 3.1 Development

This page illustrates the structure of an .ini file as it is stored for each application in Univention App Center. In addition to the .ini file, the following files (as simple text files) can be stored in the repository directory for each application:

  • README_UPDATE: Notes and Tips for an update of the application, e.g. a reference to the release notes as well as important information that must be taken into account for the update.
  • LICENSE_AGREEMENT: If a license agreement has to be accepted during the installation, the text can be given with this file. The text should clearly state who grants the license. Please avoid indefinite words like "we".

An example structure for the .ini file:

[Application]
# internal id
ID=application

# display name of the application
Name=The Application

# application version
Version=7.1


# a short description of the application (max. 60 characters)
Description=Lorem ipsum dolor sit amet, consetetur sadipscing elitr, se.

# a more complete description of the application (max. 500 characters)
# in order to use multiple lines, preceed lines with one or more white spaces
LongDescription=Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed
 diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
 sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit
 amet.  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
 nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed
 diam voluptua. At vero eos et accusam et justo duo dolores et.

# applicable category
Categories=System

# reference to screenshot file (.png or .jpg file) (optional)
Screenshot=application_screenshot.jpg

# whether the user's email address will be transmitted to the vendor
NotifyVendor=False

# website for more information about the product (e.g. landing page)
Website=http://www.software.com/products/application/welcome

# display name of the vendor
Vendor=Software GmbH

# optional: website of the vendor for more information
WebsiteVendor=http://www.software.com/

# optional: display name of the maintainer
# If the vendor does not maintain the application, this is the place, where the 
# maintainer can be named. This value is optional.
Maintainer=Maintain GmbH

# optional: website of the maintainer for more information
WebsiteMaintainer=http://www.maintain.com

# contact address for the customer
Contact=sales@software.com


# other applications which cannot be installed at the same time (comma separated list)
# (optional)
ConflictedApps=fooapp,barapp

# system packages which conflict with the application (comma separated list)
# ... these are essential similar to those conflicts specified in the
# debian packages themselves, however, in order to show conflicts directly
# in the app center and without querying the debian package information,
# these can be specified in the .ini file, as well (optional)
ConflictedSystemPackages=mysql5,python2.5

# application packages to be installed (comma separated list)
DefaultPackages=univention-application

# packages that need to be installed on all master and backup systems (comma separated list),
# e.g., LDAP schema extension, UDM modules (optional)
# NOTE: these packages will be left installed on the system when the
#       app is being uninstalled
DefaultPackagesMaster=univention-application-schema

# allow installation on these server roles
serverrole=domaincontroller_master,domaincontroller_backup,domaincontroller_slave,memberserver

# German translations
[de]
Description=Lorem ipsum dolor sit amet, consetetur sadipscing elitr, se.
LongDescription=Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed
 diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat,
 sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.
 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit
 amet.  Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam
 nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed
 diam voluptua. At vero eos et accusam et justo duo dolores et.
Personal tools