FusionForge

Difference between revisions of "Configuration"

From FusionForge Wiki
Jump to: navigation, search
(Location and syntax of config files, and initial list of variables with minimal description for a couple of them)
(Section: core: More documentation of variables in the [core] section)
Line 16: Line 16:
 
* core/account_manager_type
 
* core/account_manager_type
 
* core/admin_email
 
* core/admin_email
* core/allow_project_without_template
+
* '''allow_project_without_template''' (boolean): allow users to not choose a template project when registering a new project.  If false, then new projects will always be based on a template (unless no such template exists, of course).
 
* core/apache_group
 
* core/apache_group
 
* core/apache_user
 
* core/apache_user
Line 22: Line 22:
 
* core/config_path
 
* core/config_path
 
* core/custom_path
 
* core/custom_path
* core/database_host
+
* '''database_host''': hostname or IP address of the database server (or empty if the DB is accessed through the Unix-domain sockets).
* core/database_name
+
* '''database_name''': name of the database to use.
* core/database_password
+
* '''database_password''': connection password for the database.
* core/database_port
+
* '''database_port''': connection port for the database.
* core/database_user
+
* '''database_user''': user for the database connection.
 
* core/data_path
 
* core/data_path
 
* core/default_country_code
 
* core/default_country_code
Line 37: Line 37:
 
* '''extra_config_files''': other individual configuration files to read.
 
* '''extra_config_files''': other individual configuration files to read.
 
* core/force_login
 
* core/force_login
* core/forge_name
+
* '''forge_name''': the "visible name" of the forge.  Used in webpage titles, in emails, in feedback messages, and so on.  Could be set to "YourCompanyForge" for instance.
 
* core/forum_return_domain
 
* core/forum_return_domain
 
* core/ftp_upload_dir
 
* core/ftp_upload_dir
 
* core/groupdir_prefix
 
* core/groupdir_prefix
 
* core/homedir_prefix
 
* core/homedir_prefix
* core/http_port
+
* '''http_port''': if your forge is on a non-standard HTTP port, you'll need to set this variable accordingly.
* core/https_port
+
* '''https_port''': ditto for HTTP.
 
* core/images_secure_url
 
* core/images_secure_url
 
* core/images_url
 
* core/images_url
Line 89: Line 89:
 
* core/url_prefix
 
* core/url_prefix
 
* core/url_root
 
* core/url_root
* core/use_docman
+
* '''use_docman''': whether to enable the document manager feature.
* core/use_forum
+
* '''use_forum''': enable forums?
* core/use_frs
+
* '''use_frs''': enable file release system?
 
* core/use_fti
 
* core/use_fti
 
* core/use_ftp
 
* core/use_ftp
Line 97: Line 97:
 
* core/use_gateways
 
* core/use_gateways
 
* core/use_jabber
 
* core/use_jabber
* core/use_mail
+
* '''use_mail''': use mailing-lists?
* core/use_manual_uploads
+
* '''use_manual_uploads''': allow the FRS to work on files uploaded by hand (SSH/SCP).
* core/use_news
+
* '''use_news''': use announcements.
 
* core/use_people
 
* core/use_people
* core/use_pm
+
* '''use_pm''': use task trackers?
 
* core/use_project_database
 
* core/use_project_database
* core/use_project_full_list
+
* '''use_project_full_list''': allow displaying the full list of projects?
 
* core/use_project_multimedia
 
* core/use_project_multimedia
* core/use_project_tags
+
* '''use_project_tags''': enable the tagging feature on projects (and the tag cloud).
 
* core/use_project_vhost
 
* core/use_project_vhost
 
* core/use_ratings
 
* core/use_ratings
 
* core/user_registration_restricted
 
* core/user_registration_restricted
 
* core/users_host
 
* core/users_host
* core/use_scm
+
* '''use_scm''': enable source control management?
 
* core/use_shell
 
* core/use_shell
* core/use_snippet
+
* '''use_snippet''': enable repository of code snippets?
 
* '''use_ssl''' (boolean): whether to use https:// URLs (instead of http:// ones) when possible.
 
* '''use_ssl''' (boolean): whether to use https:// URLs (instead of http:// ones) when possible.
* core/use_survey
+
* '''use_survey''': enable project surveys?
* core/use_tracker
+
* '''use_tracker''': enable the generic bug/patch/support request/etc. tracker?
* core/use_trove
+
* '''use_trove''': enable the project categorisation in the trove map?
* core/web_host
+
* '''web_host''': hostname of the webserver, used in many URLs.
  
 
== Section: mediawiki ==
 
== Section: mediawiki ==

Revision as of 13:46, 7 January 2011

Configuration files

Location

