fix sequences in upgrade docs?
[freeside.git] / httemplate / docs / config.html
1 <head>
2   <title>Configuration files</title>
3 </head>
4 <body>
5   <h1>Configuration files</h1>
6 <font size="+1" color="#ff0000">Configuration is now done by the top-level Makefile and web interface.  The instructions below are no longer necessary.</font>
7 <ul>
8   <li>Create the <b>/usr/local/etc/freeside</b> directory to hold your configuration.
9   <li>Setting up <a href="http://www.apache.org/docs/misc/FAQ.html#user-authentication">Apache user authetication</a> is mandatory.
10   <li>Create the <b>/usr/local/etc/freeside/mapsecrets</b> file, which maps Apache users to a secrets file which contains a DBI data source, username and password.  Every
11 line in <b>/usr/local/etc/freeside/mapsecrets</b> should contain a username and
12 filename, separated by whitespace.  Note that these are not local usernames -
13 they are passed from Apache.  <a href="http://www.apache.org/docs/misc/FAQ.html#user-authentication">
14 Apache user authetication</a> is mandatory.  For example, if you had the Apache users admin,
15 john, and sam,  
16 you mapsecrets file might look like:
17 <pre>
18 admin secretfile
19 john secretfile
20 sam secretfile
21 </pre>
22   <li>Next, the filename(s) referenced in <b>/usr/local/etc/freeside/mapsecrets</b> file should be created in the <b>/usr/local/etc/freeside/</b> directory.  Each file contains three lines: <a href="http://search.cpan.org/doc/TIMB/DBI-1.20/DBI.pm">DBI data source</a> (for example,
23   <tt>DBI:mysql:freeside</tt> or <tt>DBI:Pg:host=localhost;dbname=freeside</tt>), database username, and database password.
24   These files should not be world readable.  See the <a href="http://search.cpan.org/doc/TIMB/DBI-1.20/DBI.pm">DBI manpage</a> and the <a href="http://search.cpan.org/search?mode=module&query=DBD">manpage for your DBD</a> for the exact syntax of a DBI data source.  In a normal installation such as the example above, a single file <b>/usr/local/etc/freeside/secretfile</b> would be created - for example:
25 <pre>
26 DBI:Pg:host=localhost;dbname=freeside
27 dbusername
28 dbpassword
29 </pre>
30 <li>Create the <b>/usr/local/etc/freeside/conf.<i>datasource</i></b> directory, for example, <b>/usr/local/etc/freeside/conf.DBI:Pg:host=localhost;dbname=freeside</b> (remember to backslash-escape the ; character when creating directories in the shell:
31 <pre>mkdir&nbsp;/usr/local/etc/freeside/conf.DBI:Pg:host=localhost\;dbname=freeside
32 </pre>
33 <li>The rest of the configuration can be done with the web interface.  Select <u>Configuration</u> from the main menu and update your configuration values.
34 </ul>
35 </body>
36 </html>