Mercurial > p > roundup > code
comparison doc/installation.txt @ 7303:9bd9d06e2f2c
Misc doc fixes.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 07 May 2023 09:28:53 -0400 |
| parents | d2633821fe07 |
| children | ac6403bfcb1f |
comparison
equal
deleted
inserted
replaced
| 7302:d2633821fe07 | 7303:9bd9d06e2f2c |
|---|---|
| 101 This is optional but strongly suggested. | 101 This is optional but strongly suggested. |
| 102 | 102 |
| 103 An RDBMS | 103 An RDBMS |
| 104 Sqlite, MySQL and Postgresql are all supported by Roundup and will be | 104 Sqlite, MySQL and Postgresql are all supported by Roundup and will be |
| 105 used if available. One of these is recommended if you are anticipating a | 105 used if available. One of these is recommended if you are anticipating a |
| 106 large user base (see `choosing your backend`_ below). | 106 large user base (see `choosing your backend`_ below). Sqlite should |
| 107 | 107 always be available. |
| 108 .. index:: roundup-admin:: reindex subcommand | |
| 109 | 108 |
| 110 Xapian full-text indexer | 109 Xapian full-text indexer |
| 111 The Xapian_ full-text indexer is also supported and will be used by | 110 The Xapian_ full-text indexer is also supported and will be used by |
| 112 default if it is available. This is strongly recommended if you are | 111 default if it is available. This is strongly recommended if you are |
| 113 anticipating a large number of issues (> 5000). | 112 anticipating a large number of issues (> 5000). |
| 218 1. `basic installation steps`_ if Roundup is not installed on your system | 217 1. `basic installation steps`_ if Roundup is not installed on your system |
| 219 2. `configuring your first tracker`_ that all installers must follow | 218 2. `configuring your first tracker`_ that all installers must follow |
| 220 3. then optionally `configure a web interface`_ | 219 3. then optionally `configure a web interface`_ |
| 221 4. and optionally `configure an email interface`_ | 220 4. and optionally `configure an email interface`_ |
| 222 5. `UNIX environment steps`_ to take if you're installing on a shared | 221 5. `UNIX environment steps`_ to take if you're installing on a shared |
| 223 UNIX machine and want to restrict local access to roundup | 222 UNIX machine and want to restrict local access to Roundup |
| 224 | 223 |
| 225 For information about how Roundup installs, see the `administration | 224 For information about how Roundup installs, see the `administration |
| 226 guide`_. | 225 guide`_. |
| 227 | 226 |
| 228 The following assumes that you are using the source distribution. | 227 The following assumes that you are using the source distribution. |
| 229 | 228 |
| 230 Basic Installation Steps | 229 Basic Installation Steps |
| 231 ------------------------ | 230 ------------------------ |
| 232 | 231 |
| 233 Installation of Roundup using Python3 in a virtual environment is | 232 Installation of Roundup using Python3 in a virtual environment is |
| 234 probably the path of least resistance. Use:: | 233 recommended. Use:: |
| 235 | 234 |
| 236 python3 -m venv /path/to/environment/roundup | 235 python3 -m venv /path/to/environment/roundup |
| 237 | 236 |
| 238 then proceed as below after activating (assuming a Bourne like shell) | 237 then proceed as below after activating (assuming a Bourne like shell) |
| 239 the Python environment using:: | 238 the Python environment using:: |
| 240 | 239 |
| 241 . /path/to/environment/roundup/bin/activate | 240 . /path/to/environment/roundup/bin/activate |
| 242 | 241 |
| 243 then use the alias ``deactivate`` to return to the normal Python | 242 You can use the alias ``deactivate`` to return to the normal Python |
| 244 environment. If you create the virtual envirnment as a non-root user, | 243 environment. If you create the virtual envirnment as a non-root user, |
| 245 you can install below using the same user. | 244 you can install below using the same user. |
| 246 | 245 |
| 247 To install the Roundup support code into your Python tree and Roundup | 246 To install the Roundup support code into your Python tree and Roundup |
| 248 scripts into /usr/bin (substitute that path for whatever is | 247 scripts into /usr/bin (substitute that path for whatever is |
| 459 | 458 |
| 460 Note: "Back ends" selection list depends on availability of | 459 Note: "Back ends" selection list depends on availability of |
| 461 third-party database modules. Standard python distribution | 460 third-party database modules. Standard python distribution |
| 462 includes anydbm and sqlite module only. | 461 includes anydbm and sqlite module only. |
| 463 | 462 |
| 464 The "support" part of the tracker name can be anything you want - it | 463 The "support" part of the tracker home can be anything you want - it |
| 465 is going to be used as the directory that the tracker information | 464 is the directory where the tracker information will be stored. |
| 466 will be stored in. | |
| 467 | 465 |
| 468 You will now be directed to edit the tracker configuration and | 466 You will now be directed to edit the tracker configuration and |
| 469 initial schema. At a minimum, you must set "tracker :: web", | 467 initial schema. At a minimum, you must set "tracker :: web" |
| 468 (that's the "web" option in the "tracker" section), | |
| 470 "mail :: host", and "mail :: domain". You should also | 469 "mail :: host", and "mail :: domain". You should also |
| 471 set "main :: admin_email" (that's the "admin_email" option in | 470 set "main :: admin_email" to your local admin address to get email |
| 472 the "main" section) to your local admin address to get email | |
| 473 on unusual occurances. If you get stuck, | 471 on unusual occurances. If you get stuck, |
| 474 and get configuration file errors, then see the `tracker | 472 and get configuration file errors, then see the `tracker |
| 475 configuration`_ section of the `customisation documentation`_. | 473 configuration`_ section of the `customisation documentation`_. |
| 476 | 474 |
| 477 If you just want to get set up to test things quickly (and follow | 475 If you just want to get set up to test things quickly (and follow |
| 517 http://localhost:8080/support/ | 515 http://localhost:8080/support/ |
| 518 | 516 |
| 519 and you should see the tracker interface. | 517 and you should see the tracker interface. |
| 520 | 518 |
| 521 To run your tracker on some interface other than 127.0.0.1 and port | 519 To run your tracker on some interface other than 127.0.0.1 and port |
| 522 8080 (make sure you change the "tracker :: web" changes to match) use:: | 520 8080 (make sure you change the "tracker :: web" option to match) use:: |
| 523 | 521 |
| 524 roundup-server -p 1080 -n 0.0.0.0 support=/opt/roundup/trackers/support | 522 roundup-server -p 1080 -n 0.0.0.0 support=/opt/roundup/trackers/support |
| 525 | 523 |
| 526 to run the server at port 1080 and bind to all ip addresses on your system. | 524 to run the server at port 1080 and bind to all ip addresses on your system. |
| 527 Then direct your web browser to ``http://your_host_name:1080/support``. | 525 Then direct your web browser to ``http://your_host_name:1080/support/``. |
| 528 | 526 |
| 529 Choosing Your Template | 527 Choosing Your Template |
| 530 ---------------------- | 528 ---------------------- |
| 531 | 529 |
| 532 Classic Template | 530 Classic Template |