Quickstart

Docspell Documentation

To get started, here are some quick links:

Every component (restserver, joex, consumedir) can run on different machines and multiple times. Most of the time running all on one machine is sufficient and also for simplicity, the docker-compose setup reflects this variant.

While there are many different ways to run docspell, at some point all call docspell binaries. These accept one argument: a config file. If this is not given, the default is used, which gets you started on a single machine, but it is very likely you want to change these to match your use-case/setup.

⚠ Please note

Please have a look at the configuration page page, before making docspell publicly available. By default, everyone can create an account. This is great for trying out and using it in an internal network. But when opened up to the outside, it is recommended to lock this down.