Mercurial > p > roundup > code
comparison doc/installation.txt @ 7608:cdc7490f510e
docs: add mention of pyreadline3 under windows
adds support for CLI editing/history under windows.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Thu, 17 Aug 2023 13:33:53 -0400 |
| parents | 7515d03fb26d |
| children | 044dea25c1e2 |
comparison
equal
deleted
inserted
replaced
| 7607:bb443db61d1c | 7608:cdc7490f510e |
|---|---|
| 281 are not supported. | 281 are not supported. |
| 282 | 282 |
| 283 Windows Service | 283 Windows Service |
| 284 You can run Roundup as a Windows service if pywin32_ is installed. | 284 You can run Roundup as a Windows service if pywin32_ is installed. |
| 285 Otherwise it must be started manually. | 285 Otherwise it must be started manually. |
| 286 | |
| 287 pyreadline3 | |
| 288 When running roundup-admin on windows, installing pyreadline3_ will | |
| 289 allow history and editing on the command line. | |
| 286 | 290 |
| 287 requests | 291 requests |
| 288 If you are using OAuth authentication with the roundup-mailgw | 292 If you are using OAuth authentication with the roundup-mailgw |
| 289 mail gateway you must install the requests_ library. | 293 mail gateway you must install the requests_ library. |
| 290 | 294 |
| 2101 I understand that in XP, 2) above is not needed as "Control | 2105 I understand that in XP, 2) above is not needed as "Control |
| 2102 Panel" is directly accessible from "Start". | 2106 Panel" is directly accessible from "Start". |
| 2103 | 2107 |
| 2104 I do not believe this is possible to do in previous versions of Windows. | 2108 I do not believe this is possible to do in previous versions of Windows. |
| 2105 | 2109 |
| 2110 Use pip to install pyreadline3 for roundup-admin line editing | |
| 2111 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 2112 | |
| 2113 If you install pyreadline3_ using pip, roundup-admin will support | |
| 2114 command line editing and history. | |
| 2115 | |
| 2116 This will remove the dreaded:: | |
| 2117 | |
| 2118 Note: command history and editing not available | |
| 2119 | |
| 2120 warning when starting roundup-admin. | |
| 2106 | 2121 |
| 2107 Windows Server | 2122 Windows Server |
| 2108 -------------- | 2123 -------------- |
| 2109 | 2124 |
| 2110 To have the Roundup web server start up when your machine boots up, there | 2125 To have the Roundup web server start up when your machine boots up, there |
| 2185 automatically instead of manually. | 2200 automatically instead of manually. |
| 2186 | 2201 |
| 2187 If you are using Apache as the webserver you might want to use it with | 2202 If you are using Apache as the webserver you might want to use it with |
| 2188 mod_python instead to serve out Roundup. In that case see the mod_python | 2203 mod_python instead to serve out Roundup. In that case see the mod_python |
| 2189 instructions above for details. | 2204 instructions above for details. |
| 2190 | |
| 2191 | 2205 |
| 2192 Sendmail smrsh | 2206 Sendmail smrsh |
| 2193 -------------- | 2207 -------------- |
| 2194 | 2208 |
| 2195 If you use Sendmail's ``smrsh`` mechanism, you will need to tell | 2209 If you use Sendmail's ``smrsh`` mechanism, you will need to tell |
| 2294 .. _MySQLdb: https://pypi.org/project/mysqlclient/ | 2308 .. _MySQLdb: https://pypi.org/project/mysqlclient/ |
| 2295 .. _Olson tz database: https://www.iana.org/time-zones | 2309 .. _Olson tz database: https://www.iana.org/time-zones |
| 2296 .. _Psycopg2: https://www.psycopg.org/ | 2310 .. _Psycopg2: https://www.psycopg.org/ |
| 2297 .. _pyjwt: https://pypi.org/project/PyJWT/ | 2311 .. _pyjwt: https://pypi.org/project/PyJWT/ |
| 2298 .. _pyopenssl: https://pypi.org/project/pyOpenSSL/ | 2312 .. _pyopenssl: https://pypi.org/project/pyOpenSSL/ |
| 2313 .. _pyreadline3: https://pypi.org/project/pyreadline3/ | |
| 2299 .. _pysqlite: https://pysqlite.org/ | 2314 .. _pysqlite: https://pysqlite.org/ |
| 2300 .. _pytz: https://pypi.org/project/pytz/ | 2315 .. _pytz: https://pypi.org/project/pytz/ |
| 2301 .. _pywin32: https://pypi.org/project/pywin32/ | 2316 .. _pywin32: https://pypi.org/project/pywin32/ |
| 2302 .. _Redis: https://redis.io | 2317 .. _Redis: https://redis.io |
| 2303 .. _redis-py: https://pypi.org/project/redis/ | 2318 .. _redis-py: https://pypi.org/project/redis/ |