Documentation
The documentation lives in the public repository, and every link here points at the latest release, so what
you read matches what you install. The in-app help is also available inside the running app at /help.
Getting started
- README What the software does, installing it, the first administrator, a reverse proxy, running it day to day, backups, and the background of the project.
- Contributing The development setup, the checks every change must pass and how to open a pull request.
- Product brief What ArgueSecure is for, who it is for and what it will not become.
Using it (the in-app help)
- Concepts The structure of an assessment, the three views and why it is a graph.
- Building an assessment Adding nodes, linking instead of duplicating, the node tabs, structure and finding your way.
- The quantification model The formula, impact and likelihood, missing values, stacking defences and how to read the totals.
- Collaboration Presence, one editor per node, conflicts, comments, mentions and assignees.
- Sharing and roles Viewer, commenter, editor and manager, public assessments and read-only links.
- History and versions Versions, comparing and restoring, undo, and the trash.
- Templates The bundled templates, the standards templates and taking parts of a template.
- How to read a report The report sections, the options, exports and printing.
- Signing in Single sign-on, two-factor authentication and recovery codes.
- Administration Users, instance settings, authentication, scales, the assistant and the security log.
- Keyboard map The keyboard shortcuts of the chart and the list.
Specifications
- Calculation engine The quantification model in full, including the worked example it is tested against.
- Security Authentication, authorisation, sessions, headers and input handling.
- Deployment The Docker services, environment variables, proxy settings and operations.
- Schema The database, the models and who may do what.
- Interface The editor, the keyboard map and the reports.
The optional assistant
- The assistant The three switches, installing a model, what each feature may see, and what the assistant is never allowed to do.
On this website
- How it worksThe structure, the argument and the numbers in plain terms.
- Self-hostThe quick start, reverse proxy, upgrades and backups.
- Release notesWhat changed in each release since 2.0.0.