These guides cover installing, using and deploying Spooldoc. For the
overview and the architecture diagram, see the project README.
In the app, Support in the sidebar opens these guides, and the
discussions and issues on GitHub, each in a new tab.
Get started
| Guide | What it covers |
|---|
| Getting started | Install, first account, first job |
| FAQ | Short answers to common questions |
Use Spooldoc
| Guide | What it covers |
|---|
| Servers | IBM i systems, credentials, libraries, allowed hosts |
| Queues | Output queues and spooled files |
| Jobs | The job builder, versions, triggers, finish actions |
| Definitions | The YAML that turns pages into JSON |
| Templates | HTML, Word and Excel templates with Carbone tags, the template check, assets, PDF layout |
| Agent | Models, tools, masking |
| Destinations | Where documents go |
| Job log | Runs, statuses, retry, retention |
| Profile | Your name, password and theme |
Run Spooldoc
| Guide | What it covers |
|---|
| Carbone | The Carbone server, Settings, Community and Enterprise |
| Configuration | Environment variables and settings |
| Deployment | Docker, Compose, ports, backups, upgrades |
| Security | What the model sees, what is stored, how |
Develop
| Guide | What it covers |
|---|
| Architecture | What happens in a run, the packages, the data |
| Principles | What every change is checked against |
| Contributing | Development setup, tests, conventions |
The app serves these pages at /docs, for the version it runs, with this
page's groups as its sidebar. Each page starts with a title and
description header in place of a # heading. Links between guides use
the file name, such as [Versions](jobs.md#versions), so they work on
GitHub too.