docspell/modules/microsite/docs/getit.md

layout	title	permalink
docs	Quickstart	getit

{{ page.title }}

You can download pre-compiled binaries from the Release Page. There are deb packages and generic zip files. Alternatively, docspell can be installed via nix or docker (see below).

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

• Download, Unpack, Run
• With Docker
• NixOs Module

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

Without Docker

Prerequisite

Install Java (use your package manager or look here).

OCR functionality requires the following tools:

• tesseract,
• ghostscript and possibly
• unpaper.

The last is not really required, but improves OCR.

PDF conversion requires the following tools:

• unoconv
• wkhtmltopdf

Using zip files

You need to download the two files:

• docspell-restserver-{{site.version}}.zip
• docspell-joex-{{site.version}}.zip

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.

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:

   $ docker-compose up
   

4. Goto http://localhost:7880, signup and login

The directory contains a file docspell.conf that you can modify as needed.