Mercurial > p > roundup > code

annotate doc/features.txt @ 8174:5ea419c1d571

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add security advantage of depending on core library. After reading about NPM supply chain attacks, emphasize core functions of Roundup are available without reaching out to PyPi.
author John Rouillard <rouilj@ieee.org>
date Tue, 03 Dec 2024 10:53:32 -0500
parents b1ff8c0e3e1d
children 5145ad81970a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6262
diff changeset
1 .. meta::
6774
e7b4ad2c57ac landmarks, skiplink, remove bad attrs, autocomplete search
John Rouillard <rouilj@ieee.org>
parents: 6762
diff changeset
2 :description:
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6262
diff changeset
3 Features of using the Roundup Issue Tracker. Describes
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6262
diff changeset
4 all access methods, configuration and workflow capabilities.
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6262
diff changeset
5 Links to detailed documentation.
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6262
diff changeset
6
739
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 ================
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 Roundup Features
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9 ================
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10
7990
788afca5aa15 docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents: 7794
diff changeset
11 Roundup is an easy-to-use and -install issue-tracking system with
788afca5aa15 docs: fixups to features lists.
John Rouillard <rouilj@ieee.org>
parents: 7794
diff changeset
12 web, e-mail and command-line interfaces. Based on the winning design
6163
c2fd254c9257 Doc updates/indexing.
John Rouillard <rouilj@ieee.org>
parents: 5891
diff changeset
13 from Ka-Ping Yee in the :index:`Software Carpentry` "Track" design competition.
739
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
14
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
15 **Installation and Setup**
8027
4ed91247e8dc docs: trying to cleanup/categorize features better.
John Rouillard <rouilj@ieee.org>
parents: 7990
diff changeset
16
8034
b1ff8c0e3e1d docs: fix spellings.
John Rouillard <rouilj@ieee.org>
parents: 8033
diff changeset
17 - Start using the software in `instant-gratification (demo) mode`_ with
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
18 ``python demo.py`` or `a Docker container`_ in under 5 minutes.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
19 - Choose from `five included templates`_ for your tracker.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
20 - `Customize`_ and use the demo as a template for your production tracker.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
21 - No need for additional support software, just Python (3.6+ or 2.7)
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
22 to get started.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
23 - Basic installation (including a web interface) takes about 30 minutes.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
24 - Supports embedded databases like `SQLite`_ and dbm. Upgradable
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
25 to databases like `MySQL`_ or `PostgreSQL`_ if needed.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
26 - Can be run in a container like Docker or kubernetes.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
27 - Deploy in your network as a standalone web server or `through
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
28 various methods`_ like WSGI, FastCGI, plain CGI, etc.
8174
5ea419c1d571 add security advantage of depending on core library.
John Rouillard <rouilj@ieee.org>
parents: 8034
diff changeset
29 - Essential tracking features depend on the Python standard
5ea419c1d571 add security advantage of depending on core library.
John Rouillard <rouilj@ieee.org>
parents: 8034
diff changeset
30 library. Supplementary packages from PyPI are optional and can be
5ea419c1d571 add security advantage of depending on core library.
John Rouillard <rouilj@ieee.org>
parents: 8034
diff changeset
31 tailored to fit your unique threat model and security needs.
8027
4ed91247e8dc docs: trying to cleanup/categorize features better.
John Rouillard <rouilj@ieee.org>
parents: 7990
diff changeset
32
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
33 **Issue Tracking and Management**
739
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
34
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
35 - Manage your issues your way. Handle bugs, features, milestones,
8034
b1ff8c0e3e1d docs: fix spellings.
John Rouillard <rouilj@ieee.org>
parents: 8033
diff changeset
36 user feedback, fleet maintenance, office issues etc.
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
37 - Searches on specific properties (e.g. open issues with a high
8034
b1ff8c0e3e1d docs: fix spellings.
John Rouillard <rouilj@ieee.org>
parents: 8033
diff changeset
38 priority) can be saved and reused or shared with outer users.
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
39 - Full Text Search for quick searches across messages.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
40 - Keeps a detailed history of issue changes.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
41 - Issues become a mini mailing list to keep everyone informed.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
42 - Email is a first class method for interacting with issues.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
43
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
44 **Scalability and Performance**
8027
4ed91247e8dc docs: trying to cleanup/categorize features better.
John Rouillard <rouilj@ieee.org>
parents: 7990
diff changeset
45
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
46 - Default trackers use simple HTML with low resource requirements.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
47 - Fast and scalable with sqlite, mysql, and postgresql backends.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
48 - Indexes are automatically configured.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
49 - Supports full-text indexing engines (xapian, whoosh, SQLite,
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
50 PostgreSQL) for large trackers.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
51
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
52 **Customization**
739
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
53
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
54 - The database schema can be updated to `track additional data`_.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
55 - The web interface can be redesigned to fit your workflow.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
56 - Extensible web interface with various features like `wizards`_,
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
57 bug displays, etc.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
58 - Add business rules using `auditors and reactors`_ for actions before
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
59 and after database changes.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
60 - Comprehensive documentation for customization, installation,
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
61 maintenance, and user guidance.
8027
4ed91247e8dc docs: trying to cleanup/categorize features better.
John Rouillard <rouilj@ieee.org>
parents: 7990
diff changeset
62
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
63 **Data Security, Privacy and Authorization**
8027
4ed91247e8dc docs: trying to cleanup/categorize features better.
John Rouillard <rouilj@ieee.org>
parents: 7990
diff changeset
64
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
65 - Your data remains on your servers.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
66 - You can choose if AI can access the data.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
67 - Can use HTTPS for security over the web.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
68 - Fine-grained authorization (ABAC, PEBAC) based on user and resource
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
69 properties.
1228
Richard Jones <richard@users.sourceforge.net>
parents: 742
diff changeset
70
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
71 **Documentation and User Management**
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
72
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
73 - Users can sign up through the web interface or new user creation
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
74 can be limited to admin users.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
75 - Can use an `external user database`_ (LDAP, password file)
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
76 - Self-server password reset for users via email.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
77
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
78 **Email Integration and Automation**
739
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
79
8034
b1ff8c0e3e1d docs: fix spellings.
John Rouillard <rouilj@ieee.org>
parents: 8033
diff changeset
80 - Update issues via email with new messages and the ability to
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
81 change properties of issues (e.g. close an issue).
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
82 - Secure email handling with features like TLS, APOP, IMAPS/OAUTH.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
83 - Optional auto-registration for email users.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
84 - Configurable nosy list for each issue controls email notifications.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
85 - Proper handling of email attachments and content types.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
86
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
87 **Command-Line and API Access**
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
88
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
89 - Manage database interactively from the command line.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
90 - Automate modifications using standard shell scripting.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
91 - Python programs can use the Roundup Python API to manage/automate issues.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
92 - Sample scripts provided for various tasks.
739
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
93
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
94 **Remote Access Interfaces**
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
95
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
96 - `XMLRPC interface`_ for remote tracker access with basic
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
97 HTTP authentication.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
98 - `RESTful API`_ accessible with basic HTTP authentication or optional JWT.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
99 - Configurable CORS support for third-party web pages.
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
100 - Ability to generate and authenticate JSON Web Tokens (JWT).
739
c612747b1126 Added a Features doc
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
101
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
102 .. _`auditors and reactors`: reference.html#auditor-or-reactor
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
103 .. _`customize`: customizing.html
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
104 .. _`external user database`: customizing.html#using-external-user-databases
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
105 .. _`five included templates`: installation.html#choosing-your-template
8034
b1ff8c0e3e1d docs: fix spellings.
John Rouillard <rouilj@ieee.org>
parents: 8033
diff changeset
106 .. _`instant-gratification (demo) mode`:
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
107 installation.html#for-the-really-impatient
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
108 .. _`a Docker container`: installation.html#running-in-demo-mode-with-docker
5511
bfe8e52af1e7 more mentions of updated MySQL client module
Christof Meerwald <cmeerw@cmeerw.org>
parents: 5096
diff changeset
109 .. _mysql: https://pypi.org/project/MySQL-python/
6262
ba82fb74f806 Update psycopg link to: https://www.psycopg.org/
John Rouillard <rouilj@ieee.org>
parents: 6163
diff changeset
110 .. _postgresql: https://www.psycopg.org/
8033
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
111 .. _`restful api`: rest.html
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
112 .. _`run in a container`: installation.html#docker-support
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
113 .. _sqlite: https://www.sqlite.org/index.html
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
114 .. _`track additional data`:
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
115 customizing.html#adding-a-new-field-to-the-classic-schema
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
116 .. _`through various methods`: installation.html#configure-a-web-interface
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
117 .. _wizards:
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
118 customizing.html#setting-up-a-wizard-or-druid-for-controlled-adding-of-issues
6cebbb42c883 docs: regroup feature list using GPT and update
John Rouillard <rouilj@ieee.org>
parents: 8027
diff changeset
119 .. _`xmlrpc interface`: xmlrpc.html
Roundup Issue Tracker: http://roundup-tracker.org/