Edgewall Software

Changes between Version 12 and Version 13 of 1.1/TracEnvironment


Ignore:
Timestamp:
Mar 21, 2016, 9:11:43 AM (8 years ago)
Author:
Ryan J Ollos
Comment:

Reorder to improve clarity.

Legend:

Unmodified
Added
Removed
Modified
  • 1.1/TracEnvironment

    v12 v13  
    77Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
    88
     9Trac supports [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL] and [http://mysql.com/ MySQL] databases. With PostgreSQL and MySQL you have to create the database before running `trac-admin initenv`.
     10
    911== Creating an Environment
    1012
    11 A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:
     13A new Trac environment is created using the [TracAdmin#initenv initenv] command:
    1214{{{#!sh
    1315$ trac-admin /path/to/myproject initenv
    1416}}}
    1517
    16 `trac-admin` will ask you for the name of the project and the database connection string, see below.
     18`trac-admin` will ask you for the name of the project and the [#DatabaseConnectionStrings database connection string].
    1719
    1820=== Useful Tips
     
    3739== Database Connection Strings
    3840
    39 Trac supports [http://sqlite.org/ SQLite], [http://www.postgresql.org/ PostgreSQL] and [http://mysql.com/ MySQL] database backends. The default is SQLite, which is probably sufficient for most projects. The database file is then stored in the environment directory, and can easily be [wiki:TracBackup backed up] together with the rest of the environment.
     41You will need to specify a database connection string at the time the environment is created. The default is SQLite, which is probably sufficient for most projects. The SQLite database file is stored in the environment directory, and can easily be [wiki:TracBackup backed up] together with the rest of the environment.
    4042
    4143Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     
    5153=== PostgreSQL Connection String
    5254
    53 If you want to use PostgreSQL instead, you'll have to use a different connection string. For example, to connect to a PostgreSQL database on the same machine called `trac` for user `johndoe` with the password `letmein` use:
     55The connection string for PostgreSQL is a bit more complex. For example, to connect to a PostgreSQL database named `trac` on `localhost` for user `johndoe` and password `letmein`, use:
    5456{{{
    5557postgres://johndoe:letmein@localhost/trac
     
    7072postgres://user:password@/database?host=/path/to/socket/dir
    7173}}}
    72 
    73 Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    7474
    7575See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     
    9595=== MySQL Connection String
    9696
    97 The format of the MySQL connection string is similar to those for PostgreSQL, with the `postgres` scheme being replaced by `mysql`. For example, to connect to a MySQL database on the same machine called `trac` for user `johndoe` with password `letmein`:
     97The format of the MySQL connection string is similar to those for PostgreSQL, with the `postgres` scheme being replaced by `mysql`. For example, to connect to a MySQL database on `localhost` named `trac` for user `johndoe` with password `letmein`:
    9898{{{
    9999mysql://johndoe:letmein@localhost:3306/trac
     
    102102== Source Code Repository
    103103
    104 A single environment can be connected to more than one repository. However, by default Trac is not connected to any source code repository, and the ''Browse Source'' toolbar item will not be displayed.
     104A single environment can be connected to more than one repository. However, by default Trac is not connected to any source code repository, and the ''Browse Source'' navigation item will not be displayed.
    105105
    106106There are many different ways to connect repositories to an environment, see TracRepositoryAdmin. A single repository can be specified when the environment is created by passing the optional arguments `repository_type` and `repository_dir` to the `initenv` command.
     
    108108== Directory Structure
    109109
    110 An environment directory will usually consist of the following files and directories:
     110An environment consists of the following files and directories:
    111111
    112112 * `README` - Brief description of the environment.