Mercurial > p > roundup > code
comparison doc/installation.txt @ 7438:116ea5ce06ab
issue2551269: Add warning abut Python 2 support lifetime
GitHub CI no longer supports python2.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Tue, 30 May 2023 14:47:10 -0400 |
| parents | deb8e7e6d66d |
| children | e7df82ae137d |
comparison
equal
deleted
inserted
replaced
| 7437:0d9f704a7ef2 | 7438:116ea5ce06ab |
|---|---|
| 170 can remove the tracker using ``rm -f`` on the ``demo`` directory. | 170 can remove the tracker using ``rm -f`` on the ``demo`` directory. |
| 171 | 171 |
| 172 Prerequisites | 172 Prerequisites |
| 173 ============= | 173 ============= |
| 174 | 174 |
| 175 Roundup requires Python 2.7 or 3.6 or newer with a functioning anydbm | 175 Roundup requires Python 2.7 [3]_ or 3.6 or newer with a functioning anydbm |
| 176 or sqlite module. The version installed by most vendors should work if | 176 or sqlite module. The version installed by most vendors should work if |
| 177 it meets the version requirements. If necessary, you can download the | 177 it meets the version requirements. If necessary, you can download the |
| 178 latest version from https://www.python.org/. It is highly recommended | 178 latest version from https://www.python.org/. It is highly recommended |
| 179 that users install the latest patch version of Python as these contain | 179 that users install the latest patch version of Python as these contain |
| 180 many fixes to serious bugs. | 180 many fixes to serious bugs. |
| 285 If you are using OAuth authentication with the roundup-mailgw | 285 If you are using OAuth authentication with the roundup-mailgw |
| 286 mail gateway you must install the requests_ library. | 286 mail gateway you must install the requests_ library. |
| 287 | 287 |
| 288 .. _Using Redis for Session Databases: | 288 .. _Using Redis for Session Databases: |
| 289 admin_guide.html#using-redis-for-session-databases | 289 admin_guide.html#using-redis-for-session-databases |
| 290 | |
| 291 .. [3] Do not use Python 2 for new installs. The continuous | |
| 292 integration and other services used for developing Roundup | |
| 293 are dropping support for Python 2. Also optional packages | |
| 294 are dropping Python 2 support. As a result Python 2 may | |
| 295 not be supported for many more release cycles. | |
| 290 | 296 |
| 291 Installing Roundup | 297 Installing Roundup |
| 292 ================== | 298 ================== |
| 293 | 299 |
| 294 To get a production installation running will take 15-30 minutes. If | 300 To get a production installation running will take 15-30 minutes. If |
| 476 | 482 |
| 477 2. At this point, your tracker is set up, but doesn't have a nice user | 483 2. At this point, your tracker is set up, but doesn't have a nice user |
| 478 interface. To set that up, we need to `configure a web interface`_ and | 484 interface. To set that up, we need to `configure a web interface`_ and |
| 479 optionally `configure an email interface`_. If you want to try your | 485 optionally `configure an email interface`_. If you want to try your |
| 480 new tracker out, assuming the ``web`` setting in the | 486 new tracker out, assuming the ``web`` setting in the |
| 481 ``[tracker]`` [3]_ section of config.ini is set to | 487 ``[tracker]`` [4]_ section of config.ini is set to |
| 482 ``'http://localhost:8080/support/'``, run:: | 488 ``'http://localhost:8080/support/'``, run:: |
| 483 | 489 |
| 484 roundup-server support=/opt/roundup/trackers/support | 490 roundup-server support=/opt/roundup/trackers/support |
| 485 | 491 |
| 486 then direct your web browser at: | 492 then direct your web browser at: |
| 495 roundup-server -p 1080 -n 0.0.0.0 support=/opt/roundup/trackers/support | 501 roundup-server -p 1080 -n 0.0.0.0 support=/opt/roundup/trackers/support |
| 496 | 502 |
| 497 to run the server at port 1080 and bind to all ip addresses on your system. | 503 to run the server at port 1080 and bind to all ip addresses on your system. |
| 498 Then direct your web browser to ``http://your_host_name:1080/support/``. | 504 Then direct your web browser to ``http://your_host_name:1080/support/``. |
| 499 | 505 |
| 500 .. [3] The rest of the documentation uses the abbreviated form "tracker :: | 506 .. [4] The rest of the documentation uses the abbreviated form "tracker :: |
| 501 web" for specifying a section and setting. | 507 web" for specifying a section and setting. |
| 502 | 508 |
| 503 Choosing Your Template | 509 Choosing Your Template |
| 504 ---------------------- | 510 ---------------------- |
| 505 | 511 |