wiki:ConfigFiles

*NOTE:* This is hideousely out of date. Somebody needs to spend an hour to document all config options. Option names suck anyway, rewrite ticket?

Configuration files

There are a bunch of configuration files in infoarena2. We try to place reasonable defaults in SVN, but some files must always be edited to match you local setup. For those files we added $file.sample in svn, you're supposed to copy them over to $file and edit them (at least the --write-me-- fields). Don't add the edited files in svn, we don't care about your local development setup. :)

List of config files

  • config.php: The main php config file.
  • www/.htaccess: Apache .htaccess file. You just need to set RewriteBase.
  • www/config.php: Web-specific configuration.
  • eval/config.php: Eval-specific configuration. Mostly security-related stuff. You can work on the website without a functional evaluator anyway.
  • smf/Settings.php: SMF-specific configuration. Most are already configured, just rename it without the .sample.

config.php

  • IA_ROOT: Website root directory on the hard drive. This is the path of your svn checkout dir. It can be something like "D:/Projects/infoarena/"
  • DB_HOST: Database host. When developing you will probably run a database server on localhost.
  • DB_NAME: Database name. You need to create a database on the server.
  • DB_TABLE_NAME: Database table name. The default should work, it's used in the database dump.
  • DB_USER: Database username.
  • DB_PASS: Database password.
  • IA_URL_PREFIX: website url, relative to the web server.
  • IA_URL_HOST: webserver part of the url. You probably want to leave this set to "http://localhost/"

FIXME: Write about the other config files.

FIXME: Is documenting every single option really useful?