Difference between revisions of "Docker Apps/Files"

From Univention Wiki

Jump to: navigation, search
Line 5: Line 5:
 
;env: An environment file used during the creation of the Docker Container. It contains static configuration options passed to the container via docker create ... --env ${env}. See the [https://docs.docker.com/engine/reference/commandline/run/#/set-environment-variables-e-env-env-file Docker Documentation].
 
;env: An environment file used during the creation of the Docker Container. It contains static configuration options passed to the container via docker create ... --env ${env}. See the [https://docs.docker.com/engine/reference/commandline/run/#/set-environment-variables-e-env-env-file Docker Documentation].
  
;univention-config-registry-variables: This file contains (a superset of) UCR variable definitions. These definitions exist on a regular UCS to describe the specific variables in the UCR database. In this context, they are used to set UCR variables in the Docker Container. If this file is present, there will be a form before the installation of the App and after the installation on a separate page within the App Center module ("App Settings"). Further information can be found in Section [[Integration with UCS/Settings]].
+
;settings: This file contains [[Settings]] definitions. If this file is present, there will be a form before the installation of the App and/or after the installation on a separate page within the App Center module ("App Settings").  
  
 
;schema: A schema extension for LDAP. This is useful if you want to, e.g., extend the user objects of UCS by an attribute like "This user may use the App" (see Section [[Integration with UCS/Join]]). The file will be copied to the Docker Host's /usr/share/univention-appcenter/apps/APPID/APPID.schema during installation. See the [http://www.openldap.org/doc/admin24/schema.html LDAP documentation] for the syntax of a schema file. If you need an "official" OID namespace, Univention can provide one. It is important to note that shipping this file alone is not enough. You need to register it in the join script (see Section [[Docker Apps/Container Scripts]]) via ucs_registerLDAPExtension "$@" --schema "/usr/share/univention-appcenter/apps/$APP/$APP.schema".
 
;schema: A schema extension for LDAP. This is useful if you want to, e.g., extend the user objects of UCS by an attribute like "This user may use the App" (see Section [[Integration with UCS/Join]]). The file will be copied to the Docker Host's /usr/share/univention-appcenter/apps/APPID/APPID.schema during installation. See the [http://www.openldap.org/doc/admin24/schema.html LDAP documentation] for the syntax of a schema file. If you need an "official" OID namespace, Univention can provide one. It is important to note that shipping this file alone is not enough. You need to register it in the join script (see Section [[Docker Apps/Container Scripts]]) via ucs_registerLDAPExtension "$@" --schema "/usr/share/univention-appcenter/apps/$APP/$APP.schema".

Revision as of 11:04, 19 July 2017


An App may ship additional files along with the ini file. These are not scripts as Docker Apps/Container Scripts, just plain text files.

env
An environment file used during the creation of the Docker Container. It contains static configuration options passed to the container via docker create ... --env ${env}. See the Docker Documentation.
settings
This file contains Settings definitions. If this file is present, there will be a form before the installation of the App and/or after the installation on a separate page within the App Center module ("App Settings").
schema
A schema extension for LDAP. This is useful if you want to, e.g., extend the user objects of UCS by an attribute like "This user may use the App" (see Section Integration with UCS/Join). The file will be copied to the Docker Host's /usr/share/univention-appcenter/apps/APPID/APPID.schema during installation. See the LDAP documentation for the syntax of a schema file. If you need an "official" OID namespace, Univention can provide one. It is important to note that shipping this file alone is not enough. You need to register it in the join script (see Section Docker Apps/Container Scripts) via ucs_registerLDAPExtension "$@" --schema "/usr/share/univention-appcenter/apps/$APP/$APP.schema".

Directories

There are two directories that are created for every App before actually installing it:

/var/lib/univention-appcenter/apps/$appid/data
/var/lib/univention-appcenter/apps/$appid/conf

These directories may be used for any purpose. For Docker Apps, they are mounted into the container at the same place as read-write. See also Docker Apps/Persistent Data.

Personal tools