Changeset 3322


Ignore:
Timestamp:
May 10, 2007, 10:58:01 PM (16 years ago)
Author:
Jari Häkkinen
Message:

Addresses #516.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/src/docbook/admindoc/installation_upgrade.xml

    r3311 r3322  
    260260
    261261    <variablelist>
     262
     263      <varlistentry>
     264        <term>Java</term>
     265        <listitem>
     266          <para>
     267            Download and install Java SDK 1.5, available from
     268            <ulink url="http://java.sun.com/" />. Make sure that you
     269            download the JDK version (<emphasis>not</emphasis> the JRE
     270            version). <command>Java 6 is currently not
     271            supported</command>.
     272          </para>
     273        </listitem>
     274      </varlistentry>
     275
     276      <varlistentry>
     277        <term>Tomcat</term>
     278        <listitem>
     279          <para>
     280            Download and install tomcat 5.5.16 or later, available
     281            from <ulink
     282            url="http://jakarta.apache.org/tomcat/" />
     283            <important>
     284              You MUST make sure that Tomcat uses the SERVER mode of
     285              the Java run time engine
     286              (see <ulink
     287              url="http://lev.thep.lu.se/trac/base/ticket/99">ticket:99</ulink>).
     288            </important>
     289            On Linux you do this by setting the environment variable:
     290            <code>CATALINA_OPTS</code> to <code>-server</code>. It is
     291            also a good idea to specify the maximum allowed memory to
     292            use: <code>-server -Xmx500m</code> sets it to 500
     293            megabytes. Basically add the next line close to the top of
     294            the <filename>catalina.sh</filename> script that comes
     295            with tomcat
     296            (directory <filename
     297            class="direcotry">bin</filename>): <programlisting>
     298CATALINA_OPTS="-server -Xmx500m"
     299</programlisting>
     300          </para>
     301          <para>
     302            For more information about Tomcat options see
     303            <ulink url="http://www.chemaxon.com/jchem/doc/admin/tomcat.html" />.
     304          </para>
     305        </listitem>
     306      </varlistentry>
     307
    262308      <varlistentry>
    263309        <term>Set up SQL database</term>
    … …  
    281327                  Download and install MySQL (tested with version
    282328                  5.0), available from
    283                   <ulink
    284                   url="http://www.mysql.com/">http://www.mysql.com/</ulink>. You
    285                   need to be able to connect to the server over TCP,
    286                   so the <emphasis>skip-networking</emphasis> option
     329                  <ulink url="http://www.mysql.com/" />. You need to
     330                  be able to connect to the server over TCP, so
     331                  the <emphasis>skip-networking</emphasis> option
    287332                  must <command>not</command> be used. The InnoDB
    288333                  table engine is also needed, so don't disable them
    … …  
    301346                  PostgreSQL 8.0 seems to be working very well with
    302347                  BASE and Hibernate. Download and install PostgreSQL,
    303                   avaialble
    304                   from <ulink
    305                   url="http://www.postgresql.org/">http://www.postgresql.org/</ulink>. you
    306                   must edit
     348                  avaialble from
     349                  <ulink url="http://www.postgresql.org/" />. you must
     350                  edit
    307351                  your <filename>/path/to/base/www/WEB-INF/classes/base.config</filename>
    308352                  file. Uncomment the settings for Postgres and
    … …  
    313357          </variablelist>
    314358
    315         </listitem>
    316       </varlistentry>
    317 
    318       <varlistentry>
    319         <term>Java</term>
    320         <listitem>
    321           <para>
    322             Download and install Java SDK 1.5, available
    323             from <ulink
    324             url="http://java.sun.com/">http://java.sun.com/</ulink>. Make
    325             sure that you download the JDK version
    326             (<emphasis>not</emphasis> the JRE version). <command>Java
    327             6 is currently not supported</command>.
    328           </para>
    329359        </listitem>
    330360      </varlistentry>
    … …  
    380410          <para>
    381411            Instructions for MySQL and PostgreSQL are available
    382             below. The database names, the <emphasis>user</emphasis>,
    383             and the <emphasis>password</emphasis> can be changed
    384             during the creation of the databases. It is recommended to
    385             change the <emphasis>password</emphasis>, the other
    386             changes can be made if required. The database names,
    387             the <emphasis>user</emphasis>, and
    388             the <emphasis>password</emphasis> are needed in a later
     412            below. The database names (base2 and base2dynamic is used
     413            here), the <emphasis>db_user</emphasis>, and
     414            the <emphasis>db_password</emphasis> can be changed during
     415            the creation of the databases. It is recommended to change
     416            the <emphasis>db_password</emphasis>, the other changes
     417            can be made if desired. The database names,
     418            the <emphasis>db_user</emphasis>, and
     419            the <emphasis>db_password</emphasis> are needed in a later
    389420            step below when configuring BASE.
    390421          </para>
     422          <note>
     423            Note that the <emphasis>db_user</emphasis> name
     424            and <emphasis>db_password</emphasis> set here is used
     425            internally by BASE in communication with the database and
     426            is never used to log on to the BASE application.
     427          </note>
    391428          <variablelist>
    392429            <varlistentry>
    … …  
    395432                <para>
    396433                  Create a new database for BASE, and add a
    397                   <emphasis>user</emphasis> with at least
     434                  <emphasis>db_user</emphasis> with at least
    398435                  <emphasis>SELECT</emphasis>, <emphasis>INSERT</emphasis>,
    399436                  <emphasis>UPDATE</emphasis>, <emphasis>DELETE</emphasis>,
    … …  
    406443CREATE DATABASE base2;
    407444CREATE DATABASE base2dynamic;
    408 GRANT ALL ON base2.* TO base2user@localhost IDENTIFIED BY 'password';
    409 GRANT ALL ON base2dynamic.* TO base2user@localhost;
     445GRANT ALL ON base2.* TO db_user@localhost IDENTIFIED BY 'db_password';
     446GRANT ALL ON base2dynamic.* TO db_user@localhost;
    410447</programlisting>
    411448                </para>
    … …  
    415452                  by the <filename>mysql</filename> command-line tool
    416453                  (remember to edit
    417                   the <emphasis>user</emphasis>, <emphasis>password</emphasis>,
     454                  the <emphasis>db_user</emphasis>,
     455                  <emphasis>db_password</emphasis>,
    418456                  and the database names in the script file before
    419457                  executing the command): <command>mysql -uroot -p
    … …  
    429467                <para>
    430468                  Create a new database for BASE, and add a
    431                   <emphasis>user</emphasis> with the proper
     469                  <emphasis>db_user</emphasis> with the proper
    432470                  privileges. To do this, log in as your PostgreSQL
    433471                  user and issue these lines (omit comments):
    434472                  <programlisting>
    435 createuser base2user -P
     473createuser db_user -P
    436474  # this will prompt for an password for the new user, and issue two
    437475  # more question that should be answered with character 'n' for no.
    438 createdb --owner base2user --encoding UNICODE base2
     476createdb --owner db_user --encoding UNICODE base2
    439477psql base2
    440478  # this will start the psql command line tool. Issue the next line
    441479  # within the tool and quit with a '\q'.
    442 CREATE SCHEMA "dynamic" AUTHORIZATION "base2user";
     480CREATE SCHEMA "dynamic" AUTHORIZATION "db_user";
    443481</programlisting>
    444482                  The <filename>/path/to/base/misc/sql/createdb.postgresql.sql</filename>
    … …  
    483521                <emphasis>db.username</emphasis>,
    484522                and <emphasis>db.password</emphasis> settings to match
    485                 your choice above.
     523                your choice above. (<emphasis>database host and
     524                database name (e.g. base2)</emphasis>,
     525                <emphasis>e.g. base2dynamic</emphasis>,
     526                <emphasis>db_user</emphasis>, and
     527                and <emphasis>db_password</emphasis>, respectively.)
    486528              </listitem>
    487529              <listitem>
    488530                Modify the <emphasis>userfiles</emphasis> setting to
    489                 match your choice in step v) above.
     531                match your choice above.
    490532              </listitem>
    491533            </itemizedlist>
    … …  
    504546
    505547      <varlistentry>
     548        <term>BASE (database initialization)</term>
     549        <listitem>
     550          <para>
     551            Change directory to
     552            <filename class="directory">/path/to/base/bin</filename>
     553            and run <filename>initdb.sh</filename> as <programlisting>
     554./initdb.sh base_root_passwordh password
     555</programlisting>
     556            <important>
     557            The <emphasis>base_root_password</emphasis> you use here
     558            is given to the BASE web application
     559            user <emphasis>root</emphasis>. There is no supported way
     560            to change the <emphasis>root</emphasis> account name.
     561            </important>
     562            If the initialisation script fail, it is most probably a
     563            problem related to the underlying database. Make sure that
     564            the database accepts network connection and make sure that
     565            <emphasis>db_user</emphasis> has proper credentials.
     566          </para>
     567        </listitem>
     568      </varlistentry>
     569
     570      <varlistentry>
    506571        <term></term>
    507572        <listitem>
Note: See TracChangeset for help on using the changeset viewer.