Mercurial > p > roundup > code

comparison doc/installation.txt @ 7887:35b4049ea2ad

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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.
author John Rouillard <rouilj@ieee.org>
date Thu, 18 Apr 2024 20:55:51 -0400
parents bd126f890279
children e3975f679bf1
comparison
equal deleted inserted replaced
7886:2946354d6ccd 7887:35b4049ea2ad
2122 2122
2123 2123
2124 Platform-Specific Notes 2124 Platform-Specific Notes
2125 ======================= 2125 =======================
2126 2126
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
2127 .. index:: windows; add Roundup to path 2145 .. index:: windows; add Roundup to path
2128 2146
2129 Windows command-line tools 2147 Windows command-line tools
2130 -------------------------- 2148 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2131 2149
2132 To make the command-line tools accessible in Windows, you need to update 2150 To make the command-line tools accessible in Windows, you need to update
2133 the "Path" environment variable in the Registry via a dialog box. 2151 the "Path" environment variable in the Registry via a dialog box.
2134 2152
2135 On Windows 2000 and later: 2153 On Windows 2000 and later:
2149 Panel" is directly accessible from "Start". 2167 Panel" is directly accessible from "Start".
2150 2168
2151 I do not believe this is possible to do in previous versions of Windows. 2169 I do not believe this is possible to do in previous versions of Windows.
2152 2170
2153 Use pip to install pyreadline3 for roundup-admin line editing 2171 Use pip to install pyreadline3 for roundup-admin line editing
2154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2172
2155 2173
2156 If you install pyreadline3_ using pip, roundup-admin will support 2174 If you install pyreadline3_ using pip, roundup-admin will support
2157 command line editing and history. 2175 command line editing and history.
2158 2176
2159 This will remove the dreaded:: 2177 This will remove the dreaded::
2161 Note: command history and editing not available 2179 Note: command history and editing not available
2162 2180
2163 warning when starting roundup-admin. 2181 warning when starting roundup-admin.
2164 2182
2165 Windows Server 2183 Windows Server
2166 -------------- 2184 ~~~~~~~~~~~~~~
2167 2185
2168 To have the Roundup web server start up when your machine boots up, there 2186 To have the Roundup web server start up when your machine boots up, there
2169 are two different methods, the scheduler and installing the service. 2187 are two different methods, the scheduler and installing the service.
2170 2188
2171 .. index:: windows; use scheduler for email integration 2189 .. index:: windows; use scheduler for email integration
2172 2190
2173 .. _Using the Windows scheduler: 2191 .. _Using the Windows scheduler:
2174 2192
2175 1. Using the Windows scheduler 2193 1. Using the Windows scheduler
2176 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2194 ''''''''''''''''''''''''''''''
2177 2195
2178 Set up the following in Scheduled Tasks (note, the following is for a 2196 Set up the following in Scheduled Tasks (note, the following is for a
2179 cygwin setup): 2197 cygwin setup):
2180 2198
2181 Run 2199 Run
2203 2221
2204 2222
2205 .. index:: windows; setup Roundup a service 2223 .. index:: windows; setup Roundup a service
2206 2224
2207 2. Installing the roundup server as a Windows service 2225 2. Installing the roundup server as a Windows service
2208 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 2226 '''''''''''''''''''''''''''''''''''''''''''''''''''''
2209 2227
2210 This is more Windows oriented and will make the Roundup server run as 2228 This is more Windows oriented and will make the Roundup server run as
2211 soon as the PC starts up without any need for a login or such. It will 2229 soon as the PC starts up without any need for a login or such. It will
2212 also be available in the normal Windows Administrative Tools. 2230 also be available in the normal Windows Administrative Tools.
2213 2231
2244 2262
2245 If you are using Apache as the webserver you might want to use it with 2263 If you are using Apache as the webserver you might want to use it with
2246 mod_python instead to serve out Roundup. In that case see the mod_python 2264 mod_python instead to serve out Roundup. In that case see the mod_python
2247 instructions above for details. 2265 instructions above for details.
2248 2266
2267 Linux
2268 -----
2269
2270 Make sure you read the instructions under `UNIX environment steps`_.
2271
2249 Sendmail smrsh 2272 Sendmail smrsh
2250 -------------- 2273 ~~~~~~~~~~~~~~
2251 2274
2252 If you use Sendmail's ``smrsh`` mechanism, you will need to tell 2275 If you use Sendmail's ``smrsh`` mechanism, you will need to tell
2253 smrsh that roundup-mailgw is a valid/trusted mail handler 2276 smrsh that roundup-mailgw is a valid/trusted mail handler
2254 before it will work. 2277 before it will work.
2255 2278
2259 which points to the full path of your actual ``roundup-mailgw`` 2282 which points to the full path of your actual ``roundup-mailgw``
2260 script. 2283 script.
2261 2284
2262 2. change your alias to ``"|roundup-mailgw <tracker_home>"`` 2285 2. change your alias to ``"|roundup-mailgw <tracker_home>"``
2263 2286
2264
2265 Linux
2266 -----
2267
2268 Make sure you read the instructions under `UNIX environment steps`_.
2269 2287
2270 2288
2271 Solaris 2289 Solaris
2272 ------- 2290 -------
2273 2291
2319 .. _`Roundup reference`: reference.html 2337 .. _`Roundup reference`: reference.html
2320 .. _`reference documentation`: reference.html 2338 .. _`reference documentation`: reference.html
2321 .. _`preventing spam`: customizing.html#preventing-spam 2339 .. _`preventing spam`: customizing.html#preventing-spam
2322 .. _`Adding a new field to the classic schema`: 2340 .. _`Adding a new field to the classic schema`:
2323 customizing.html#adding-a-new-field-to-the-classic-schema 2341 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
2324 .. _`Tracking different types of issues`: 2344 .. _`Tracking different types of issues`:
2325 customizing.html#tracking-different-types-of-issues 2345 customizing.html#tracking-different-types-of-issues
2326 .. _`customising roundup`: customizing.html 2346 .. _`customising roundup`: customizing.html
2327 .. _`upgrading document`: upgrading.html 2347 .. _`upgrading document`: upgrading.html
2328 .. _`administration guide`: admin_guide.html 2348 .. _`administration guide`: admin_guide.html
Roundup Issue Tracker: http://roundup-tracker.org/