Quickstart

There are the following quick ways to get docspell to run on your machine:

Check the demo videos to see the basic idea. Refer to the documentation for more information on how to use docspell.

Download, Unpack, Run

Prerequisite

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:

  1. Unzip both files:
    $ unzip docspell-*.zip
    
  2. Open two terminal windows and navigate to the the directory containing the zip files.
  3. Start both components executing:
    $ ./docspell-restserver*/bin/docspell-restserver
    

    in one terminal and

    $ ./docspell-joex*/bin/docspell-joex
    

    in the other.

  4. Point your browser to: http://localhost:7880/app
  5. Register a new account, sign in and try it.

Note, that this setup doesn’t include watching a directory. You can use the consumedir.sh tool for this or use the docker variant below.

With Docker

There is a docker-compose setup available in the /docker folder.

  1. Clone the github repository
    $ git clone https://github.com/eikek/docspell
    
  2. Change into the docker directory:
    $ cd docspell/docker
    
  3. Run docker-compose up:

    $ 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.sh docs for additional info.

  4. 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.

  5. (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.