Legend:

Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.

3

[[TracGuideToc]]

4

[[PageOutline(2-5,Contents,pullout)]]

4

5

5

== Creating an Environment ==

6

Trac uses a directory structure and a database for storing project data. The directory is referred to as the '''environment'''.

6

7

7

A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:

8

{{{

8

== Creating an Environment

9

10

A new Trac environment is created using [TracAdmin#initenv trac-admin's initenv]:

11

{{{#!sh

9

12

$ trac-admin /path/to/myproject initenv

10

13

}}}

11

14

12

`trac-admin` will ask you for the name of the project and the

13

database connection string (explained below).

15

`trac-admin` will ask you for the name of the project and the database connection string, see below.

14

16

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.

17

=== Useful Tips

18

19

- 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.

20

21

- 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.

20

22

21

- `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.

23

- `initenv` does not create a version control repository for the specified path. If you wish to specify a default repository using optional the 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//.

22

24

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]).

25

- Non-ascii environment paths are not supported.

26

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.

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].

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.

32

This is a common beginners' mistake.

33

It happens that the structure for a Trac environment is loosely modelled 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.

34

}}}

37

35

38

=== SQLite Connection String ===

36

== Database Connection Strings

37

38

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.

39

40

Note that if the username or password of the connection string (if applicable) contains the `:`, `/` or `@` characters, they need to be URL encoded.

where `db/trac.db` is the path to the database file within the Trac environment.

44

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:

50

=== PostgreSQL Connection String

51

52

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:

50

53

{{{

51

54

postgres://johndoe:letmein@localhost/trac

52

55

}}}

53

''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''

54

56

55

If PostgreSQL is running on a non-standard port (for example 9342), use:

57

If PostgreSQL is running on a non-standard port, for example 9342, use:

56

58

{{{

57

59

postgres://johndoe:letmein@localhost:9342/trac

58

60

}}}

59

61

60

On UNIX, you might want to select a UNIX socket for the transport,

61

either the default socket as defined by the PGHOST environment variable:

62

On UNIX, you might want to select a UNIX socket for the transport, either the default socket as defined by the PGHOST environment variable:

Note that with PostgreSQL you will have to create the database before running

71

`trac-admin initenv`.

72

Note that with PostgreSQL you will have to create the database before running `trac-admin initenv`.

72

73

73

74

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:

Generally, the following is sufficient to create a database user named `tracuser` and a database named `trac`:

76

{{{#!sh

77

$ createuser -U postgres -E -P tracuser

78

$ createdb -U postgres -O tracuser -E UTF8 trac

85

79

}}}

86

80

87

Trac uses the `public` schema by default but you can specify a different schema in the connection string:

81

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.

82

83

Under some default configurations (Debian), run the `createuser` and `createdb` scripts as the `postgres` user:

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`:

98

97

{{{

99

98

mysql://johndoe:letmein@localhost:3306/trac

100

99

}}}

101

100

102

== Source Code Repository ==

101

== Source Code Repository

103

102

104

Since version 0.12, a single Trac environment can be connected to more than one repository. There are many different ways to connect repositories to an environment, see TracRepositoryAdmin. This page also details the various attributes that can be set for a repository (like `type`, `url`, `description`).

103

Since Trac 0.12, a single environment can be connected to more than one repository. There are many different ways to connect repositories to an environment, see TracRepositoryAdmin. This page also details the various attributes that can be set for a repository, such as `type`, `url`, `description`.

105

104

106

105

In Trac 0.12 `trac-admin` no longer asks questions related to repositories. Therefore, by default Trac is not connected to any source code repository, and the ''Browse Source'' toolbar item will not be displayed.

107

You can also explicitly disable the `trac.versioncontrol.*` components (which are otherwise still loaded)

108

{{{

106

You can also explicitly disable the `trac.versioncontrol.*` components, which are otherwise still loaded:

107

{{{#!ini

109

108

[components]

110

109

trac.versioncontrol.* = disabled

111

110

}}}

112

111

113

For some version control systems, it is possible to specify not only the path to the repository,

114

but also a ''scope'' within the repository. Trac will then only show information

115

related to the files and changesets below that scope. The Subversion backend for

For some version control systems, it is possible to specify not only the path to the repository, but also a ''scope'' within the repository. Trac will then only show information related to the files and changesets below that scope. The Subversion backend for Trac supports this. For other types, check the corresponding plugin's documentation.

117

113

118

114

Example of a configuration for a Subversion repository used as the default repository: