| 15 | | === Some Useful Tips |
| 16 | | - The user under which the web server runs will require file system write permission to |
| 17 | | the environment directory and all the files inside. Please remember to set |
| 18 | | the appropriate permissions. The same applies to the source code repository, |
| 19 | | |
| | 19 | === Useful Tips |
| | 20 | |
| | 21 | - Place your environment's directory on a filesystem which supports sub-second timestamps, as Trac monitors the timestamp of its configuration files and changes happening on a filesystem with too coarse-grained timestamp resolution may go undetected in Trac < 1.0.2. This is also true for the location of authentication files when using TracStandalone. |
| | 22 | |
| | 23 | - 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. |
| 31 | | Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and |
| 32 | | [http://www.postgresql.org/ PostgreSQL] database backends. Preliminary |
| 33 | | support for [http://mysql.com/ MySQL] was added in 0.10. The default is |
| 34 | | to use SQLite, which is probably sufficient for most projects. The database |
| 35 | | file is then stored in the environment directory, and can easily be |
| 36 | | [wiki:TracBackup backed up] together with the rest of the environment. |
| | 34 | This is a common beginners' mistake. |
| | 35 | It happens that the structure for a Trac environment is loosely modeled after the Subversion repository directory structure, but those are two disjoint entities and they are not and //must not// be located at the same place. |
| | 36 | }}} |
| 38 | | === SQLite Connection String === |
| | 38 | == Database Connection Strings |
| | 39 | |
| | 40 | You 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. |
| | 41 | |
| | 42 | Note 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', '')" |
| | 45 | password%40%3A%2F123 |
| | 46 | }}} |
| | 47 | |
| | 48 | === SQLite Connection String |
| | 49 | |
| 45 | | === PostgreSQL Connection String === |
| 46 | | If you want to use PostgreSQL or MySQL instead, you'll have to use a |
| 47 | | different connection string. For example, to connect to a PostgreSQL |
| 48 | | database on the same machine called `trac`, that allows access to the |
| 49 | | user `johndoe` with the password `letmein`, use: |
| | 56 | See [trac:DatabaseBackend#SQLite] for more information. |
| | 57 | |
| | 58 | === PostgreSQL Connection String |
| | 59 | |
| | 60 | The 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: |
| 70 | | Note that with PostgreSQL you will have to create the database before running |
| 71 | | `trac-admin initenv`. |
| 72 | | |
| 73 | | See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL]. |
| 74 | | Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`. |
| 75 | | {{{ |
| 76 | | createuser -U postgres -E -P tracuser |
| 77 | | createdb -U postgres -O tracuser -E UTF8 trac |
| 78 | | }}} |
| 79 | | 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 trac's use of unicode in trac. SQL_ASCII also seems to work. |
| 80 | | |
| 81 | | Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user. For example: |
| 82 | | {{{ |
| 83 | | sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser' |
| 84 | | sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac' |
| | 80 | See the [https://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [https://www.postgresql.org/ PostgreSQL]. |
| | 81 | Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`: |
| | 82 | {{{#!sh |
| | 83 | $ createuser -U postgres -E -P tracuser |
| | 84 | $ createdb -U postgres -O tracuser -E UTF8 trac |
| 87 | | Trac uses the `public` schema by default but you can specify a different schema in the connection string: |
| | 87 | When 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. |
| | 88 | |
| | 89 | Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user: |
| | 90 | {{{#!sh |
| | 91 | $ sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser' |
| | 92 | $ sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac' |
| | 93 | }}} |
| | 94 | |
| | 95 | Trac uses the `public` schema by default, but you can specify a different schema in the connection string: |
| 94 | | If you want to use MySQL instead, you'll have to use a |
| 95 | | different connection string. For example, to connect to a MySQL |
| 96 | | database on the same machine called `trac`, that allows access to the |
| 97 | | user `johndoe` with the password `letmein`, the mysql connection string is: |
| | 102 | The 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`: |
| 142 | | * `trac.db` - The SQLite database (if you're using SQLite). |
| 143 | | * `htdocs` - directory containing web resources, which can be referenced in Genshi templates using `/htdocs/site/...` URLs. ''(since 0.11)'' |
| 144 | | * `log` - default directory for log files, if logging is turned on and a relative path is given. |
| 145 | | * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs or single file plugins, since [trac:milestone:0.10 0.10]) |
| 146 | | * `templates` - Custom Genshi environment-specific templates. ''(since 0.11)'' |
| 147 | | * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance |
| 148 | | |
| 149 | | === Caveat: don't confuse a ''Trac environment directory'' with the ''source code repository directory'' #Caveat |
| 150 | | |
| 151 | | This is a common beginners' mistake. |
| 152 | | It happens that the structure for a Trac environment is loosely modelled after the Subversion repository directory |
| 153 | | structure, but those are two disjoint entities and they are not and ''must not'' be located at the same place. |
| | 124 | * `trac.db` - The SQLite database, if you are using SQLite. |
| | 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. |
| | 127 | * `plugins` - Environment-specific [wiki:TracPlugins plugins]. |
| | 128 | * `templates` - Custom Genshi environment-specific templates. |
| | 129 | * `site.html` - Method to [TracInterfaceCustomization#SiteAppearance customize] the site header, footer, and style. |
