X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=httemplate%2Fdocs%2Finstall.html;h=02572759eb99d6e3eabb7e4068dc2b6ec9e50a01;hp=1355a113c88ae316e9151526319f4737ca63bb9c;hb=a2b0b3e8500b08a5cf017c85693d9649853f8569;hpb=23e2dbc925c01f035984b3a7f3dccfa5ff7c4ccf diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html index 1355a113c..02572759e 100644 --- a/httemplate/docs/install.html +++ b/httemplate/docs/install.html @@ -6,57 +6,73 @@ Note: Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.

Before installing, you need: Install the Freeside distribution: @@ -86,16 +102,15 @@ mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* T
  • Set DB_PASSWORD to the freeside database user's password.
  • Add the freeside database to your database engine: -
    -$ su
    -# make create-database
    - (or manually, with Postgres:) -
    +    
       
  • Build and install the Perl modules:
     $ make perl-modules
    @@ -106,73 +121,61 @@ $ su
     # make create-config
     
  • Run a separate iteration of Apache[-SSL] with mod_perl enabled as the freeside user. +
  • Edit the Makefile and set TEMPLATE to asp or mason. Also set FREESIDE_DOCUMENT_ROOT. +
  • Run make install-docs. - + - - +
    Apache::ASPMasonMason (recommended)Apache::ASP (deprecated)
      -
    • Run make aspdocs -
    • Copy aspdocs/ to your web server's document space: -
      -cp aspdocs /usr/local/apache/htdocs/freeside-asp
      -
      -
    • Create a Global directory, such as /usr/local/etc/freeside/asp-global/: -
      -mkdir /usr/local/etc/freeside/asp-global/
      -chown freeside /usr/local/etc/freeside/asp-global/
      -
      -
    • Copy htetc/global.asa to the Global directory: -
      -cp htetc/global.asa /usr/local/etc/freeside/asp-global/global.asa
      -
      -
    • Configure Apache for the Global directory and to execute .cgi files using Apache::ASP. For example: + +
      +
    • Configure Apache:
      -PerlModule Apache::ASP
      -<Directory /usr/local/apache/htdocs/freeside-asp>
      +PerlModule HTML::Mason
      +# your freeside docuemnt root
      +<Directory /var/www/freeside>
       <Files ~ (\.cgi|\.html)>
      -SetHandler perl-script
      -PerlHandler Apache::ASP
      +AddHandler perl-script .cgi .html
      +PerlHandler HTML::Mason
       </Files>
       <Perl>
      -$MLDBM::RemoveTaint = 1;
      +require "/usr/local/etc/freeside/handler.pl";
       </Perl>
      -PerlSetVar Global /usr/local/etc/freeside/asp-global/
      -PerlSetVar Debug 2
       </Directory>
       
      -
    • Run make masondocs -
    • Copy masondocs/ to your web server's document space. (For example: /usr/local/apache/htdocs/freeside-mason) -
    • Copy htetc/handler.pl to /usr/local/etc/freeside -
    • Edit handler.pl and: -
        -
      • set an appropriate comp_root, such as /usr/local/apache/htdocs/freeside-mason -
      • set an appropriate data_dir, such as /usr/local/etc/freeside/masondata -
      -
    • Configure Apache to use the handler.pl file and to execute .cgi files using HTML::Mason. For example: +
      +
    • Configure Apache:
      -PerlModule HTML::Mason
      -<Directory /usr/local/apache/htdocs/freeside-mason>
      -<Files ~ (\.cgi|.html)>
      -SetHandler perl-script
      -PerlHandler HTML::Mason
      +PerlModule Apache::ASP
      +# your freeside document root
      +<Directory /var/www/freeside>
      +<Files ~ (\.cgi|\.html)>
      +AddHandler perl-script .cgi .html
      +PerlHandler Apache::ASP
       </Files>
       <Perl>
      -require "/usr/local/etc/freeside/handler.pl";
      +$MLDBM::RemoveTaint = 1;
       </Perl>
      +PerlSetVar Global /usr/local/etc/freeside/asp-global/
      +PerlSetVar Debug 2
      +PerlSetVar RequestBinaryRead Off
      +# your freeside document root
      +PerlSetVar IncludesDir /var/www/freeside
       </Directory>
       
      -
    • Restrict access to this web interface - see the Apache documentation on user authentication. For example, to configure user authentication with mod_auth (flat files): +
    • Restrict access to this web interface - see the Apache documentation on user authentication. For example, to configure user authentication with mod_auth (flat files), add something like the following to your Apache httpd.conf file, adjusting for your actual paths:
      -<Directory /usr/local/apache/htdocs/freeside-asp>
      +#your freeside document root
      +<Directory /var/www/freeside>
       AuthName Freeside
       AuthType Basic
       AuthUserFile /usr/local/etc/freeside/htpasswd
      @@ -183,23 +186,20 @@ require valid-user
           
    • Additional users:
      $ su
      -$ freeside-adduser -h /usr/local/etc/freeside/htpasswd username
      +# freeside-adduser -h /usr/local/etc/freeside/htpasswd username
  • - (using other auth types, add each user to your Apache authentication and then run: freeside-adduser username -
  • As the freeside UNIX user, run freeside-setup username to create the database tables, passing the username of a Freeside user you created above: -
    -$ su freeside
    -$ freeside-setup username
    -
    - Alternately, use the -s option to enable shipping addresses: freeside-setup -s username -
  • As the freeside UNIX user, run bin/populate-msgcat username (in the untar'ed freeside directory) to populate the message catalog, passing the username of a Freeside user you created above: + (using other auth types, add each user to your Apache authentication and then run: freeside-adduser username) +
  • Create the Freeside system users: +
    $ su
    +# freeside-adduser fs_queue
    +# freeside-adduser fs_selfservice
    +
  • As the freeside UNIX user, run freeside-setup -d domain.name username to create the database tables and initial data, passing the username of a Freeside user you created above:
     $ su freeside
    -$ cd /path/to/freeside/
    -$ bin/populate-msgcat username
    +$ freeside-setup -d example.com username
     
  • freeside-queued 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 systemand QUEUED_USER with the username of a Freeside user you created above, and run make install-init)
  • Now proceed to the initial administration of your installation.