There are the following quick ways to get docspell to run on your machine:
- Download, Unpack, Run You can download
pre-compiled binaries from the Release
Page. There are
debpackages and generic zip files.
- With Docker
- NixOs Module
Download, Unpack, Run
Install Java (use your package manager or look here).
OCR functionality requires the following tools:
The last is not really required, but improves OCR.
PDF conversion requires the following tools:
Using zip files
You need to download the two files:
- Unzip both files:
$ unzip docspell-*.zip
- Open two terminal windows and navigate to the the directory containing the zip files.
- Start both components executing:
in one terminal and
in the other.
- Point your browser to: http://localhost:7880/app
- Register a new account, sign in and try it.
Note, that this setup doesn’t include watching a directory. You can
consumedir.sh tool for this or use
the docker variant below.
There is a docker-compose setup
available in the
- Clone the github repository
$ git clone https://github.com/eikek/docspell
- Change into the
$ cd docspell/docker
$ export DOCSPELL_HEADER_VALUE="my-secret-123" $ docker-compose up
The environment variable defines a secret that is shared between some containers. You can define whatever you like. Please see the
consumedir.shdocs for additional info.
Goto http://localhost:7880, signup and login. When signing up, you can choose the same name for collective and user. Then login with this name and the password.
- (Optional) Create a folder
./docs/<collective-name>(the name you chose for the collective at registration) and place files in there for importing them.
The directory contains a file
docspell.conf that you can
modify as needed.