"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "doc/admin_guide.txt" between
roundup-1.6.1.tar.gz and roundup-2.0.0.tar.gz

About: Roundup is an highly customisable issue-tracking system with command-line, web and e-mail interfaces (written in Python).

admin_guide.txt  (roundup-1.6.1):admin_guide.txt  (roundup-2.0.0)
skipping to change at line 286 skipping to change at line 286
It's safe to run this even if it's not required, so just get into the It's safe to run this even if it's not required, so just get into the
habit. habit.
7. Restart your tracker web and email frontends. 7. Restart your tracker web and email frontends.
If something bad happens, you may reinstate your backup of the tracker and If something bad happens, you may reinstate your backup of the tracker and
reinstall the older version of the sofware using the same install command:: reinstall the older version of the sofware using the same install command::
python setup.py install python setup.py install
.. index:: database; convert from one database backend to another
single: roundup-admin; import and export
Migrating Backends Migrating Backends
------------------ ------------------
1. Stop the existing tracker web and email frontends (preventing changes). 1. Stop the existing tracker web and email frontends (preventing changes).
2. Use the roundup-admin tool "export" command to export the contents of 2. Use the roundup-admin tool "export" command to export the contents of
your tracker to disk. your tracker to disk. (If you are running on windows see
`issue1441336 <https://issues.roundup-tracker.org/issue1441336>`_
on how to use the command line rather than interactive mode to
export data.)
3. Copy the tracker home to a new directory. 3. Copy the tracker home to a new directory.
4. Delete the "db" directory from the new directory. 4. Delete the "db" directory from the new directory.
5. Set the value of the ``backend`` key under the ``[database]`` 5. Set the value of the ``backend`` key under the ``[database]``
section of the tracker's ``config.ini`` file. section of the tracker's ``config.ini`` file.
6. Use the roundup-admin "import" command to import the previous export with 6. Use the roundup-admin "import" command to import the previous export with
the new tracker home. If non-interactively:: the new tracker home. If non-interactively::
roundup-admin -i <tracker home> import <tracker export dir> roundup-admin -i <tracker home> import <tracker export dir>
If interactively, enter 'commit' before exiting. If interactively, enter 'commit' before exiting.
skipping to change at line 331 skipping to change at line 337
1. install Roundup on the new machine and test that it works there, 1. install Roundup on the new machine and test that it works there,
2. stop the existing tracker web and email frontends (preventing changes), 2. stop the existing tracker web and email frontends (preventing changes),
3. use the roundup-admin tool "export" command to export the contents of 3. use the roundup-admin tool "export" command to export the contents of
the existing tracker, the existing tracker,
4. copy the export to the new machine, 4. copy the export to the new machine,
5. use the roundup-admin "import" command to import the tracker on the new 5. use the roundup-admin "import" command to import the tracker on the new
machine, and machine, and
6. start the tracker web and email frontends on the new machine. 6. start the tracker web and email frontends on the new machine.
.. index::
pair: roundup; migrate from other bugtracker software
Migrating From Other Software Migrating From Other Software
----------------------------- -----------------------------
You have a couple of choices. You can either use a CSV import into Roundup, You have a couple of choices. You can either use a CSV import into Roundup,
or you can write a simple Python script which uses the Roundup API or you can write a simple Python script which uses the Roundup API
directly. The latter is almost always simpler -- see the "scripts" directly. The latter is almost always simpler -- see the "scripts"
directory in the Roundup source for some example uses of the API. directory in the Roundup source for some example uses of the API.
"roundup-admin import" will import data into your tracker from a "roundup-admin import" will import data into your tracker from a
directory containing files with the following format: directory containing files with the following format:
skipping to change at line 355 skipping to change at line 364
named <classname>-journals.csv (this is required, even if it's empty) named <classname>-journals.csv (this is required, even if it's empty)
- if the Class is a FileClass, you may have the "content" property - if the Class is a FileClass, you may have the "content" property
stored in separate files from the csv files. This goes in a directory stored in separate files from the csv files. This goes in a directory
structure:: structure::
<classname>-files/<N>/<designator> <classname>-files/<N>/<designator>
where ``<designator>`` is the item's ``<classname><id>`` combination. where ``<designator>`` is the item's ``<classname><id>`` combination.
The ``<N>`` value is ``int(<id> / 1000)``. The ``<N>`` value is ``int(<id> / 1000)``.
.. index:: pair: roundup-admin; managing users
Adding A User From The Command-Line Adding A User From The Command-Line
----------------------------------- -----------------------------------
The ``roundup-admin`` program can create any data you wish to in the The ``roundup-admin`` program can create any data you wish to in the
database. To create a new user, use:: database. To create a new user, use::
roundup-admin create user roundup-admin create user
To figure out what good values might be for some of the fields (eg. Roles) To figure out what good values might be for some of the fields (eg. Roles)
you can just display another user:: you can just display another user::
roundup-admin list user roundup-admin list user
(or if you know their username, and it happens to be "richard"):: (or if you know their username, and it happens to be "richard")::
roundup-admin find username=richard roundup-admin filter user username=richard
then using the user id you get from one of the above commands, you may then using the user id (e.g. 5) you get from one of the above
display the user's details:: commands, you may display the user's details::
roundup-admin display <userid> roundup-admin display <designator>
where designator is ``user5``.
Running the Servers Running the Servers
=================== ===================
Unix Unix
---- ----
On Unix systems, use the scripts/server-ctl script to control the On Unix systems, use the scripts/server-ctl script to control the
roundup-server server. Copy it somewhere and edit the variables at the top roundup-server server. Copy it somewhere and edit the variables at the top
to reflect your specific installation. to reflect your specific installation.
skipping to change at line 426 skipping to change at line 439
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The mail gateway script should be scheduled to run regularly on your The mail gateway script should be scheduled to run regularly on your
Windows server. Normally this will result in a window popping up. The Windows server. Normally this will result in a window popping up. The
solution to this is to: solution to this is to:
1. Create a new local account on the Roundup server 1. Create a new local account on the Roundup server
2. Set the scheduled task to run in the context of this user instead 2. Set the scheduled task to run in the context of this user instead
of your normal login of your normal login
.. index:: ! roundup-admin
single: roundup-admin; man page reference
Using roundup-admin
===================
Part of the installation includes a man page for roundup-admin. Ypu
should be able to read it using ``man roundup-admin``. As shown above,
it is a generic tool for manipulating the underlying database for you
tracker.
Examples above show how to use it to:
* install and initialize a new tracker
* export/import tracker data for migrating between backends
* creating a new user fom the command line
* list/find users in the tracker
A brief (incomplete) summary is::
roundup-admin help
roundup-admin -i <tracker_dir> get [-list] designator[, designator,...] prop
name
roundup-admin -i <tracker_dir> set designator[, designator,...] propname=val
ue ...
roundup-admin -i <tracker_dir> find [-list] classname propname=value ...
Run ``roundup-admin help commands`` for a complete list of subcommands.
.. _`customisation documentation`: customizing.html .. _`customisation documentation`: customizing.html
.. _`upgrading documentation`: upgrading.html .. _`upgrading documentation`: upgrading.html
 End of changes. 8 change blocks. 
5 lines changed or deleted 47 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)