fleabsd grr
[freeside.git] / httemplate / docs / install.html
1 <head>
2   <title>Installation</title>
3 </head>
4 <body>
5 <h1>Installation</h1>
6 Before installing, you need:
7 <ul>
8   <li><a href="http://www.perl.com/">Perl</a>  Don't enable experimental features like threads or the PerlIO abstraction layer.
9   <li><a href="http://www.apache.org">Apache</a> (<a href="http://www.modssl.org/">mod_ssl</a> or <a href="http://www.apache-ssl.org">Apache-SSL</a> highly recommended)
10   <li><a href="http://perl.apache.org/">mod_perl</a> (if compiling your own mod_perl, make sure you set the <a href="http://perl.apache.org/guide/install.html#EVERYTHING">EVERYTHING</a>=1 compile-time option)
11   <li><a href="http://www.openssh.com/">SSH</a> (<a href="http://www.openssh.com//">OpenSSH</a> is recommended.  SSH Communications Security <a href="http://www.ssh.com/products/ssh/download.cfm">commercial SSH version 3</a> has been reported incompatible with Freeside.)
12   <li><a href="http://rsync.samba.org/">rsync</a>
13   <li>A <b>transactional</b> database engine <a href="http://search.cpan.org/search?mode=module&query=DBD%3A%3A">supported</a> by Perl's <a href="http://dbi.perl.org">DBI</a>.
14     <ul>
15       <li><a href="http://www.postgresql.org/">PostgreSQL</a> (v7 or higher) is recommended.
16        <li>MySQL has been reported to work.
17          <b>MySQL's default <a href="http://www.mysql.com/doc/M/y/MyISAM.html">MyISAM</a> and <a href="http://www.mysql.com/doc/I/S/ISAM.html">ISAM</a> table types are not supported</b>.  If you want to use MySQL, you <b>must</b> use one of the new <a href="http://www.mysql.com/doc/T/a/Table_types.html">transaction-safe table types</a> such as <a href="http://www.mysql.com/doc/B/D/BDB.html">BDB</a> or <a href="http://www.mysql.com/doc/I/n/InnoDB.html">InnoDB</a>, and set it as the default table type when running fs-setup using the <code>--default-table-type=BDB</code> or <code>--default-table-type=InnoDB</code> <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Command-line_options">mysqld command-line option</a> or by setting <code>default-table-type=BDB</code> or <code>--default-table-type=InnoDB</code> in the <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#Option_files">my.cnf option file</a>.
18     </ul>
19   <li>Perl modules (<a href="http://theoryx5.uwinnipeg.ca/CPAN/perl/CPAN.html">CPAN</a> will query, download and build perl modules automatically)
20     <ul>
21       <li><a href="http://search.cpan.org/search?dist=Array-PrintCols">Array-PrintCols</a>
22       <li><a href="http://search.cpan.org/search?dist=Term-Query">Term-Query</a> (make test broken; install manually)
23       <li><a href="http://search.cpan.org/search?dist=MIME-Base64">MIME-Base64</a>
24       <li><a href="http://search.cpan.org/search?dist=Digest-MD5">Digest-MD5</a>
25       <li><a href="http://search.cpan.org/search?dist=MD5">MD5</a>
26       <li><a href="http://search.cpan.org/search?dist=URI">URI</a>
27       <li><a href="http://search.cpan.org/search?dist=HTML-Tagset">HTML-Tagset</a>
28       <li><a href="http://search.cpan.org/search?dist=HTML-Parser">HTML-Parser</a>
29       <li><a href="http://search.cpan.org/search?dist=libnet">libnet</a>
30       <li><a href="http://search.cpan.org/search?dist=Locale-Codes">Locale-Codes</a>
31       <li><a href="http://search.cpan.org/search?dist=Net-Whois">Net-Whois</a>
32       <li><a href="http://search.cpan.org/search?dist=libwww-perl">libwww-perl</a>
33       <li><a href="http://search.cpan.org/search?dist=Business-CreditCard">Business-CreditCard</a>
34       <li><a href="http://search.cpan.org/search?dist=Data-ShowTable">Data-ShowTable</a>
35       <li><a href="http://search.cpan.org/search?dist=MailTools">MailTools</a>
36       <li><a href="http://search.cpan.org/search?dist=TimeDate">TimeDate</a>
37       <li><a href="http://search.cpan.org/search?dist=DateManip">DateManip</a>
38       <li><a href="http://search.cpan.org/search?dist=File-CounterFile">File-CounterFile</a>
39       <li><a href="http://search.cpan.org/search?dist=FreezeThaw">FreezeThaw</a>
40       <li><a href="http://search.cpan.org/search?dist=String-Approx">String-Approx</a>
41       <li><a href="http://search.cpan.org/search?dist=Text-Template">Text-Template</a>
42       <li><a href="http://search.cpan.org/search?dist=DBI">DBI</a>
43       <li><a href="http://search.cpan.org/search?mode=module&query=DBD">DBD for your database engine</a> (<a href="http://search.cpan.org/search?dist=DBD-Pg">DBD::Pg</a> for PostgreSQL, <a href="http://search.cpan.org/search?dist=DBD-mysql">DBD::mysql</a> for MySQL)
44       <li><a href="http://search.cpan.org/search?dist=DBIx-DataSource">DBIx-DataSource</a>
45       <li><a href="http://search.cpan.org/search?dist=DBIx-DBSchema">DBIx-DBSchema</a>
46       <li><a href="http://search.cpan.org/search?dist=Net-SSH">Net-SSH</a>
47       <li><a href="http://search.cpan.org/search?dist=String-ShellQuote">String-ShellQuote</a>
48       <li><a href="http://search.cpan.org/search?dist=Net-SCP">Net-SCP</a>
49       <li><a href="http://www.apache-asp.org/">Apache::ASP</a> or <a href="http://www.masonhq.com/">HTML::Mason</a>
50       <li><a href="http://search.cpan.org/search?dist=Tie-IxHash">Tie-IxHash</a>
51       <li><a href="http://search.cpan.org/search?dist=Time-Duration">Time-Duration</a>
52       <li><a href="http://search.cpan.org/search?dist=HTML-Widgets-SelectLayers">HTML-Widgets-SelectLayers</a>
53       <li><a href="http://search.cpan.org/search?dist=Storable">Storable</a>
54       <li><a href="http://search.cpan.org/search?dist=ApacheDBI">Apache::DBI</a> <i>(optional but recommended for better webinterface performance)</i>
55     </ul>
56 </ul>
57 Install the Freeside distribution:
58 <ul>
59   <li>Add the user `freeside' to your system.
60   <li>Allow the freeside user full access to the freeside database.
61     <ul>
62       <li> with <a href="http://www.postgresql.org/users-lounge/docs/7.1/postgres/user-manag.html#DATABASE-USERS">PostgreSQL</a>:
63         <pre>
64 $ su postgres
65 $ createuser -P freeside
66 Enter password for user "freeside": 
67 Enter it again: 
68 Shall the new user be allowed to create databases? (y/n) y
69 Shall the new user be allowed to create more new users? (y/n) n
70 CREATE USER</pre>
71       <li> with <a href="http://www.mysql.com/documentation/mysql/bychapter/manual_MySQL_Database_Administration.html#User_Account_Management">MySQL</a>:
72         <pre>
73 $ mysqladmin -u root password '<i>set_a_root_database_password</i>'
74 $ mysql -u root -p
75 mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* TO freeside@localhost IDENTIFIED BY '<i>set_a_freeside_database_password</i>';</pre>
76     </ul>
77 <!--  <li>Unpack the tarball: <pre>gunzip -c fs-x.y.z.tar.gz | tar xvf -</pre>-->
78   <li>Edit the top-level Makefile:
79     <ul>
80       <li>Set <tt>DATASOURCE</tt> to your <a href="http://search.cpan.org/doc/TIMB/DBI-1.28/DBI.pm">DBI data source</a>, for example, <tt>DBI:Pg:host=localhost;dbname=freeside</tt> for PostgresSQL or <tt>DBI:mysql:freeside</tt> for MySQL.  See the <a href="http://search.cpan.org/doc/TIMB/DBI-1.28/DBI.pm">DBI manpage</a> and the <a href="http://search.cpan.org/search?mode=module&query=DBD%3A%3A">manpage for your DBD</a> for the exact syntax of your DBI data source.
81       <li>Set <tt>DB_PASSWORD</tt> to the freeside database user's password.
82     </ul>
83   <li>Add the freeside database to your database engine:
84     <pre>
85 $ su
86 # make create-database</pre>
87     (or manually, with Postgres:)
88     <pre>
89 $ su freeside
90 $ createdb freeside</pre>
91     (with MySQL:)
92     <pre>
93 $ mysqladmin -u freeside -p create freeside </pre>
94   <li>Build and install the Perl modules:
95     <pre>
96 $ make perl-modules
97 $ su
98 # make install-perl-modules</pre>
99     <li>Create the necessary configuration files:<pre>
100 $ su
101 # make create-config
102 </pre>
103     <li>Run a <b>separate</b> iteration of Apache[-SSL] with mod_perl enabled <b>as the freeside user</b>.
104 </ul>
105 <table>
106   <tr>
107     <th>Apache::ASP</th><th>Mason</th>
108   </tr>
109   <tr>
110     <td><ul>
111       <li>Run <tt>make aspdocs</tt>
112       <li>Copy <tt>aspdocs/</tt> to your web server's document space.
113       <li>Create a <a href="http://www.apache-asp.org/config.html#Global">Global</a> directory, such as <tt>/usr/local/etc/freeside/asp-global/</tt>:
114 <font size="-1"><pre>
115 mkdir&nbsp;/usr/local/etc/freeside/asp-global/
116 chown&nbsp;freeside&nbsp;/usr/local/etc/freeside/asp-global/
117 </pre></font>
118       <li>Copy <tt>htetc/global.asa</tt> to the Global directory:
119 <font size="-1"><pre>
120 cp&nbsp;htetc/global.asa&nbsp;/usr/local/etc/freeside/asp-global/global.asa
121 </pre></font>
122       <li>Configure Apache for the Global directory and to execute .cgi files using Apache::ASP.  For example:
123 <font size="-1"><pre>
124 &lt;Directory&nbsp;/usr/local/apache/htdocs/freeside-asp&gt;
125 &lt;Files ~ (\.cgi)&gt;
126 AddHandler perl-script .cgi
127 PerlHandler Apache::ASP
128 &lt;/Files&gt;
129 &lt;Perl&gt;
130 $MLDBM::RemoveTaint = 1;
131 &lt;/Perl&gt;
132 PerlSetVar&nbsp;Global&nbsp;/usr/local/etc/freeside/asp-global/
133 PerlSetVar Debug 2
134 &lt;/Directory&gt;
135 </pre></font>
136     </ul></td>
137     <td><ul>
138       <li>Run <tt>make masondocs</tt>
139       <li>Copy <tt>masondocs/</tt> to your web server's document space.
140       <li>Copy <tt>htetc/handler.pl</tt> to your web server's configuration directory.
141       <li>Edit <tt>handler.pl</tt> and set an appropriate <tt>data_dir</tt>, such as <tt>/usr/local/etc/freeside/mason-data</tt>
142       <li>Configure Apache to use the <tt>handler.pl</tt> file and to execute .cgi files using HTML::Mason.  For example:
143 <font size="-1"><pre>
144 &lt;Directory&nbsp;/usr/local/apache/htdocs/freeside-mason&gt;
145 &lt;Files ~ (\.cgi)&gt;
146 AddHandler perl-script .cgi
147 PerlHandler HTML::Mason
148 &lt;/Files&gt;
149 &lt;Perl&gt;
150 require&nbsp;"/usr/local/apache/conf/handler.pl";
151 &lt;/Perl&gt;
152 &lt;/Directory&gt;
153 </pre></font>
154     </ul></td>
155   </tr>
156 </table>
157 <ul>
158 <li>Restrict access to this web interface - see the <a href="http://httpd.apache.org/docs/misc/FAQ.html#user-authentication">Apache documentation on user authentication</a>.    For example, to configure user authentication with <a href="http://httpd.apache.org/docs/mod/mod_auth.html">mod_auth</a> (flat files):
159 <pre>
160 &lt;Directory /usr/local/apache/htdocs/freeside-asp&gt;
161 PerlSetVar Global /usr/local/etc/freeside/asp-global/
162 AuthName Freeside
163 AuthType Basic
164 AuthUserFile /usr/local/etc/freeside/htpasswd
165 require valid-user
166 &lt;/Directory&gt;
167 </pre>
168   <li>Create one or more Freeside users (your internal sales/tech folks, not customer accounts).  These users are setup using using Apache authentication, not UNIX user accounts.  For example, using <a href="http://httpd.apache.org/docs/mod/mod_auth.html">mod_auth</a> (flat files):
169     <ul>
170       <li>First user:<font size="-1">
171 <pre>$ su
172 $ <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -c -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
173       <li>Additional users:<font size="-1">
174 <pre>$ su
175 $ <a href="man/bin/freeside-adduser.html">freeside-adduser</a> -h /usr/local/etc/freeside/htpasswd <i>username</i></pre></font>
176     </ul>
177   <i>(using other auth types, add each user to your <a href="http://httpd.apache.org/docs/misc/FAQ.html#user-authentication">Apache authentication</a> and then run: <tt>freeside-adduser <b>username</b></tt></i>
178   <li>As the freeside UNIX user, run <tt>bin/fs-setup <b>username</b></tt> (in the untar'ed freeside directory) to create the database tables, passing the username of a Freeside user you created above:
179 <pre>
180 $ su freeside
181 $ cd <b>/path/to/freeside-1.4.0/</b>
182 $ bin/fs-setup <b>username</b>
183 </pre>
184   <li>As the freeside UNIX user, run <tt>bin/populate-msgcat <b>username</b></tt> (in the untar'ed freeside directory) to populate the message catalog, passing the username of a Freeside user you created above:
185 <pre>
186 $ su freeside
187 $ cd <b>/path/to/freeside-1.4.0/</b>
188 $ bin/populate-msgcat <b>username</b>
189 </pre>
190   <li><tt>freeside-queued</tt> was installed with the Perl modules.  Start it now and ensure that is run upon system startup (Do this manually, or edit the top-level Makefile, replacing INIT_FILE with the appropriate location on your system, and run <tt>make install-init</tt>)
191   <li>Now proceed to the initial <a href="admin.html">administration</a> of your installation.
192 </ul>
193 </body>