annotate examples/trac/wiki-default/TracEnvironment @ 39:93b4dcbafd7b trunk

Copy Trac to main branch.
author cmlenz
date Mon, 03 Jul 2006 18:53:27 +0000
parents
children
rev   line source
39
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
1 = Trac Storage - The Environment =
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
2
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
3 Trac uses a directory structure and a database for storing project data.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
4
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
5 == Creating an Environment ==
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
6
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
7 A new Trac environment is created using [wiki:TracAdmin trac-admin]:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
8 {{{
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
9 $ trac-admin /path/to/projectenv initenv
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
10 }}}
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
11
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
12 [wiki:TracAdmin trac-admin] will ask you for the name of the project, the
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
13 database connection string (explained below), and where your subversion
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
14 repository is located.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
15
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
16 ''Note: The web server user will require file system write permission to
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
17 the environment directory and all the files inside. Please remember to set
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
18 the appropriate permissions. The same applies to the Subversion
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
19 repository, although Trac will only require read access as long as you're
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
20 not using the BDB file system.''
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
21
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
22 == Database Connection Strings ==
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
23
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
24 Since version 0.9, Trac supports both [http://sqlite.org/ SQLite] and
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
25 [http://www.postgresql.org/ PostgreSQL] as database backends. The default
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
26 is to use SQLite, which is probably sufficient for most projects. The database file
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
27 is then stored in the environment directory, and can easily be
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
28 [wiki:TracBackup backed up] together with the rest of the environment.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
29
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
30 The connection string for an embedded SQLite database is:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
31 {{{
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
32 sqlite:db/trac.db
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
33 }}}
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
34
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
35 If you want to use PostgreSQL instead, you'll have to use a different
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
36 connection string. For example, to connect to a database on the same
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
37 machine called `trac`, that allows access to the user `johndoe` with
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
38 the password `letmein`, use:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
39 {{{
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
40 postgres://johndoe:letmein@localhost/trac
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
41 }}}
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
42
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
43 If PostgreSQL is running on a non-standard port (for example 9342), use:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
44 {{{
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
45 postgres://johndoe:letmein@localhost:9342/trac
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
46 }}}
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
47
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
48 Note that with PostgreSQL you will have to create the database before running
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
49 `trac-admin initenv`.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
50
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
51 == Directory Structure ==
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
52
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
53 An environment directory will usually consist of the following files and directories:
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
54
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
55 * `README` - Brief description of the environment.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
56 * `VERSION` - Contains the environment version identifier.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
57 * `attachments` - Attachments to wiki pages and tickets are stored here.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
58 * `conf`
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
59 * `trac.ini` - Main configuration file. See TracIni.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
60 * `db`
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
61 * `trac.db` - The SQLite database (if you're using SQLite).
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
62 * `plugins` - Environment-specific [wiki:TracPlugins plugins] (Python eggs)
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
63 * `templates` - Custom environment-specific templates.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
64 * `site_css.cs` - Custom CSS rules.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
65 * `site_footer.cs` - Custom page footer.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
66 * `site_header.cs` - Custom page header.
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
67 * `wiki-macros` - Environment-specific [wiki:WikiMacros Wiki macros].
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
68
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
69 ----
93b4dcbafd7b Copy Trac to main branch.
cmlenz
parents:
diff changeset
70 See also: TracAdmin, TracBackup, TracIni, TracGuide
Copyright (C) 2012-2017 Edgewall Software