Mercurial > p > roundup > code
comparison doc/installation.txt @ 1218:4c9882cb16a3
more docco work
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Thu, 26 Sep 2002 00:02:24 +0000 |
| parents | af104fa52746 |
| children | 778297033003 |
comparison
equal
deleted
inserted
replaced
| 1217:984c498e7deb | 1218:4c9882cb16a3 |
|---|---|
| 1 ================== | 1 ================== |
| 2 Installing Roundup | 2 Installing Roundup |
| 3 ================== | 3 ================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.24 $ | 5 :Version: $Revision: 1.25 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 | 9 |
| 10 Overview | 10 Overview |
| 41 The actual storage of Roundup tracker information is handled by backends. | 41 The actual storage of Roundup tracker information is handled by backends. |
| 42 There's several to choose from, each with benefits and limitations: | 42 There's several to choose from, each with benefits and limitations: |
| 43 | 43 |
| 44 **anydbm** | 44 **anydbm** |
| 45 This backend is guaranteed to work on any system that Python runs on. It | 45 This backend is guaranteed to work on any system that Python runs on. It |
| 46 will generally choose the best *dbm backend that is available on your system | 46 will generally choose the best dbm backend that is available on your system |
| 47 (from the list dbhash, gdbm, dbm, dumbdbm). It is the least scaleable of all | 47 (from the list dbhash, gdbm, dbm, dumbdbm). It is the least scaleable of all |
| 48 backends, but performs well enough for a smallish tracker (a couple of | 48 backends, but performs well enough for a smallish tracker (a couple of |
| 49 thousand issues, under fifty users, ...). | 49 thousand issues, under fifty users, ...). |
| 50 **bsddb** | 50 **bsddb** |
| 51 This effectively the same as anydbm, but uses the bsddb backend. This allows | 51 This effectively the same as anydbm, but uses the bsddb backend. This allows |
| 53 **bsddb3** | 53 **bsddb3** |
| 54 Again, this effectively the same as anydbm, but uses the bsddb3 backend. | 54 Again, this effectively the same as anydbm, but uses the bsddb3 backend. |
| 55 This allows it to gain some performance and scaling benefits. | 55 This allows it to gain some performance and scaling benefits. |
| 56 **sqlite** | 56 **sqlite** |
| 57 This uses the SQLite embedded RDBMS to provide a fast, scaleable backend. | 57 This uses the SQLite embedded RDBMS to provide a fast, scaleable backend. |
| 58 There are no limitations. | 58 There are no limitations, and it's much faster and more scaleable than the |
| 59 dbm backends. | |
| 59 **gadfly** | 60 **gadfly** |
| 60 This is a proof-of-concept relational database backend, not really intended | 61 This is a proof-of-concept relational database backend, not really intended |
| 61 for actual production use, although it can be. It uses the Gadfly RDBMS | 62 for actual production use, although it can be. It uses the Gadfly RDBMS |
| 62 to store data. It is unable to perform string searches due to gadfly not | 63 to store data. It is unable to perform string searches due to gadfly not |
| 63 having a LIKE operation. It should scale well, assuming a client/server | 64 having a LIKE operation. It should scale well, assuming a client/server |
| 64 setup is used. | 65 setup is used. |
| 65 **metakit** | 66 **metakit** |
| 66 This backend is implemented over the metakit storage system, using Mk4Py as | 67 This backend is implemented over the metakit storage system, using Mk4Py as |
| 67 the interface. It scales much better than the *dbm backends, but has some | 68 the interface. It scales much better than the dbm backends, but has some |
| 68 missing features: | 69 missing features: |
| 69 | 70 |
| 70 - you may not unset properties once they are set | 71 - you may not unset properties once they are set |
| 71 - journal retrieval is not implemented | 72 - journal retrieval is not implemented |
| 72 | 73 |
| 74 | |
| 75 Note: you may set your tracker up with the anydbm backend (which is guaranteed | |
| 76 to be available) and switch to one of the other backends at any time using the | |
| 77 instructions in the `maintenance documentation`_. | |
| 73 | 78 |
| 74 Prerequisites | 79 Prerequisites |
| 75 ============= | 80 ============= |
| 76 | 81 |
| 77 Python 2.1.1 or newer with a functioning anydbm or bsddb module. Download the | 82 Python 2.1.1 or newer with a functioning anydbm or bsddb module. Download the |
| 312 .. _`table of contents`: index.html | 317 .. _`table of contents`: index.html |
| 313 .. _`getting started`: getting_started.html | 318 .. _`getting started`: getting_started.html |
| 314 .. _`roundup specification`: spec.html | 319 .. _`roundup specification`: spec.html |
| 315 .. _`customising roundup`: customizing.html | 320 .. _`customising roundup`: customizing.html |
| 316 .. _`upgrading document`: upgrading.html | 321 .. _`upgrading document`: upgrading.html |
| 317 | 322 .. _`maintenance documentation`: maintenance.html |
| 323 |