docspell/modules/microsite/docs/getit.md
2020-02-20 21:43:37 +01:00

1.6 KiB

layout title
docs Quickstart

Download

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

You need to download the two files:

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:

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

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