Mercurial > p > roundup > code
comparison doc/features.txt @ 6762:f8ee14436371
Add fts search engines, add more rest doc.
Expand *simple to use* to mention REST and XMLRPC along with html for
web use.
Mention REST can be extended. Also JWT is possible. CORS support as well.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 10 Jul 2022 17:57:50 -0400 |
| parents | 24e2eeb2ed9a |
| children | e7b4ad2c57ac |
comparison
equal
deleted
inserted
replaced
| 6761:65da8d74c06e | 6762:f8ee14436371 |
|---|---|
| 22 enough to get you going | 22 enough to get you going |
| 23 - easy to set up higher-performance storage backends like sqlite_, | 23 - easy to set up higher-performance storage backends like sqlite_, |
| 24 mysql_ and postgresql_ | 24 mysql_ and postgresql_ |
| 25 | 25 |
| 26 *simple to use* | 26 *simple to use* |
| 27 - accessible through the web, email, command-line or Python programs | 27 - accessible through the web (html, REST or XMLRPC), email, |
| 28 command-line or Python programs | |
| 28 - may be used to track bugs, features, user feedback, sales opportunities, | 29 - may be used to track bugs, features, user feedback, sales opportunities, |
| 29 milestones, ... | 30 milestones, ... |
| 30 - automatically keeps a full history of changes to issues with | 31 - automatically keeps a full history of changes to issues with |
| 31 configurable verbosity and easy access to information about who created | 32 configurable verbosity and easy access to information about who created |
| 32 or last modified *any* item in the database | 33 or last modified *any* item in the database |
| 51 with decent response times | 52 with decent response times |
| 52 - database indexes are automatically added for those backends that | 53 - database indexes are automatically added for those backends that |
| 53 support them (sqlite, mysql and postgresql) | 54 support them (sqlite, mysql and postgresql) |
| 54 - indexed text searching giving fast responses to searches across all | 55 - indexed text searching giving fast responses to searches across all |
| 55 messages and indexed string properties | 56 messages and indexed string properties |
| 56 - support for the Xapian or Whoosh full-text indexing engine for large trackers | 57 - support for the Xapian, Whoosh. sqlite or postgres full-text |
| 58 indexing engines for large trackers | |
| 57 | 59 |
| 58 *documented* | 60 *documented* |
| 59 - documentation exists for installation, upgrading, maintenance, users and | 61 - documentation exists for installation, upgrading, maintenance, users and |
| 60 customisation | 62 customisation |
| 61 | 63 |
| 113 available at the /xmlrpc endpoint. | 115 available at the /xmlrpc endpoint. |
| 114 - provides same access to tracker as roundup-admin, but based on | 116 - provides same access to tracker as roundup-admin, but based on |
| 115 XMLRPC calls | 117 XMLRPC calls |
| 116 - see the `xmlrpc guide`_ for more details simple clients etc. | 118 - see the `xmlrpc guide`_ for more details simple clients etc. |
| 117 | 119 |
| 118 *restful interface* | 120 *RESTful interface* |
| 119 - accessible using basic HTTP authentication at /rest starting point | 121 - accessible using basic HTTP authentication at /rest starting point |
| 122 - able to be extended with new endpoints | |
| 123 - authentication can be done using JSON Web Tokens (JWT) | |
| 124 - CORS support for use by third party web pages. | |
| 120 - see the `rest guide`_ for details. | 125 - see the `rest guide`_ for details. |
| 121 | 126 |
| 122 .. _sqlite: http://www.hwaci.com/sw/sqlite/ | 127 .. _sqlite: http://www.hwaci.com/sw/sqlite/ |
| 123 .. _mysql: https://pypi.org/project/MySQL-python/ | 128 .. _mysql: https://pypi.org/project/MySQL-python/ |
| 124 .. _postgresql: https://www.psycopg.org/ | 129 .. _postgresql: https://www.psycopg.org/ |