Changes between Initial Version and Version 1 of TracEnvironment

Timestamp:: 02/23/08 22:54:25 (17 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracEnvironment

v1	v1
	1	= The Trac Environment =
	2
	3	Trac uses a directory structure and a database for storing project data. The directory is referred to as the “environment”.
	4
	5	== Creating an Environment ==
	6
	7	A new Trac environment is created using [wiki:TracAdmin trac-admin]:
	8	{{{
	9	$ trac-admin /path/to/myproject initenv
	10	}}}
	11
	12	[wiki:TracAdmin trac-admin] will ask you for the name of the project, the
	13	database connection string (explained below), and the type and path to
	14	your source code repository.
	15
	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.''
	21
	22	== Database Connection Strings ==
	23
	24	Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
	25	[http://www.postgresql.org/ PostgreSQL] database backends. Preliminary
	26	support for [http://mysql.com/ MySQL] was added in 0.10. The default is
	27	to use SQLite, which is probably sufficient for most projects. The database
	28	file is then stored in the environment directory, and can easily be
	29	[wiki:TracBackup backed up] together with the rest of the environment.
	30
	31	=== Embedded SQLite Connection String ===
	32	The connection string for an embedded SQLite database is:
	33	{{{
	34	sqlite:db/trac.db
	35	}}}
	36
	37	=== PostgreSQL Connection String ===
	38	If you want to use PostgreSQL or MySQL instead, you'll have to use a
	39	different connection string. For example, to connect to a PostgreSQL
	40	database on the same machine called `trac`, that allows access to the
	41	user `johndoe` with the password `letmein`, use:
	42	{{{
	43	postgres://johndoe:letmein@localhost/trac
	44	}}}
	45	''Note that due to the way the above string is parsed, the "/" and "@" characters cannot be part of the password.''
	46
	47	If PostgreSQL is running on a non-standard port (for example 9342), use:
	48	{{{
	49	postgres://johndoe:letmein@localhost:9342/trac
	50	}}}
	51
	52	On UNIX, you might want to select a UNIX socket for the transport,
	53	either the default socket as defined by the PGHOST environment variable:
	54	{{{
	55	postgres://user:password@/database
	56	}}}
	57	or a specific one:
	58	{{{
	59	postgres://user:password@/database?host=/path/to/socket/dir
	60	}}}
	61
	62	Note that with PostgreSQL you will have to create the database before running
	63	`trac-admin initenv`.
	64
	65	See the [http://www.postgresql.org/docs/ PostgreSQL documentation] for detailed instructions on how to administer [http://postgresql.org PostgreSQL].
	66	Generally, the following is sufficient to create a database user named `tracuser`, and a database named `trac`.
	67	{{{
	68	createuser -U postgres -E -P tracuser
	69	createdb -U postgres -O tracuser -E UTF8 trac
	70	}}}
	71	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.
	72
	73	Under some default configurations (debian) one will have run the `createuser` and `createdb` scripts as the `postgres` user. For example:
	74	{{{
	75	sudo su - postgres -c 'createuser -U postgres -S -D -R -E -P tracuser'
	76	sudo su - postgres -c 'createdb -U postgres -O tracuser -E UTF8 trac'
	77	}}}
	78
	79	Trac uses the `public` schema by default but you can specify a different schema in the connection string:
	80	{{{
	81	postgres://user:pass@server/database?schema=yourschemaname
	82	}}}
	83
	84	=== MySQL Connection String ===
	85
	86	If you want to use MySQL instead, you'll have to use a
	87	different connection string. For example, to connect to a MySQL
	88	database on the same machine called `trac`, that allows access to the
	89	user `johndoe` with the password `letmein`, the mysql connection string is:
	90	{{{
	91	mysql://johndoe:letmein@localhost:3306/trac
	92	}}}
	93
	94	== Source Code Repository ==
	95
	96	You'll first have to provide the ''type'' of your repository (e.g. `svn` for Subversion,
	97	which is the default), then the ''path'' where the repository is located.
	98
	99	If you don't want to use Trac with a source code repository, simply leave the ''path'' empty
	100	(the ''type'' information doesn't matter, then).
	101
	102	For some systems, it is possible to specify not only the path to the repository,
	103	but also a ''scope'' within the repository. Trac will then only show information
	104	related to the files and changesets below that scope. The Subversion backend for
	105	Trac supports this; for other types, check the corresponding plugin's documentation.
	106
	107	Example of a configuration for a Subversion repository:
	108	{{{
	109	[trac]
	110	repository_type = svn
	111	repository_dir = /path/to/your/repository
	112	}}}
	113
	114	The configuration for a scoped Subversion repository would be:
	115	{{{
	116	[trac]
	117	repository_type = svn
	118	repository_dir = /path/to/your/repository/scope/within/repos
	119	}}}
	120
	121	== Directory Structure ==
	122
	123	An environment directory will usually consist of the following files and directories:
	124
	125	* `README` - Brief description of the environment.
	126	* `VERSION` - Contains the environment version identifier.
	127	* `attachments` - Attachments to wiki pages and tickets are stored here.
	128	* `conf`
	129	* `trac.ini` - Main configuration file. See TracIni.
	130	* `db`
	131	* `trac.db` - The SQLite database (if you're using SQLite).
	132	* `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs, since [milestone:0.10])
	133	* `templates` - Custom environment-specific templates.
	134	* `site_css.cs` - Custom CSS rules.
	135	* `site_footer.cs` - Custom page footer.
	136	* `site_header.cs` - Custom page header.
	137	* `wiki-macros` - Environment-specific [wiki:TracWikiMacros Wiki macros].
	138
	139	'''Note: don't confuse a Trac environment directory with the source code repository directory.
	140	It happens that the above structure is loosely modelled after the Subversion repository directory
	141	structure, but they are not and ''must not'' be located at the same place.'''
	142
	143	----
	144	See also: TracAdmin, TracBackup, TracIni, TracGuide