docspell/modules/microsite/docs/getit.md

layout	title
docs	Quickstart

Download

You can download pre-compiled binaries from the Release Page. There are deb packages and a generic zip files.

You need to download the two files:

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

Prerequisite

Install Java (use your package manager or look here), tesseract, ghostscript and possibly unpaper. The last is not really required, but improves OCR.

Running

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/index.html
5. Register a new account, sign in and try it.

Check the documentation for more information on how to use docspell.