Skip to content

Commit 7ab4a8f

Browse files
committed
doc: fix platform notes hierarchy; don't use anydbm session db
Linux and Solaris are section headers, but Windows is not. Fix that and move all the windows stuff under the Windows header. Add a section for windows to not use anydbm as the session/otks store. Window only has a dumb dbm written in Python available. gdbm/ndbm compiled backends are not available. So recommend using sqlite or redis for session db if they don't want to spin up mysql/postgresql.
1 parent 19e3d9d commit 7ab4a8f

File tree

1 file changed

+31
-11
lines changed

1 file changed

+31
-11
lines changed

doc/installation.txt

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2124,10 +2124,28 @@ addresses, databases to back up, etc.
21242124
Platform-Specific Notes
21252125
=======================
21262126

2127+
2128+
Windows
2129+
-------
2130+
2131+
.. index:: windows; choose non-default session/otk database
2132+
2133+
Configure session database
2134+
~~~~~~~~~~~~~~~~~~~~~~~~~~
2135+
2136+
By default the session and one time key (OTK) databases default to
2137+
using anydbm as the session store. Because GNU dbm and Ndbm are
2138+
available on Linux, this is a reasonable default. However Windows
2139+
doesn't have compiled libraries for these databases. So it defaults to
2140+
"dumb" dbm which is written in Python and is slow. So we recommend
2141+
using `some other backend for your session database`_. SQLite or Redis
2142+
can be used if you don't want to run a separate supported RDBMS
2143+
database server.
2144+
21272145
.. index:: windows; add Roundup to path
21282146

21292147
Windows command-line tools
2130-
--------------------------
2148+
~~~~~~~~~~~~~~~~~~~~~~~~~~
21312149

21322150
To make the command-line tools accessible in Windows, you need to update
21332151
the "Path" environment variable in the Registry via a dialog box.
@@ -2151,7 +2169,7 @@ Panel" is directly accessible from "Start".
21512169
I do not believe this is possible to do in previous versions of Windows.
21522170

21532171
Use pip to install pyreadline3 for roundup-admin line editing
2154-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2172+
21552173

21562174
If you install pyreadline3_ using pip, roundup-admin will support
21572175
command line editing and history.
@@ -2163,7 +2181,7 @@ This will remove the dreaded::
21632181
warning when starting roundup-admin.
21642182

21652183
Windows Server
2166-
--------------
2184+
~~~~~~~~~~~~~~
21672185

21682186
To have the Roundup web server start up when your machine boots up, there
21692187
are two different methods, the scheduler and installing the service.
@@ -2173,7 +2191,7 @@ are two different methods, the scheduler and installing the service.
21732191
.. _Using the Windows scheduler:
21742192

21752193
1. Using the Windows scheduler
2176-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2194+
''''''''''''''''''''''''''''''
21772195

21782196
Set up the following in Scheduled Tasks (note, the following is for a
21792197
cygwin setup):
@@ -2205,7 +2223,7 @@ Schedule
22052223
.. index:: windows; setup Roundup a service
22062224

22072225
2. Installing the roundup server as a Windows service
2208-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2226+
'''''''''''''''''''''''''''''''''''''''''''''''''''''
22092227

22102228
This is more Windows oriented and will make the Roundup server run as
22112229
soon as the PC starts up without any need for a login or such. It will
@@ -2246,8 +2264,13 @@ If you are using Apache as the webserver you might want to use it with
22462264
mod_python instead to serve out Roundup. In that case see the mod_python
22472265
instructions above for details.
22482266

2267+
Linux
2268+
-----
2269+
2270+
Make sure you read the instructions under `UNIX environment steps`_.
2271+
22492272
Sendmail smrsh
2250-
--------------
2273+
~~~~~~~~~~~~~~
22512274

22522275
If you use Sendmail's ``smrsh`` mechanism, you will need to tell
22532276
smrsh that roundup-mailgw is a valid/trusted mail handler
@@ -2262,11 +2285,6 @@ This is usually done via the following 2 steps:
22622285
2. change your alias to ``"|roundup-mailgw <tracker_home>"``
22632286

22642287

2265-
Linux
2266-
-----
2267-
2268-
Make sure you read the instructions under `UNIX environment steps`_.
2269-
22702288

22712289
Solaris
22722290
-------
@@ -2321,6 +2339,8 @@ the test.
23212339
.. _`preventing spam`: customizing.html#preventing-spam
23222340
.. _`Adding a new field to the classic schema`:
23232341
customizing.html#adding-a-new-field-to-the-classic-schema
2342+
.. _`some other backend for your session database`:
2343+
admin_guide.html#configuring-session-databases
23242344
.. _`Tracking different types of issues`:
23252345
customizing.html#tracking-different-types-of-issues
23262346
.. _`customising roundup`: customizing.html

0 commit comments

Comments
 (0)