Changes between Version 6 and Version 7 of Trac Environment


Ignore:
Timestamp:
Oct 25, 2020, 10:52:22 PM (3 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Trac Environment

    v6 v7  
    22
    33[[TracGuideToc]]
    4 [[PageOutline(2-5)]]
     4[[PageOutline(2-5,Contents,pullout)]]
    55
    6 Trac uses a directory structure and a database for storing project data. The directory is referred to as the environment.
     6Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.
     7
     8Trac supports [https://www.sqlite.org/ SQLite], [https://www.postgresql.org/ PostgreSQL] and [https://www.mysql.com/ MySQL] databases. With PostgreSQL and MySQL you have to create the database before running `trac-admin initenv`.
    79
    810== Creating an Environment
    911
    10 A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:
     12A new Trac environment is created using the [TracAdmin#initenv initenv] command:
    1113{{{#!sh
    1214$ trac-admin /path/to/myproject initenv
    1315}}}
    1416
    15 `trac-admin` will ask you for the name of the project and the database connection string, see below.
     17`trac-admin` will ask you for the name of the project and the [#DatabaseConnectionStrings database connection string].
    1618
    1719=== Useful Tips
     
    2123 - The user under which the web server runs will require file system write permission to the environment directory and all the files inside. Please remember to set the appropriate permissions. The same applies to the source code repository, although the user under which Trac runs will only require write access to a Subversion repository created with the BDB file system; for other repository types, check the corresponding plugin's documentation.
    2224 
    23  - `initenv`, when using an svn repository, does not imply that trac-admin will perform `svnadmin create` for the specified repository path. You need to perform the `svnadmin create` prior to `trac-admin initenv` if you're creating a new svn repository altogether with a new Trac environment; otherwise you will see a message "Warning: couldn't index the repository" when initializing the environment.
     25 - `initenv` does not create a version control repository for the specified path. If you wish to specify a default repository using the optional arguments to `initenv` you must create the repository first, otherwise you will see a message when initializing the environment: //Warning: couldn't index the default repository//.
    2426
    2527 - Non-ascii environment paths are not supported.
    26  
    27  - Also, it seems that project names with spaces can be problematic for authentication, see [trac:#7163].
    2828
    29  - TracPlugins located in a [TracIni#inherit-section shared plugins folder] that is defined in an [TracIni#GlobalConfiguration inherited configuration] are currently not loaded during creation, and hence, if they need to create extra tables for example, you'll need to [TracUpgrade#UpgradetheTracEnvironment upgrade the environment] before being able to use it.
     29 - TracPlugins located in a [TracIni#inherit-plugins_dir-option shared plugins directory] that is defined in an [TracIni#GlobalConfiguration inherited configuration] are not enabled by default, in contrast to plugins in the environment `plugins` directory. Hence, if they need to create extra tables, for example, the tables will not be created during environment creation and you'll need to [TracUpgrade#UpgradetheTracEnvironment upgrade the environment]. Alternatively you can avoid the need to upgrade the environment by explicitly enabling the plugin in the inherited configuration, or in a configuration file using the `--config` option. See TracAdmin#FullCommandReference for more information.
    3030
    31 {{{#!div style="border: 1pt dotted; margin: 1em"
     31{{{#!div style="border: 1pt dotted; margin: 1em;"
    3232**Caveat:** don't confuse the //Trac environment directory// with the //source code repository directory//.
    3333
     
    3838== Database Connection Strings
    3939
    40 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.
     40You will need to specify a database connection string at the time the environment is created. The default is SQLite, which is 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.
    4141
    42 Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.
     42Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be [https://meyerweb.com/eric/tools/dencoder/ URL encoded].
     43{{{#!sh
     44$ python -c "import urllib; print urllib.quote('password@:/123', '')"
     45password%40%3A%2F123
     46}}}
    4347
    4448=== SQLite Connection String
     
    5054where `db/trac.db` is the path to the database file within the Trac environment.
    5155
     56See [trac:DatabaseBackend#SQLite] for more information.
     57
    5258=== PostgreSQL Connection String
    5359
    54 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:
     60The 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:
    5561{{{
    5662postgres://johndoe:letmein@localhost/trac
     
    7278}}}
    7379
    74 Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.
    75 
    76 See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
     80See the [https://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [https://www.postgresql.org/ PostgreSQL].
    7781Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:
    7882{{{#!sh
     
    8185}}}
    8286
    83 When running `createuser` you will be prompted for the password for the user 'tracuser'. This new user will not be a superuser, will not be allowed to create other databases and will not be allowed to create other roles. These privileges are not needed to run a Trac instance. If no password is desired for the user, simply remove the `-P` and `-E` options from the `createuser` command. Also note that the database should be created as UTF8. LATIN1 encoding causes errors, because of Trac's use of unicode. SQL_ASCII also seems to work.
     87When running `createuser` you will be prompted for the password for the `tracuser`. This new user will not be a superuser, will not be allowed to create other databases and will not be allowed to create other roles. These privileges are not needed to run a Trac instance. If no password is desired for the user, simply remove the `-P` and `-E` options from the `createuser` command. Also note that the database should be created as UTF8. LATIN1 encoding causes errors, because of Trac's use of unicode.
    8488
    85 Under some default configurations (Debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user:
     89Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:
    8690{{{#!sh
    8791$ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
     
    96100=== MySQL Connection String
    97101
    98 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`:
     102The format of the MySQL connection string is similar to 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`:
    99103{{{
    100104mysql://johndoe:letmein@localhost:3306/trac
     
    103107== Source Code Repository
    104108
    105 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.
     109A 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.
    106110
    107 There 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.
     111There are several 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.
    108112
    109113== Directory Structure
    110114
    111 An environment directory will usually consist of the following files and directories:
     115An environment consists of the following files and directories:
    112116
    113117 * `README` - Brief description of the environment.
     
    116120  * `attachments` - Attachments to wiki pages and tickets.
    117121 * `conf`
    118   * `trac.ini` - Main configuration file. See TracIni.
     122  * `trac.ini` - Main [TracIni configuration file].
    119123 * `db`
    120124  * `trac.db` - The SQLite database, if you are using SQLite.
    121  * `htdocs` - Directory containing web resources, which can be referenced in Genshi templates using `/chrome/site/...` URLs.
    122  * `log` - Default directory for log files, if `file` logging is enabled and a relative path is given.
     125 * `htdocs` - Directory containing web resources, which can be referenced in templates using the path `/chrome/site/...`.
     126 * `log` - Default directory for log files when `file` logging is enabled and a relative path is given.
    123127 * `plugins` - Environment-specific [wiki:TracPlugins plugins].
    124128 * `templates` - Custom Genshi environment-specific templates.
    125   * `site.html` - Method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance.
     129  * `site.html` - Method to [TracInterfaceCustomization#SiteAppearance customize] the site header, footer, and style.
    126130
    127131----
    128 See also: TracAdmin, TracBackup, TracIni, TracGuide
     132See also: TracAdmin, TracBackup, TracIni