See [QuickStart] for how to get an instance up and running on your host / VM.
See [Roles]
The following environment variables are used by OpenGroupware Coils:
Variable | Effect |
---|---|
COILS_HTTP_LISTEN_ADDRESS | override the value of the CoilsListenAddress default. The value should be an address to on which to listen. |
COILS_EXTRA_MODULES | A CSV list additional Python modules that should be scanned for commands, actions, and services. |
COILS_BANNED_MODULES | A CSV list of modules that should not be loaded by coils-master-service. |
COILS_BANNED_SERVICES | A CSV list of services that should not be started by coils-master service. |
COILS_RPC2_PROXY_TARGET | overrides the value of the CoilsXMLRPCProxyTarget default. The value should be the hostname or address of an OpenGroupware Legacy ZideStore instance. Note this is not the URL, but the hostname or address. The URL will be constructed using this target. |
OGO_SERVER_ROOT | Indicates the default storage root of the server instance, this value is used rather than the home directory of the effective user. |
COILS_HOSTNAME | Provides an alternative host-name, other than that provided by the operating system, that will be used to determine what services this host is intended to provide. |
HOME | Should indicate the home directory of the current user (this is the default behavior of 99.44% of UNIX and UNIX-like operating systems) |
COILS_LOG_FILE | Determines the location of the log file used by OpenGroupware Coils components. If not specified the value defaults to "/var/log/coils.log". Typically debugging/developer setups will default this to a file within the root specified by OGO_SERVER_ROOT. Support for this variable was added in 0.1.49rc75. |
COILS_SERVICE_LIST | A CSV list of services that should be started by the "[coils.master]" component. The value of this variable overrides the value of the [CoilsServiceHostIndex] server default. Any components banned by either COILS_BANNED_SERVICES or command-line option are not started, even if included in the COILS_SERVICE_LIST value. Note that banning a module using COILS_BANNED_MODULES may also prevent a service from being available to be started. |
COILS_ORM_LOGGING | If defined, regardless of value, ORM logging will be enabled. This will record all database operations performed to the services log file. |
In a typical configuration services are started by the [coils.master] service which is invoked by the coils-master-service command. This service starts other services and potentially restarts them if they fail. Which services a given instance of [coils.master] starts depends upon the system's configuration and environment; components can be spread across multiple server instances.
Wiki: CoilsServiceHostIndex
Wiki: DevQuickStart
Wiki: QuickStart
Wiki: Roles
Wiki: coils.blob.autoprint
Wiki: coils.watcher
Wiki: coils.workflow.9100
Wiki: zOGI