Mercurial > p > roundup > code

comparison website/www/index.txt @ 7478:e8d2a4bca16a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update index. Add "track your issues your way" tag line and... Add description of benefits to some of the noteworthy changes. Add GTD "thing management" from old email in the 1.6 time period. Reverse order of fast gratification so source directory is first then venv install. Match the first line that says you don't have to install.
author John Rouillard <rouilj@ieee.org>
date Sun, 11 Jun 2023 21:32:46 -0400
parents 92fb16035d92
children c550b338616a
comparison
equal deleted inserted replaced
7477:f40626db85dd 7478:e8d2a4bca16a
72 Roundup is a simple-to-use and -install issue-tracking system with 72 Roundup is a simple-to-use and -install issue-tracking system with
73 command-line, web, REST, XML-RPC and e-mail interfaces. It is based 73 command-line, web, REST, XML-RPC and e-mail interfaces. It is based
74 on the winning design from Ka-Ping Yee in the Software Carpentry 74 on the winning design from Ka-Ping Yee in the Software Carpentry
75 "Track" design competition. 75 "Track" design competition.
76 76
77 It is designed to be customised so you can "track your issues your
78 way".
79
77 The current stable version of Roundup is 2.3.0b2. It is a bug fix and 80 The current stable version of Roundup is 2.3.0b2. It is a bug fix and
78 feature release for the 2.2.0 release. 81 feature release for the 2.2.0 release.
79 82
80 It runs with Python 2.7.12+ or 3.6+. 83 It runs with Python 2.7.12+ or 3.6+.
81 84
90 Release Highlights 93 Release Highlights
91 ================== 94 ==================
92 95
93 Some improvements from the 2.2.0 release are: 96 Some improvements from the 2.2.0 release are:
94 97
95 * Dockerfile demo mode implemented. 98 * Dockerfile demo mode implemented. This allows quick evaluation as
99 well as the ability to spin up a configured tracker to customise.
96 100
97 * SQLite backends can use WAL mode to reduce blocking between readers 101 * SQLite backends can use WAL mode to reduce blocking between readers
98 and writers. 102 and writers improving concurrent use.
99 103
100 * Redis can be used for session database with SQLite and dbm 104 * Redis can be used for session database with SQLite and dbm
101 backends. Provides a major performance improvement. 105 backends. Provides a major performance improvement.
102 106
103 * roundup-mailgw can use OAUTH authentication to SMTP 107 * roundup-mailgw can use OAUTH authentication to SMTP
104 server. (roundup-mailgw command line options changed as a result.) 108 server. (roundup-mailgw command line options changed as a result.)
105 109
106 * Postgres full text index can now be enabled. 110 * Postgres full text index can now be enabled.
107 111
108 * Modifications to in-reply-to threading when there are multiple 112 * Modifications to in-reply-to threading when there are multiple
109 matches. 113 matches results in more predictable handling of messages.
110 114
111 * Many updates to documentation to make it scannable, useful and 115 * Many updates to documentation to make it scannable, useful and
112 work on mobile. 116 work on mobile.
113 117
114 * Admin documentation includes a section on setting up Content 118 * Admin documentation includes a section on setting up Content
115 Security Policy (CSP) 119 Security Policy (CSP) to better secure your Roundup trackers.
116 120
117 * REST now allows rate limiting headers to be accessed by client 121 * REST now allows rate limiting headers to be accessed by client
118 JavaScript. 122 JavaScript.
119 123
120 * Default number of rounds for PBKDF2 updated to 2M to account for 124 * Default number of rounds for PBKDF2 updated to 2M to account for
121 improvements in password crackers and CPU power. 125 improvements in password crackers and CPU power.
122 126
123 * Support PBKDF2 with SHA512 for password storage 127 * Support PBKDF2 with SHA512 for password storage to improve
128 resistance to password crackers.
124 129
125 * Deprecate SSHA password hash function. 130 * Deprecate SSHA password hash function.
126 131
127 * roundup-admin reindex can be done in batches to manage load 132 * roundup-admin reindex can be done in batches to manage load
128 incurred by reindexing. 133 incurred by reindexing.
129 134
130 * roundup-admin can list available templates and their installed 135 * roundup-admin can list available templates and their installed
131 locations. 136 locations. This is useful when installing via pip or in a docker
132 137 container as supporting files are not stored in the usual locations
133 * Crash fixes in detector handling, configuration handling, 138 like /usr/share/roundup.
134 139
135 More info on the 51 changes can be found in the `change note`_. 140 * Crash fixes in detector handling and configuration handling.
141
142 More info on the 51 changes can be found in the `change notes`_.
136 143
137 Roundup Use Cases 144 Roundup Use Cases
138 ================= 145 =================
139 146
140 For more information on Roundup see the :doc:`features list 147 For more information on Roundup see the :doc:`features list
148 issue trackers) 155 issue trackers)
149 * issue management for IETF working groups 156 * issue management for IETF working groups
150 * sales lead tracking 157 * sales lead tracking
151 * conference paper submission and double-blind referee 158 * conference paper submission and double-blind referee
152 management 159 management
153 * weblogging (well, almost :) 160 * weblogging (well, almost :)
161 * thing management using the `GTD methodology <https://gettingthingsdone.com/>`_.
154 162
155 ...and so on. It's been designed with :doc:`flexibility 163 ...and so on. It's been designed with :doc:`flexibility
156 <docs/customizing>` in mind - it's not just another bug 164 <docs/customizing>` in mind - it's not just another bug
157 tracker. 165 tracker.
158 166
162 170
163 Roundup ships with a **demo tracker** to play with - you don't need to 171 Roundup ships with a **demo tracker** to play with - you don't need to
164 install Roundup. After you've unpacked the source, just run "``python 172 install Roundup. After you've unpacked the source, just run "``python
165 demo.py``" and load up the URL it prints out! 173 demo.py``" and load up the URL it prints out!
166 174
167 You can install using a virtual environment with pip by: 175 Follow the source gratification mode with these steps (change the
176 ``-2.3.0`` version identifier to match your downloaded file).
177
178 1. ``python3 -m pip download roundup``
179 2. ``tar -xzvf roundup-2.3.0.tar.gz``
180
181 * if you don't have a tar command (e.g windows), use:
182 ``python -c 'import tarfile; tarfile.open(sys.argv[1]).extractall();' roundup-2.3.0.tar.gz``
183
184
185 3. ``cd roundup-2.3.0``
186 4. ``python3 demo.py``
187
188 (The source download can also be used to create a custom Docker
189 image.)
190
191 Alternatively, you can install using a virtual environment with pip
192 by:
168 193
169 1. create a virtual environment with:: 194 1. create a virtual environment with::
170 195
171 python3 -m venv roundup 196 python3 -m venv roundup
172 197
188 5. load the URL printed by the demo tracker 213 5. load the URL printed by the demo tracker
189 214
190 6. when you are done, use `deactivate` to return your shell to using 215 6. when you are done, use `deactivate` to return your shell to using
191 the system python. 216 the system python.
192 217
193 Or choose the source directory gratification mode to run the demo
194 with these steps (change the ``-2.2.0`` version identifier to match
195 your downloaded file).
196
197 1. ``python3 -m pip download roundup``
198 2. ``tar -xzvf roundup-2.2.0.tar.gz``
199
200 * if you don't have a tar command, ``python -c 'import tarfile, sys; tarfile.open(sys.argv[1]).extractall();' roundup-2.2.0.tar.gz`` can be used.
201
202 3. ``cd roundup-2.2.0``
203 4. ``python3 demo.py``
204
205 Both of these methods produce the same result. 218 Both of these methods produce the same result.
206
207 (The source download can also be used to create a Docker image.)
208 219
209 Origin Story 220 Origin Story
210 ============ 221 ============
211 Roundup was originally released as version 0.1.1 in late August, 2001. 222 Roundup was originally released as version 0.1.1 in late August, 2001.
212 The first `change note`_ written said: 223 The first `change note`_ written said:
214 Needed a bug tracking system. Looked around. Tried to install many Perl-based systems, to no avail. 225 Needed a bug tracking system. Looked around. Tried to install many Perl-based systems, to no avail.
215 Got tired of waiting for Roundup to be released. Had just finished major product project, so needed 226 Got tired of waiting for Roundup to be released. Had just finished major product project, so needed
216 something different for a while. Roundup here I come... 227 something different for a while. Roundup here I come...
217 228
218 .. _`download`: https://pypi.org/project/roundup/ 229 .. _`download`: https://pypi.org/project/roundup/
230 .. _`change notes`: https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt
219 .. _`change note`: https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt 231 .. _`change note`: https://sourceforge.net/p/roundup/code/ci/tip/tree/CHANGES.txt
220 .. _`its own set of docs`: https://www.roundup-tracker.org/dev-docs/docs.html 232 .. _`its own set of docs`: https://www.roundup-tracker.org/dev-docs/docs.html
Roundup Issue Tracker: http://roundup-tracker.org/