Changeset 2936


Ignore:
Timestamp:
Nov 17, 2006, 4:07:13 PM (16 years ago)
Author:
Nicklas Nordborg
Message:

References #333: Administrator documentation

Added information about base.config

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/doc/admin/base.config.html

    r2932 r2936  
    5151  <b>Contents</b><br>
    5252  <ol>
    53   <li>More...
     53  <li><a href="#database">Database driver section</a></li>
     54  <li><a href="#authentication">Authentication section</a></li>
     55  <li><a href="#jobqueue">Internal job queue section</a></li>
     56  <li><a href="#jobagent">Job agent section</a></li>
    5457  <li><a href="#secondary">Secondary storage controller</a></li>
     58  <li><a href="#general">General section</a></li>
    5559  </ol>
    5660
    … …  
    6367</div>
    6468
     69  <a name="database"></a>
     70  <h2>1. Database driver section</h2>
     71
     72  <dl>
     73  <dt class="method">db.dialect</dt>
     74  <dd>
     75    The Hibernate dialect to use when generating SQL commands to
     76    the database. Use:
     77    <ul>
     78    <li><code>org.hibernate.dialect.MySQLInnoDBDialect</code> for MySQL</li>
     79    <li><code>org.hibernate.dialect.PostgreSQLDialect</code> for Postgres</li>
     80    </ul>
     81    Other dialects may wirk but are not supported.
     82  </dd>
     83 
     84  <dt class="method">db.driver</dt>
     85  <dd>
     86    The JDBC driver to use for connecting to the database. Use:
     87    <ul>
     88    <li><code>com.mysql.jdbc.Driver</code>  for MySQL</li>
     89    <li><code>org.postgresql.Driver</code>  for Postgres</li>
     90    </ul>
     91    Other JDBC drivers may work but are not supported.
     92  </dd>
     93 
     94  <dt class="method">db.url</dt>
     95  <dd>
     96    The connection URL that locates the BASE 2 database. The exact syntax of the
     97    string depends on the JDBC driver. Here are two examples which leaves all
     98    other settings to their defaults:
     99    <ul>
     100    <li><code>jdbc:mysql://localhost/base2</code> for MySQL</li>
     101    <li><code>jdbc:postgresql:base2</code> for MySQL</li>
     102    </ul>
     103   
     104    You can get more information about the parameters that are supported
     105    on the connection URL by reading the database documentation:
     106    <ul>
     107    <li><a href="http://dev.mysql.com/doc/refman/5.0/en/connector-j-reference-configuration-properties.html"
     108      >MySQL</a></li>
     109    <li><a href="http://jdbc.postgresql.org/documentation/81/connect.html"
     110      >Postgres</a></li>
     111    </ul>
     112  </dd>
     113
     114  <dt class="method">db.dynamic.catalog</dt>
     115  <dd>
     116    The name of the catalog where the dynamic database is located. If not specified
     117    the same catalog as the regular database is used. The exact meaning of catalog
     118    depends on the actual database. For MySQL the catalog is the name of the database
     119    so this value is simply the name of the dynamic database. Postgres doesn't support
     120    connecting to multiple databases with the same connection so this should have
     121    the same value as the database in the <code>db.url</code> setting.
     122  </dd>
     123 
     124  <dt class="method">db.dynamic.schema</dt>
     125  <dd>
     126    The name of the schema where the dynamic database is located. MySQL doesn't have
     127    schemas so this value should not be specified. Postgres supports schemas and we
     128    recommend that the dynamic part is created in it's own schema.
     129  </dd>
     130 
     131  <dt class="method">db.username</dt>
     132  <dd>
     133    The username to connect to the database. The user should have full
     134    permission to the both the regular and the dynamic database.
     135  </dd>
     136 
     137  <dt class="method">db.password</dt>
     138  <dd>
     139    The password for the user.
     140  </dd>
     141 
     142  <dt class="method">db.batch-size</dt>
     143  <dd>
     144    The batch size to use when inserting/updating items with the Batch API.
     145    A higher value requires more memory, a lower value degrades performance since
     146    the number of database connections increases.
     147  </dd>
     148 
     149  <dt class="method">db.queries</dt>
     150  <dd>
     151    The class path to an XML file which contains database-specific queries
     152    overriding those that doesn't work from the <code>/common-queries.xml</code>.
     153    Use:
     154    <ul>
     155    <li><code>/mysql-queries.xml</code> for MySQL</li>
     156    <li><code>/postgres-queries.xml</code> for Postgres</li>
     157    </ul>
     158  </dd>
     159 
     160  <dt class="method">db.extended-properties</dt>
     161  <dd>
     162    An XML file describing the extended properties for extendable item
     163    types, ie. the reporters. The default value is <code>/extended-properties.xml</code>.
     164  </dd>
     165 
     166  <dt class="method">db.raw-data-types</dt>
     167  <dd>
     168    An XML file describing all raw data types and their properties.
     169    The default value is <code>/raw-data-types.xml</code>.
     170  </dd>
     171 
     172  <dt class="method">export.max.items</dt>
     173  <dd>
     174    The maximum number of items the export function should try to load
     175    in a single query. This setting exists because MySQL doesn't support scrollable
     176    result sets, but loads all data into memory. This will result in out of memory
     177    exception if exporting too many items at the same time. Postgres doesn't have
     178    this problem, since it doesn't load the data until it is requested. Use
     179    <ul>
     180    <li>0 for Postgres to disable this workaround</li>
     181    <li>As large as possible value for MySQL. A low value results in more queries and
     182      slower performance when exporting data.</li>
     183    </ul>
     184 
     185  </dl>
    65186
    66187  <a name="secondary"></a>
    67   <h2>2. Secondary storage controller</h2>
     188  <h2>2. Authentication section</h2>
     189
     190  TODO
     191
     192  <a name="jobqueue"></a>
     193  <h2>3. Internal job queue section</h2>
     194
     195  TODO
     196 
     197  <a name="jobagent"></a>
     198  <h2>4. Job agent section</h2>
     199
     200  <p>
     201    This section holds settings that the core uses when communicating
     202    with external job agents.
     203  </p>
     204 
     205  <dl>
     206  <dt class="method">agent.maxage</dt>
     207  <dd>
     208    Number of seconds to keep job agent information in the internal cache.
     209    The information includs, CPU and memory usage and the status of executing
     210    jobs. This setting controls how long the information is kept in the cache
     211    before a new request is made to the job agent. The default value is 60
     212    seconds.
     213  </dd>
     214 
     215  <dt class="method">agent.connection.timeout</dt>
     216  <dd>
     217    The timeout in milliseconds to wait for a repsonse from a job agent when
     218    sending a request to it. The default timeout is 1000 milliseconds. This should
     219    be more than enough if the job agent is on the internal network, but may have
     220    to be increased if it is further away.
     221  </dd>
     222  </dl>
     223 
     224  <a name="secondary"></a>
     225  <h2>5. Secondary storage controller</h2>
    68226  <p>
    69227    Settings related to the secondary storage controller. For more
    … …  
    105263    hour and two-digit minute values. For example: 03:10,09:00,23:59.
    106264  </dd>
    107  
     265  </dl>
     266
     267  <a name="general"></a>
     268  <h2>6. General section</h2>
     269
     270  <dl>
     271  <dt class="method">userfiles</dt>
     272  <dd>
     273    The path to the directory where uploaded and generated files should
     274    be stored. This is the primary storage. See above for information about
     275    how to configure the secondary storage. Uploaded files are not stored in
     276    the same directory structure or with the same names as in the BASE filesystem.
     277    The internal structure may contain subdirectories.
     278  </dd>
     279 
     280  <dt class="method">permission.timeout</dt>
     281  <dd>
     282    Number of minutes to cache a logged in user's permission before
     283    reloading them. The default value is 10. This setting affect how quickly
     284    a changed permission propagate to a logged in user. Permissions are
     285    always reloaded when a user logs in.
     286  </dd>
     287 
     288  <dt class="method">cache.timeout</dt>
     289  <dd>
     290    Number of minutes to keep user sessions in the internal cache
     291    before the user is automatically logged out. The timeout is counted
     292    from the last access made from the user.
     293  </dd>
    108294  </dl>
    109295
Note: See TracChangeset for help on using the changeset viewer.