| Author: | Michael JasonSmith |
|---|---|
| Contact: | Michael JasonSmith <mpj17@onlinegroups.net> |
| Date: | 2014-05-26 |
| Organization: | GroupServer.org |
| Copyright: | This document is licensed under a Creative Commons Attribution-Share Alike 4.0 International License by OnlineGroups.net. |
The core GroupServer configuration is provided by an INI
file in the etc/ directory of the GroupServer
installation. This product supplies a zc.buildout recipe
[1] that creates this configuration file. It is
controlled by a number of parameters that are set in the
buildout-configuration, and a lock file.
The gs.config product reads in the data from the INI file
[2].
Calling the recipe is done by buildout. It is configured like
other zc.buildout recipes:
[create-config]
recipe = gs.recipe.config
dest = ${buildout:etc-directory}/gsconfig.ini
database_host = ${config:pgsql_host}
database_port = ${config:pgsql_port}
database_username = ${config:pgsql_user}
database_password = ${config:pgsql_password}
database_name = ${config:pgsql_dbname}
smtp_host = ${config:smtp_host}
smtp_port = ${config:smtp_port}
smtp_user = ${config:smtp_user}
smtp_password = ${config:smtp_password}
The values for the parameters are set in the main config.cfg
file, except for the dest, which is defined by buildout
itself.
When called the recipe will create the gsconfig.ini file, and
define both outgoing SMTP and database connectivity.
The following parameters must be supplied to the recipe.
dest:- The destination configuration file.
database_host:- The host-name of the PostgreSQL database.
database_port:- The port that the PostgreSQL database is listening on.
database_name:- The name of the PostgreSQL database that will store all the tables used by GroupServer.
smtp_host:- The name of the outgoing SMTP host.
smtp_port:- The port that the outgoing SMTP host listens to.
The following four parameters are optional.
database_username:- The name of the PostgreSQL database user.
database_password:- The password that the PostgreSQL database user will use to log
in. (Yes, this will be written down in the
INIfile.) smtp_user:- The name used to log into the outgoing SMTP host.
smtp_password:- The password used to log into the outgoing SMTP host. (Yes,
this will be written down in the
INIfile.)
To ensure the INI file is only crated once a lock file is
crated, var/create-config.cfg, within the GroupServer
installation directory. (The name is actually taken from the name
of the section in the configuration file.)
- Code repository: https://source.iopen.net/groupserver/gs.recipe.config/
- Questions and comments to http://groupserver.org/groups/develop/
- Report bugs at https://redmine.iopen.net/projects/groupserver/
| [1] | See Buildout.org for more information. |
| [2] | See https://source.iopen.net/groupserver/gs.config/ |