| 16 | | ''Note: The web server user 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 Subversion repository |
| 19 | | Trac is eventually using, although Trac will only require read access as long |
| 20 | | as you're not using the BDB file system.'' |
| | 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 | 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. |
| | 20 | |
| | 21 | - `initenv` when using 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. |
| | 22 | |
| | 23 | - Non-ascii environment paths are not supported |
| | 24 | |
| | 25 | - Also, it seems that project names with spaces can be problematic for authentication (see [trac:#7163]). |
| | 26 | |
| | 27 | - 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. |
| 24 | | Since version 0.9, Trac supports both [http://sqlite.org/ SQLite], |
| 25 | | [http://www.postgresql.org/ PostgreSQL] and [http://mysql.com/ MySQL] as |
| 26 | | database backends. The default is to use SQLite, which is probably sufficient |
| 27 | | for most projects. The database file is then stored in the environment |
| 28 | | directory, and can easily be [wiki:TracBackup backed up] together with the |
| 29 | | |
| | 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. |
| 55 | | sudo su - postgres -c createdb trac |
| 56 | | sudo su - postgres -c psql trac |
| 57 | | CREATE USER trac-user-name WITH PASSWORD 'trac-pass-name'; |
| | 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' |
| 60 | | (Just to remind you, if you don't have a sudo/su setup, you just need to do the createdb and psql statements. That threw me the first couple of times I read this.) |
| | 87 | Trac uses the `public` schema by default but you can specify a different schema in the connection string: |
| | 88 | {{{ |
| | 89 | postgres://user:pass@server/database?schema=yourschemaname |
| | 90 | }}} |
| | 91 | |
| | 92 | === MySQL Connection String === |
| | 93 | |
| | 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: |
| | 98 | {{{ |
| | 99 | mysql://johndoe:letmein@localhost:3306/trac |
| | 100 | }}} |
| 100 | | * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs) |
| 101 | | * `templates` - Custom environment-specific templates. |
| 102 | | * `site_css.cs` - Custom CSS rules. |
| 103 | | * `site_footer.cs` - Custom page footer. |
| 104 | | * `site_header.cs` - Custom page header. |
| 105 | | * `wiki-macros` - Environment-specific [wiki:WikiMacros Wiki macros]. |
| | 143 | * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(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 |
| 107 | | '''Note: don't confuse a Trac environment directory with the source code repository directory. |
| 108 | | It happens that the above structure is loosely modelled after the Subversion repository directory |
| 109 | | structure, but they are not and ''must not'' be located at the same place.''' |
| | 149 | '''Caveat:''' ''don't confuse a Trac environment directory with the source code repository directory.'' |
| | 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. |
