docspell/modules/microsite/docs/getit.md
Eike Kettner b15b9cc217 Streamline routing
- put openapi doc behind `api/doc` instead of `app/doc`
- don't require `index.html` for the webapp
2019-12-30 22:03:25 +01:00

1.4 KiB

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:

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

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