The most common location for the configuration files will be /etc/fusionforge/config.ini and the files under /etc/fusionforge/config.ini.d/*. Note that in that directory, only files with extension ".ini" and those without an extension will be taken into account (so that files such as foo.old, foo.bak and so on are ignored). Note also that you can reference other files and directories by adding extra_config_files and extra_config_dirs variables (see below) to one of the standard files.

Syntax

The config files are standard *.ini files as widely used in Windows, PHP and other systems. It's basically a key/value store, where there are different namespaces for the keys called sections. The variables controlling the features in the core of FusionForge are in section [core], the variables controlling the "extratabs" plugin are in section [extratabs], and so on.

For values storing a string, quoting is required when the string contains spaces, or quotes, or any kind of special character. For boolean variables, some flexibility is available, and the value can be stored as "true", "1", "on", "yes", "false", "0", "off" or "no".

Comments start with a semicolon and extend to the end of the line. Empty lines are ignored.

Variables can reference one another with the "$section/variable" syntax. For instance, in section [scmsvn], the default value for repos_path is defined in relation to the value of chroot in section [core] with the following syntax: repos_path = "$core/chroot/scmrepos/svn". If the chroot variable is set to /srv/fusionforge/chroot, then the repos_path value will automatically contain /srv/fusionforge/chroot/scmrepos/svn; other variables will also be updated accordingly, without needing to set their individual values in the config files.

Configuration variables

Section: core

  • core/account_manager_type
  • core/admin_email
  • allow_project_without_template (boolean): allow users to not choose a template project when registering a new project. If false, then new projects will always be based on a template (unless no such template exists, of course).
  • core/apache_group
  • core/apache_user
  • core/chroot
  • core/config_path
  • core/custom_path
  • database_host: hostname or IP address of the database server (or empty if the DB is accessed through the Unix-domain sockets).
  • database_name: name of the database to use.
  • database_password: connection password for the database.
  • database_port: connection port for the database.
  • database_user: user for the database connection.
  • core/data_path
  • core/default_country_code
  • core/default_language
  • core/default_theme
  • core/default_timezone
  • core/default_trove_cat
  • core/download_host
  • extra_config_dirs: directories containing other configuration files to read.
  • extra_config_files: other individual configuration files to read.
  • core/force_login
  • forge_name: the "visible name" of the forge. Used in webpage titles, in emails, in feedback messages, and so on. Could be set to "YourCompanyForge" for instance.
  • core/forum_return_domain
  • core/ftp_upload_dir
  • core/groupdir_prefix
  • core/homedir_prefix
  • http_port: if your forge is on a non-standard HTTP port, you'll need to set this variable accordingly.
  • https_port: ditto for HTTP.
  • core/images_secure_url
  • core/images_url
  • core/installation_environment
  • core/jabber_host
  • core/jabber_password
  • core/jabber_port
  • core/jabber_user
  • core/jpgraph_path
  • core/ldap_admin_dn
  • core/ldap_base_dn
  • core/ldap_bind_dn
  • core/ldap_host
  • core/ldap_password
  • core/ldap_port
  • core/ldap_version
  • core/lists_host
  • core/log_path
  • core/mailman_path
  • core/news_group
  • core/peer_rating_group
  • core/plugins_path
  • core/project_auto_approval
  • core/project_auto_approval_user
  • project_registration_restricted (boolean): whether to allow any registered user to request projects (false) or restrict project registration to those users that are allowed to approve projects (true).
  • core/scm_host
  • core/scm_snapshots_path
  • core/scm_tarballs_path
  • core/sendmail_path
  • core/session_key
  • core/shell_host
  • core/show_source
  • core/source_path
  • core/stats_group
  • core/sysdebug_akelos
  • core/sysdebug_backtraces
  • core/sysdebug_enable
  • core/sysdebug_ignored
  • core/sysdebug_phphandler
  • core/sysdebug_xmlstarlet
  • core/template_group
  • core/themes_root
  • core/unix_cipher
  • core/upload_dir
  • core/url_prefix
  • core/url_root
  • use_docman: whether to enable the document manager feature.
  • use_forum: enable forums?
  • use_frs: enable file release system?
  • core/use_fti
  • core/use_ftp
  • core/use_ftp_uploads
  • core/use_gateways
  • core/use_jabber
  • use_mail: use mailing-lists?
  • use_manual_uploads: allow the FRS to work on files uploaded by hand (SSH/SCP).
  • use_news: use announcements.
  • core/use_people
  • use_pm: use task trackers?
  • core/use_project_database
  • use_project_full_list: allow displaying the full list of projects?
  • core/use_project_multimedia
  • use_project_tags: enable the tagging feature on projects (and the tag cloud).
  • core/use_project_vhost
  • core/use_ratings
  • core/user_registration_restricted
  • core/users_host
  • use_scm: enable source control management?
  • core/use_shell
  • use_snippet: enable repository of code snippets?
  • use_ssl (boolean): whether to use https:// URLs (instead of http:// ones) when possible.
  • use_survey: enable project surveys?
  • use_tracker: enable the generic bug/patch/support request/etc. tracker?
  • use_trove: enable the project categorisation in the trove map?
  • web_host: hostname of the webserver, used in many URLs.

Section: mediawiki

  • mediawiki/use_frame

Section: scmbzr

  • scmbzr/default_server
  • scmbzr/repos_path

Section: scmcvs

  • scmcvs/default_server
  • scmcvs/repos_path

Section: scmdarcs

  • scmdarcs/default_server
  • scmdarcs/repos_path

Section: scmgit

  • scmgit/default_server
  • scmgit/repos_path

Section: scmhg

  • scmhg/default_server
  • scmhg/repos_path

Section: scmsvn

  • scmsvn/default_server
  • scmsvn/repos_path
  • scmsvn/use_dav
  • scmsvn/use_ssh
  • scmsvn/use_ssl