| | 32 | === Embedded SQLite Connection String === |
| | 33 | The connection string for an embedded SQLite database is: |
| | 34 | {{{ |
| | 35 | sqlite:db/trac.db |
| | 36 | }}} |
| | 37 | |
| | 38 | === PostgreSQL Connection String === |
| | 39 | If you want to use PostgreSQL or MySQL instead, you'll have to use a |
| | 40 | different connection string. For example, to connect to a PostgreSQL |
| | 41 | database on the same machine called `trac`, that allows access to the |
| | 42 | user `johndoe` with the password `letmein`, use: |
| | 43 | {{{ |
| | 44 | postgres://johndoe:letmein@localhost/trac |
| | 45 | }}} |
| | 46 | ''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.'' |
| | 47 | |
| | 48 | If PostgreSQL is running on a non-standard port (for example 9342), use: |
| | 49 | {{{ |
| | 50 | postgres://johndoe:letmein@localhost:9342/trac |
| | 51 | }}} |
| | 52 | |
| | 53 | On UNIX, you might want to select a UNIX socket for the transport, |
| | 54 | either the default socket as defined by the PGHOST environment variable: |
| | 55 | {{{ |
| | 56 | postgres://user:password@/database |
| | 57 | }}} |
| | 58 | or a specific one: |
| | 59 | {{{ |
| | 60 | postgres://user:password@/database?host=/path/to/socket/dir |
| | 61 | }}} |
| | 62 | |
| | 63 | Note that with PostgreSQL you will have to create the database before running |
| | 64 | `trac-admin initenv`. |
| | 65 | |
| | 66 | See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL]. |
| | 67 | Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`. |
| | 68 | {{{ |
| | 69 | createuser -U postgres -E -P tracuser |
| | 70 | createdb -U postgres -O tracuser -E UTF8 trac |
| | 71 | }}} |
| | 72 | 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. |
| | 73 | |
| | 74 | Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user. For example: |
| | 75 | {{{ |
| | 76 | sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser' |
| | 77 | sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac' |
| | 78 | }}} |
| | 79 | |
| | 80 | Trac uses the `public` schema by default but you can specify a different schema in the connection string: |
| | 81 | {{{ |
| | 82 | postgres://user:pass@server/database?schema=yourschemaname |
| | 83 | }}} |
| | 84 | |
| | 85 | === MySQL Connection String === |
| | 86 | |
| | 87 | If you want to use MySQL instead, you'll have to use a |
| | 88 | different connection string. For example, to connect to a MySQL |
| | 89 | database on the same machine called `trac`, that allows access to the |
| | 90 | user `johndoe` with the password `letmein`, the mysql connection string is: |
| | 91 | {{{ |
| | 92 | mysql://johndoe:letmein@localhost:3306/trac |
| | 93 | }}} |
| | 94 | |
| | 95 | == Source Code Repository == |
| | 96 | |
| | 97 | You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion, |
| | 98 | which is the default), then the ''path'' where the repository is located. |
| | 99 | |
| | 100 | If you don't want to use Trac with a source code repository, simply leave the ''path'' empty |
| | 101 | (the ''type'' information doesn't matter, then). |
| | 102 | |
| | 103 | For some systems, it is possible to specify not only the path to the repository, |
| | 104 | but also a ''scope'' within the repository. Trac will then only show information |
| | 105 | related to the files and changesets below that scope. The Subversion backend for |
| | 106 | Trac supports this; for other types, check the corresponding plugin's documentation. |
| | 107 | |
| | 108 | Example of a configuration for a Subversion repository: |
| | 109 | {{{ |
| | 110 | [trac] |
| | 111 | repository_type = svn |
| | 112 | repository_dir = /path/to/your/repository |
| | 113 | }}} |
| | 114 | |
| | 115 | The configuration for a scoped Subversion repository would be: |
| | 116 | {{{ |
| | 117 | [trac] |
| | 118 | repository_type = svn |
| | 119 | repository_dir = /path/to/your/repository/scope/within/repos |
| | 120 | }}} |
| 42 | | * '''README''' - Brief description of the environment. |
| 43 | | * '''VERSION''' - Contains the environment version identifier. |
| 44 | | * '''attachments''' - All attached files go in here. |
| 45 | | * '''ticket''' - Ticket attachments. |
| 46 | | * '''wiki''' - Wiki attachments. |
| 47 | | * '''conf''' |
| 48 | | * '''trac.ini''' - Main configuration file. See TracIni. |
| 49 | | * '''db''' |
| 50 | | * '''trac.db''' - SQLite database. |
| 51 | | * '''templates''' - Custom (environment-specific) templates. |
| 52 | | * '''site_css.cs''' - Custom CSS stylesheet. |
| 53 | | * '''site_footer.cs''' - Custom footer. |
| 54 | | * '''site_header.cs''' - Custom header. |
| 55 | | * '''wiki-macros''' - Environment-specific WikiMacros. |
| | 124 | An environment directory will usually consist of the following files and directories: |
| | 125 | |
| | 126 | * `README` - Brief description of the environment. |
| | 127 | * `VERSION` - Contains the environment version identifier. |
| | 128 | * `attachments` - Attachments to wiki pages and tickets are stored here. |
| | 129 | * `conf` |
| | 130 | * `trac.ini` - Main configuration file. See TracIni. |
| | 131 | * `db` |
| | 132 | * `trac.db` - The SQLite database (if you're using SQLite). |
| | 133 | * `htdocs` - directory containing web resources, which can be referenced in Genshi templates. '''''(0.11 only)''''' |
| | 134 | * `log` - default directory for log files, if logging is turned on and a relative path is given. |
| | 135 | * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [milestone:0.10]) |
| | 136 | * `templates` - Custom ClearSilver environment-specific templates. '''''(0.10 only)''''' |
| | 137 | * `site_css.cs` - Custom CSS rules. |
| | 138 | * `site_footer.cs` - Custom page footer. |
| | 139 | * `site_header.cs` - Custom page header. |
| | 140 | * `templates` - Custom Genshi environment-specific templates. '''''(0.11 only)''''' |
| | 141 | * `site.html` - method to customize header, footer, and style, described in TracInterfaceCustomization#SiteAppearance |
| | 142 | * `wiki-macros` - Environment-specific [WikiMacros Wiki macros]. '''''(0.10 only)''''' |
| | 143 | |
| | 144 | '''Note: don't confuse a Trac environment directory with the source code repository directory. |
| | 145 | It happens that the above structure is loosely modelled after the Subversion repository directory |
| | 146 | structure, but they are not and ''must not'' be located at the same place.''' |
