Skip to content

Commit 44e5ca8

Browse files
author
Richard Jones
committed
doc updates
1 parent 2cb2292 commit 44e5ca8

File tree

2 files changed

+36
-2
lines changed

2 files changed

+36
-2
lines changed

doc/FAQ.txt

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Roundup FAQ
33
===========
44

5-
:Version: $Revision: 1.21 $
5+
:Version: $Revision: 1.22 $
66

77
.. contents::
88

@@ -94,6 +94,13 @@ following should be useful as a starting template::
9494
</IfModule>
9595

9696

97+
How do I run Roundup through SSL (HTTPS)?
98+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99+
100+
You should proxy through apache and use its SSL service. See the previous
101+
question on how to proxy through apache.
102+
103+
97104
Roundup runs very slowly on my XP machine when accessed from the Internet
98105
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
99106

doc/admin_guide.txt

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Administration Guide
33
====================
44

5-
:Version: $Revision: 1.16 $
5+
:Version: $Revision: 1.17 $
66

77
.. contents::
88

@@ -67,6 +67,7 @@ Configuration for "BasicLogging" implementation:
6767
In both cases, if no logfile is specified then logging will simply be sent
6868
to sys.stderr with only logging of ERROR messages.
6969

70+
7071
Configuring roundup-server
7172
==========================
7273

@@ -163,6 +164,7 @@ Maintenance of Roundup can involve one of the following:
163164
2. `software upgrade`_
164165
3. `migrating backends`_
165166
4. `moving a tracker`_
167+
5. `migrating from other software`_
166168

167169

168170
Tracker Backup
@@ -255,6 +257,31 @@ moved using the above steps) then you'll need to:
255257
6. start the tracker web and email frontends on the new machine.
256258

257259

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+
258285
Running the Servers
259286
===================
260287

0 commit comments

Comments
 (0)