Context Navigation

Changes between Version 1 and Version 2 of TracAdmin

Timestamp:: Apr 13, 2011, 8:59:03 PM (14 years ago)
Author:: trac
Comment:: --

Legend:

: Unmodified
: Added
: Removed
: Modified

TracAdmin

-              v1
+              v2
 [[TracGuideToc]]
+Trac is distributed with a powerful configuration tool. This tool can be used
+to configure and customize your Trac-installation to better fit your needs.
+Trac is distributed with a powerful command-line configuration tool. This tool can be used  to configure and customize your Trac-installation to better fit your needs.
+Some of those operations can also be performed via the ''Admin'' web interface, an updated version of the [trac:WebAdmin] plugin now integrated within Trac (since version 0.11).
 == Usage ==
+For nearly every `trac-admin` command, you'll need to specify the path to the TracEnvironment that you want to administer as the first argument, for example:
 {{{
+Usage: trac-admin </path/to/projenv> [command [subcommand] [option ...]]
+trac-admin /path/to/projenv wiki list
+}}}
+Invoking trac-admin without command starts interactive mode.
+The only exception is for the `help` command, but even in this case if you omit the environment, you'll only get a very succinct list of commands (`help` and `initenv`), the same list you'd get when invoking `trac-admin` alone.
+Also, `trac-admin --version` will tell you about the Trac version (e.g. 0.12) corresponding to the program.
+about                                             -- Shows information about trac-admin
+help                                              -- Show documentation
+initenv                                           -- Create and initialize a new environment interactively
+initenv <projectname> <repospath> <templatepath>  -- Create and initialize a new environment from arguments
+hotcopy <backupdir>                               -- Make a hot backup copy of an environment.
+resync                                            -- Re-synchronize trac with the repository
+upgrade                                           -- Upgrade database to current version.
+wiki list                                         -- List wiki pages
+wiki export <page> [file]                         -- Export wiki page to file or stdout
+wiki import <page> [file]                         -- Import wiki page from file or stdin
+wiki dump <directory>                             -- Export all wiki pages to files named by title
+wiki load <directory>                             -- Import all wiki pages from directory
+wiki upgrade                                      -- Upgrade default wiki pages to current version
+permission list                                   -- List permission rules
+permission add <user> <action> [action] [...]     -- Add a new permission rule
+permission remove <user> <action> [action] [...]  -- Remove permission rule
+component list                                    -- Show available components
+component add <name> <owner>                      -- Add a new component
+component rename <name> <newname>                 -- Rename a component
+component remove <name>                           -- Remove/uninstall component
+component chown <name> <owner>                    -- Change component ownership
+priority list                                     -- Show possible ticket priorities
+priority add <value>                              -- Add a priority value option
+priority change <value> <newvalue>                -- Change a priority value
+priority remove <value>                           -- Remove priority value
+severity list                                     -- Show possible ticket priorities
+severity add <value>                              -- Add a severity value option
+severity change <value> <newvalue>                -- Change a severity value
+severity remove <value>                           -- Remove severity value
+version list                                      -- Show versions
+version add <name> [time]                         -- Add version
+version rename <name> <newname>                   -- Rename version
+version time <name> <time>                        -- Set version date (Format: "Jun 3, 2003")
+version remove <name>                             -- Remove version
+milestone list                                    -- Show milestones
+milestone add <name> [time]                       -- Add milestone
+milestone rename <name> <newname>                 -- Rename milestone
+milestone time <name> <time>                      -- Set milestone date (Format: "Jun 3, 2003")
+milestone remove <name>                           -- Remove milestone
+If you want to get a comprehensive list of the available commands and sub-commands, you need to specify an existing environment:
+{{{
+trac-admin /path/to/projenv help
 }}}
+Some commands have a more detailed help, which you can access by specifying the command's name as a subcommand for `help`:
+{{{
+trac-admin /path/to/projenv help <command>
+}}}
+=== `trac-admin <targetdir> initenv` === #initenv
+This subcommand is very important as it's the one used to create a TracEnvironment in the specified `<targetdir>`. That directory must not exist prior to the call.
+[[TracAdminHelp(initenv)]]
+It supports an extra `--inherit` option, which can be used to specify a global configuration file which can be used share settings between several environments. You can also inherit from a shared configuration afterwards, by setting the `[inherit] file` option in the `conf/trac.ini` file in your newly created environment, but the advantage of specifying the inherited configuration file at environment creation time is that only the options ''not'' already specified in the global configuration file will be written in the created environment's `conf/trac.ini` file.
+See TracIni#GlobalConfiguration.
+Note that in version 0.11 of Trac, `initenv` lost an extra last argument `<templatepath>`, which was used in previous versions to point to the `templates` folder. If you are using the one-liner '`trac-admin /path/to/trac/ initenv <projectname> <db> <repostype> <repospath>`' in the above and getting an error that reads ''''`Wrong number of arguments to initenv: 4`'''', then this is because you're using a `trac-admin` script from an '''older''' version of Trac.
 == Interactive Mode ==
 When passed the database filename as only argument, '''trac-admin''' starts in interactive mode.
 Commands can then be executed on the selected database using the prompt, which offers tab-completion
 (on non-Windows environments) and automatic repetition of the last command issued.
+When passing the environment path as the only argument, `trac-admin` starts in interactive mode.
+Commands can then be executed on the selected environment using the prompt, which offers tab-completion
+(on non-Windows environments, and when the Python `readline` module is available) and automatic repetition of the last command issued.
+== A Note on Configuration ==
+For configuration of the Trac environment, Trac 0.7 introduced a new storage format, including a separate config file used for settings. See TracIni for details.
+Once you're in interactive mode, you can also get help on specific commands or subsets of commands:
+For example, to get an explanation of the `resync` command, run:
+{{{
+> help resync
+}}}
+To get help on all the Wiki-related commands, run:
+{{{
+> help wiki
+}}}
+== Full Command Reference ==
+You'll find below the detailed help for all the commands available by default in `trac-admin`. Note that this may not match the list given by `trac-admin <yourenv> help`, as the commands  pertaining to components disabled in that environment won't be available and conversely some plugins activated in the environment can add their own commands.
+[[TracAdminHelp()]]
 ----
 See Also: TracGuide, TracBackup, TracPermissions. TracEnvironment, TracIni
+See also: TracGuide, TracBackup, TracPermissions, TracEnvironment, TracIni, [trac:TracMigrate TracMigrate]