Mercurial > p > roundup > code
comparison doc/admin_guide.txt @ 3342:ee1e2c8472f3 maint-0.8
merge from HEAD
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Tue, 24 May 2005 03:54:00 +0000 |
| parents | 4fe232899be8 |
| children | 8fcee705ebdb |
comparison
equal
deleted
inserted
replaced
| 3340:9dd378894afc | 3342:ee1e2c8472f3 |
|---|---|
| 1 ==================== | 1 ==================== |
| 2 Administration Guide | 2 Administration Guide |
| 3 ==================== | 3 ==================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.15.2.2 $ | 5 :Version: $Revision: 1.15.2.3 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 What does Roundup install? | 9 What does Roundup install? |
| 10 ========================== | 10 ========================== |
| 161 | 161 |
| 162 1. `tracker backup`_ | 162 1. `tracker backup`_ |
| 163 2. `software upgrade`_ | 163 2. `software upgrade`_ |
| 164 3. `migrating backends`_ | 164 3. `migrating backends`_ |
| 165 4. `moving a tracker`_ | 165 4. `moving a tracker`_ |
| 166 5. `migrating from other software`_ | |
| 167 6. `adding a user from the command-line`_ | |
| 166 | 168 |
| 167 | 169 |
| 168 Tracker Backup | 170 Tracker Backup |
| 169 -------------- | 171 -------------- |
| 170 | 172 |
| 253 5. use the roundup-admin "import" command to import the tracker on the new | 255 5. use the roundup-admin "import" command to import the tracker on the new |
| 254 machine, and | 256 machine, and |
| 255 6. start the tracker web and email frontends on the new machine. | 257 6. start the tracker web and email frontends on the new machine. |
| 256 | 258 |
| 257 | 259 |
| 260 Migrating From Other Software | |
| 261 ----------------------------- | |
| 262 | |
| 263 You have a couple of choices. You can either use a CSV import into Roundup, | |
| 264 or you can write a simple Python script which uses the Roundup API | |
| 265 directly. The latter is almost always simpler -- see the "scripts" | |
| 266 directory in the Roundup source for some example uses of the API. | |
| 267 | |
| 268 "roundup-admin import" will import data into your tracker from a | |
| 269 directory containing files with the following format: | |
| 270 | |
| 271 - one colon-separated-values file per Class with columns for each property, | |
| 272 named <classname>.csv | |
| 273 - one colon-separated-values file per Class with journal information, | |
| 274 named <classname>-journals.csv (this is required, even if it's empty) | |
| 275 - if the Class is a FileClass, you may have the "content" property | |
| 276 stored in separate files from the csv files. This goes in a directory | |
| 277 structure:: | |
| 278 | |
| 279 <classname>-files/<N>/<designator> | |
| 280 | |
| 281 where ``<designator>`` is the item's ``<classname><id>`` combination. | |
| 282 The ``<N>`` value is ``int(<id> / 1000)``. | |
| 283 | |
| 284 | |
| 285 Adding A User From The Command-Line | |
| 286 ----------------------------------- | |
| 287 | |
| 288 The ``roundup-admin`` program can create any data you wish to in the | |
| 289 database. To create a new user, use:: | |
| 290 | |
| 291 roundup-admin create user | |
| 292 | |
| 293 To figure out what good values might be for some of the fields (eg. Roles) | |
| 294 you can just display another user:: | |
| 295 | |
| 296 roundup-admin list user | |
| 297 | |
| 298 (or if you know their username, and it happens to be "richard"):: | |
| 299 | |
| 300 roundup-admin find username=richard | |
| 301 | |
| 302 then using the user id you get from one of the above commands, you may | |
| 303 display the user's details:: | |
| 304 | |
| 305 roundup-admin display <userid> | |
| 306 | |
| 307 | |
| 258 Running the Servers | 308 Running the Servers |
| 259 =================== | 309 =================== |
| 260 | 310 |
| 261 Unix | 311 Unix |
| 262 ---- | 312 ---- |