Mercurial > p > roundup > code

comparison doc/features.txt @ 8545:695399dea532

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: provide card look for "sections" on features page. Make each section on the features page look like a raised card. Note the sections aren't headers 8-(. The markup is: .. container:: card **pseudo header** - list stuff .. container:: card I can't put: pseudo header ============= in there even though each card is its own section. I would like to have real headers for them (allow text->speech and othr devices easiera access). Starting a header in column 1 seems to be a requirement of the syntax 8-(.
author John Rouillard <rouilj@ieee.org>
date Wed, 25 Mar 2026 11:37:03 -0400
parents a0f9ef08c36c
children
comparison
equal deleted inserted replaced
8544:e738377b4ffe 8545:695399dea532
11 Roundup is an easy-to-use and -install issue-tracking system with 11 Roundup is an easy-to-use and -install issue-tracking system with
12 web, e-mail and command-line interfaces. Based on the winning design 12 web, e-mail and command-line interfaces. Based on the winning design
13 from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design 13 from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design
14 competition. 14 competition.
15 15
16 **Installation and Setup** 16 .. container:: card
17 17
18 - Start using the software in `instant-gratification (demo) mode`_ with 18 **Installation and Setup**
19 ``python demo.py`` or `a Docker container`_ in under 5 minutes.
20 - Choose from `five included templates`_ for your tracker.
21 - `Customize`_ and use the demo as a template for your production tracker.
22 - No need for additional support software, just Python (3.7+)
23 to get started.
24 - Basic installation (including a web interface) takes about 30 minutes.
25 - Supports embedded databases like `SQLite`_ and dbm. Upgradable
26 to databases like `MySQL`_ or `PostgreSQL`_ if needed.
27 - Can be run in a container like Docker or kubernetes.
28 - Deploy in your network as a standalone web server or `through
29 various methods`_ like WSGI, FastCGI, plain CGI, etc.
30 - Essential tracking features depend on the Python standard
31 library. Supplementary packages from PyPI are optional and can be
32 tailored to fit your unique threat model and security needs.
33 19
34 **Issue Tracking and Management** 20 - Start using the software in `instant-gratification (demo) mode`_ with
21 ``python demo.py`` or `a Docker container`_ in under 5 minutes.
22 - Choose from `five included templates`_ for your tracker.
23 - `Customize`_ and use the demo as a template for your production tracker.
24 - No need for additional support software, just Python (3.7+)
25 to get started.
26 - Basic installation (including a web interface) takes about 30 minutes.
27 - Supports embedded databases like `SQLite`_ and dbm. Upgradable
28 to databases like `MySQL`_ or `PostgreSQL`_ if needed.
29 - Can be run in a container like Docker or kubernetes.
30 - Deploy in your network as a standalone web server or `through
31 various methods`_ like WSGI, FastCGI, plain CGI, etc.
32 - Essential tracking features depend on the Python standard
33 library. Supplementary packages from PyPI are optional and can be
34 tailored to fit your unique threat model and security needs.
35 35
36 - Manage your issues your way. Handle bugs, features, milestones, 36 .. container:: card
37 user feedback, fleet maintenance, office issues etc.
38 - Issues become a mini mailing list to keep everyone informed.
39 - Searches on specific properties (e.g. open issues with a high
40 priority) can be saved and reused or shared with other users.
41 - Full Text Search for quick searches across messages.
42 - Keeps a detailed history of issue changes.
43 - Email is a first class method for interacting with issues.
44 37
45 **Scalability and Performance** 38 **Issue Tracking and Management**
46 39
47 - Default trackers use simple HTML with low resource requirements. 40 - Manage your issues your way. Handle bugs, features, milestones,
48 - Fast and scalable with sqlite, mysql, and postgresql backends. 41 user feedback, fleet maintenance, office issues etc.
49 - Indexes are automatically configured. 42 - Issues become a mini mailing list to keep everyone informed.
50 - Supports full-text indexing engines (xapian, whoosh, SQLite, 43 - Searches on specific properties (e.g. open issues with a high
51 PostgreSQL) for large trackers. 44 priority) can be saved and reused or shared with other users.
45 - Full Text Search for quick searches across messages.
46 - Keeps a detailed history of issue changes.
47 - Email is a first class method for interacting with issues.
52 48
53 **Customization** 49 .. container:: card
54 50
55 - The database schema can be updated to `track additional data`_. 51 **Scalability and Performance**
56 - The web interface can be redesigned to fit your workflow.
57 - Extensible web interface with various features like `wizards`_,
58 bug displays, etc.
59 - Add business rules using `auditors and reactors`_ for actions before
60 and after database changes.
61 - Comprehensive documentation for customization, installation,
62 maintenance, and user guidance.
63 52
64 **Data Security, Privacy and Authorization** 53 - Default trackers use simple HTML with low resource requirements.
54 - Fast and scalable with sqlite, mysql, and postgresql backends.
55 - Indexes are automatically configured.
56 - Supports full-text indexing engines (xapian, whoosh, SQLite,
57 PostgreSQL) for large trackers.
65 58
66 - Your data remains on your servers. 59 .. container:: card
67 - You can choose if AI can access the data. 60
68 - Can use HTTPS for security over the web. 61 **Customization**
69 - Fine-grained authorization (`ABAC`_, `ReBAC`_, `RBAC`_) based on 62
70 user, resource, and external properties. 63 - The database schema can be updated to `track additional data`_.
64 - The web interface can be redesigned to fit your workflow.
65 - Extensible web interface with various features like `wizards`_,
66 bug displays, etc.
67 - Add business rules using `auditors and reactors`_ for actions before
68 and after database changes.
69 - Comprehensive documentation for customization, installation,
70 maintenance, and user guidance.
71
72 .. container:: card
73
74 **Data Security, Privacy and Authorization**
75
76 - Your data remains on your servers.
77 - You can choose if AI can access the data.
78 - Can use HTTPS for security over the web.
79 - Fine-grained authorization (`ABAC`_, `ReBAC`_, `RBAC`_) based on
80 user, resource, and external properties.
71 81
72 .. _`ABAC`: https://en.wikipedia.org/wiki/Attribute-based_access_control 82 .. _`ABAC`: https://en.wikipedia.org/wiki/Attribute-based_access_control
73 .. _`ReBAC`: https://en.wikipedia.org/wiki/Relationship-based_access_control 83 .. _`ReBAC`: https://en.wikipedia.org/wiki/Relationship-based_access_control
74 .. _`RBAC`: https://en.wikipedia.org/wiki/Role-based_access_control 84 .. _`RBAC`: https://en.wikipedia.org/wiki/Role-based_access_control
75 85
76 **Documentation and User Management** 86 .. container:: card
77 87
78 - Users can sign up through the web interface or new user creation 88 **Documentation and User Management**
79 can be limited to admin users.
80 - Can use an `external user database`_ (LDAP, password file)
81 - Self-serve password reset for users via email.
82 89
83 **Email Integration and Automation** 90 - Users can sign up through the web interface or new user creation
91 can be limited to admin users.
92 - Can use an `external user database`_ (LDAP, password file)
93 - Self-serve password reset for users via email.
84 94
85 - Update issues via email with new messages and the ability to 95 .. container:: card
86 change properties of issues (e.g. close an issue).
87 - Secure email handling with features like TLS, APOP, IMAPS/OAUTH.
88 - Optional auto-registration for email users.
89 - Configurable nosy list for each issue controls email notifications.
90 - Proper handling of email attachments and content types.
91 96
92 **Command-Line and API Access** 97 **Email Integration and Automation**
93 98
94 - Manage database interactively from the command line. 99 - Update issues via email with new messages and the ability to
95 - Automate modifications using standard shell scripting. 100 change properties of issues (e.g. close an issue).
96 - Python programs can use the Roundup Python API to manage/automate issues. 101 - Secure email handling with features like TLS, APOP, IMAPS/OAUTH.
97 - Sample scripts provided for various tasks. 102 - Optional auto-registration for email users.
103 - Configurable nosy list for each issue controls email notifications.
104 - Proper handling of email attachments and content types.
98 105
99 **Remote Access Interfaces** 106 .. container:: card
100 107
101 - `RESTful API`_ accessible with basic HTTP authentication or optional JWT. 108 **Command-Line and API Access**
102 - `XMLRPC interface`_ for remote tracker access with basic 109
103 HTTP authentication. 110 - Manage database interactively from the command line.
104 - Configurable CORS support for third-party web pages. 111 - Automate modifications using standard shell scripting.
105 - Ability to `generate and authenticate JSON Web Tokens (JWT) 112 - Python programs can use the Roundup Python API to manage/automate issues.
106 <rest.html#changing-access-roles-with-json-web-tokens>`_. 113 - Sample scripts provided for various tasks.
114
115 .. container:: card
116
117 **Remote Access Interfaces**
118
119 - `RESTful API`_ accessible with basic HTTP authentication or optional JWT.
120 - `XMLRPC interface`_ for remote tracker access with basic
121 HTTP authentication.
122 - Configurable CORS support for third-party web pages.
123 - Ability to `generate and authenticate JSON Web Tokens (JWT)
124 <rest.html#changing-access-roles-with-json-web-tokens>`_.
107 125
108 .. _`auditors and reactors`: reference.html#auditor-or-reactor 126 .. _`auditors and reactors`: reference.html#auditor-or-reactor
109 .. _`customize`: customizing.html 127 .. _`customize`: customizing.html
110 .. _`external user database`: customizing.html#using-external-user-databases 128 .. _`external user database`: customizing.html#using-external-user-databases
111 .. _`five included templates`: installation.html#choosing-your-template 129 .. _`five included templates`: installation.html#choosing-your-template
Roundup Issue Tracker: http://roundup-tracker.org/