FusionForge

Configuration

From FusionForge Wiki
Revision as of 13:58, 14 May 2014 by Beuc-inria (talk | contribs) (Section: core: more on project_auto*)

Jump to: navigation, search

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.

If you're upgrading from a version of FusionForge before 5.1, the migrate-to-ini-files.sh script should take care of migrating your setting from the previous system. In this case, you'll get /etc/fusionforge/config.ini.d/zzz-migrated-old-config and /etc/fusionforge/config.ini.d/zzz-migrated-old-secrets.

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.

Overriding defaults for a local installation

Instead of changing the contents of the defaults.ini file (or other files shipped with the distribution), it may be better to add a /etc/fusionforge/config.ini.d/zz_my_settings.ini (or a similar name to make sure it is the last one in alphabetical order) which will contain local settings overriding the defaults defined earlier in other files.

Access and debugging

If you're confused as to what value a configuration variable ends up with at the end of the parsing of the (possibly many) config files and the interpolation of variables, there's a helper script forge_get_config (available in the utils directory) that displays this value. Its usage is: "forge_get_config web_host core" (change the location of the script if it's installed elsewhere, of course). The arguments are the variable name, and the section; the section can be omitted if it's "core". Another possible invocation is "forge_get_config list-all-variables", which will give you a list of all the configuration variables, and "forge_get_config list-all-variables-values" which will display all of their values too.

Note that this script tries to behave exactly like the rest of the forge in order for the returned results to be accurate. In some cases, though, the user running the script may not have the appropriate rights to read all configuration files, and the script will exit with an error because it tries to access the database. The fix is to run the script with a environment variable that disables the loading of plugins (and the database access): "FUSIONFORGE_NO_PLUGINS=true forge_get_config web_host".

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
  • custom_path : path to a directory containing customizations to index_std.php
  • 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
  • lists_host hostname of the mailing-lists. Set it to "$core/web_host" for instance, if you run mailman on the same domain as the rest for the forge (which needs other tuning to operate fully)
  • core/log_path
  • core/mailman_path
  • core/news_group
  • core/peer_rating_group
  • core/plugins_path
  • core/project_auto_approval (boolean): if true, when users submit a project, it's automatically approved (no need for admin review). This requires project_registration_restricted=false. Also disables "New Project Submitted" notifications to people with approve_projects privilege.
  • core/project_auto_approval_user: if project_auto_approval=true, username of the effective FusionForge user that approves the project internally (default admin); this user needs to have approve_projects privilege.
  • core/project_registration_restricted (boolean): if true, prevent users from registering projects - useful if you don't want to accept new project requests.
  • core/require_unique_email (boolean): whether to require that user's email addresses are unique among all users, or not
  • core/scm_host
  • core/scm_snapshots_path
  • core/scm_tarballs_path
  • core/sendmail_path
  • core/session_key
  • core/session_expire (int): set session validity in seconds. By default, it is not set.
  • 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: Wether to use mailing-lists, and to allow responding to forum notifications by mail
  • use_manual_uploads: allow the FRS and the docman to work on files uploaded by hand (SSH/SCP).
  • use_news: use announcements.
  • use_people : use the "Project Openings" /people/ feature (recruiting contributors, etc.)
  • 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 (boolean): only forge admins can registrate new users
  • core/user_notification_on_activation (boolean): forge admins will receive emails when user has validated his account.
  • 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?
  • use_webdav: enable webdav support
  • web_host: hostname of the webserver, used in many URLs.

Section: mediawiki

  • mediawiki/use_frame
  • mediawiki/enable_uploads : enable file uploads

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
  • use_dav (boolean) whether to use WebDAV to push changes to the repositories (mutual exclusive with use_ssh ?)
  • use_ssh (boolean) whether to use SSH to push changes to the repositories (mutual exclusive with use_dav ?)

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

See also : Developer doc > Configuration