| 14 | | '''Note:''' The web server user will require file system write permission to the environment |
| 15 | | directory and all the files inside. '''Remember to set the appropriate permissions.'' |
| | 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.'' |
| | 31 | The connection string for an embedded SQLite database is: |
| | 32 | {{{ |
| | 33 | sqlite:db/trac.db |
| | 34 | }}} |
| | 35 | |
| | 36 | If you want to use PostgreSQL or MySQL instead, you'll have to use a |
| | 37 | different connection string. For example, to connect to a PostgreSQL |
| | 38 | database on the same machine called `trac`, that allows access to the |
| | 39 | user `johndoe` with the password `letmein`, use: |
| | 40 | {{{ |
| | 41 | postgres://johndoe:letmein@localhost/trac |
| | 42 | }}} |
| | 43 | |
| | 44 | If PostgreSQL is running on a non-standard port (for example 9342), use: |
| | 45 | {{{ |
| | 46 | postgres://johndoe:letmein@localhost:9342/trac |
| | 47 | }}} |
| | 48 | |
| | 49 | Note that with PostgreSQL you will have to create the database before running |
| | 50 | `trac-admin initenv`. |
| | 51 | |
| | 52 | And make sure PostgreSQl DB name is "trac". What worked for me: |
| | 53 | And didn't work uppercase trac-user-name |
| | 54 | {{{ |
| | 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'; |
| | 58 | }}} |
| | 59 | |
| | 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.) |
| | 61 | |
| | 62 | == Source Code Repository == |
| | 63 | |
| | 64 | You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion, |
| | 65 | which is the default), then the ''path'' where the repository is located. |
| | 66 | |
| | 67 | If you don't want to use Trac with a source code repository, simply leave the ''path'' empty |
| | 68 | (the ''type'' information doesn't matter, then). |
| | 69 | |
| | 70 | For some systems, it is possible to specify not only the path to the repository, |
| | 71 | but also a ''scope'' within the repository. Trac will then only show information |
| | 72 | related to the files and changesets below that scope. The Subversion backend for |
| | 73 | Trac supports this; for other types, check the corresponding plugin's documentation. |
| | 74 | |
| | 75 | Example of a configuration for a Subversion repository: |
| | 76 | {{{ |
| | 77 | [trac] |
| | 78 | repository_type = svn |
| | 79 | repository_dir = /path/to/your/repository |
| | 80 | }}} |
| | 81 | |
| | 82 | The configuration for a scoped Subversion repository would be: |
| | 83 | {{{ |
| | 84 | [trac] |
| | 85 | repository_type = svn |
| | 86 | repository_dir = /path/to/your/repository/scope/within/repos |
| | 87 | }}} |
| 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. |
| | 91 | An environment directory will usually consist of the following files and directories: |
| | 92 | |
| | 93 | * `README` - Brief description of the environment. |
| | 94 | * `VERSION` - Contains the environment version identifier. |
| | 95 | * `attachments` - Attachments to wiki pages and tickets are stored here. |
| | 96 | * `conf` |
| | 97 | * `trac.ini` - Main configuration file. See TracIni. |
| | 98 | * `db` |
| | 99 | * `trac.db` - The SQLite database (if you're using SQLite). |
| | 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]. |
| | 106 | |
| | 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.''' |
