Getting started🔗

To get started, here are some quick links:

• Using docker and docker-compose. This sets up everything: all prerequisites, both docspell components and a container running the dsc watch script to import files that are dropped in a folder.
• Download, Unpack and Run. This option is also very quick, but you need to check the prerequisites yourself. Database is already setup, but you'd need to setup SOLR (when using fulltext search) and install some programs for the joex component. This applies to the zip and deb files. The files can be downloaded from the release page.
• via the nix package manager and/or as a NixOS module through a flake. If you use nix/nixos, you know what to do. The linked page contains some examples.
• Unraid: There are user provided notes and unraid templates which can get you started. There is also an installation and help thread in the German Unraid forum. Thanks for providing these!

Every component (restserver, joex, dsc watch) 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.