2019-07-22 22:53:30 +00:00
|
|
|
---
|
2019-12-29 22:37:32 +00:00
|
|
|
layout: docs
|
2019-07-22 22:53:30 +00:00
|
|
|
title: Quickstart
|
2020-03-28 15:35:28 +00:00
|
|
|
permalink: getit
|
2019-07-22 22:53:30 +00:00
|
|
|
---
|
|
|
|
|
|
2020-03-31 20:52:44 +00:00
|
|
|
# {{ page.title }}
|
2019-07-22 22:53:30 +00:00
|
|
|
|
|
|
|
|
You can download pre-compiled binaries from the [Release
|
|
|
|
|
Page](https://github.com/eikek/docspell/releases). There are `deb`
|
2020-03-31 20:52:44 +00:00
|
|
|
packages and generic zip files. Alternatively, docspell can be
|
|
|
|
|
installed via [nix](doc/nix) or docker (see below).
|
2019-07-22 22:53:30 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Prerequisite
|
|
|
|
|
|
|
|
|
|
Install Java (use your package manager or look
|
2020-02-20 20:43:37 +00:00
|
|
|
[here](https://adoptopenjdk.net/)).
|
|
|
|
|
|
|
|
|
|
OCR functionality requires the following tools:
|
|
|
|
|
|
|
|
|
|
- [tesseract](https://github.com/tesseract-ocr/tesseract),
|
|
|
|
|
- [ghostscript](http://pages.cs.wisc.edu/~ghost/) and possibly
|
|
|
|
|
- [unpaper](https://github.com/Flameeyes/unpaper).
|
|
|
|
|
|
|
|
|
|
The last is not really required, but improves OCR.
|
|
|
|
|
|
|
|
|
|
PDF conversion requires the following tools:
|
|
|
|
|
|
|
|
|
|
- [unoconv](https://github.com/unoconv/unoconv)
|
|
|
|
|
- [wkhtmltopdf](https://wkhtmltopdf.org/)
|
2019-07-22 22:53:30 +00:00
|
|
|
|
|
|
|
|
|
2020-03-31 20:52:44 +00:00
|
|
|
## Using zip files
|
|
|
|
|
|
|
|
|
|
You need to download the two files:
|
|
|
|
|
|
|
|
|
|
- [docspell-restserver-{{site.version}}.zip](https://github.com/eikek/docspell/releases/download/v{{site.version}}/docspell-restserver-{{site.version}}.zip)
|
|
|
|
|
- [docspell-joex-{{site.version}}.zip](https://github.com/eikek/docspell/releases/download/v{{site.version}}/docspell-joex-{{site.version}}.zip)
|
|
|
|
|
|
2019-07-22 22:53:30 +00:00
|
|
|
|
|
|
|
|
1. Unzip both files:
|
|
|
|
|
``` bash
|
|
|
|
|
$ unzip docspell-*.zip
|
|
|
|
|
```
|
|
|
|
|
2. Open two terminal windows and navigate to the the directory
|
|
|
|
|
containing the zip files.
|
|
|
|
|
3. Start both components executing:
|
|
|
|
|
``` bash
|
|
|
|
|
$ ./docspell-restserver*/bin/docspell-restserver
|
|
|
|
|
```
|
|
|
|
|
in one terminal and
|
|
|
|
|
``` bash
|
|
|
|
|
$ ./docspell-joex*/bin/docspell-joex
|
|
|
|
|
```
|
|
|
|
|
in the other.
|
2019-12-30 20:59:06 +00:00
|
|
|
4. Point your browser to: <http://localhost:7880/app>
|
2019-07-22 22:53:30 +00:00
|
|
|
5. Register a new account, sign in and try it.
|
|
|
|
|
|
2020-01-11 21:12:51 +00:00
|
|
|
Check the [early demo video](demo) to see the basic idea. Refer to the
|
2020-03-28 15:35:28 +00:00
|
|
|
[documentation](doc) for more information on how to use docspell.
|
2020-03-31 20:52:44 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Docker
|
|
|
|
|
|
|
|
|
|
There is a [docker-compose](https://docs.docker.com/compose/) setup
|
|
|
|
|
available in the `/docker` folder.
|
|
|
|
|
|
|
|
|
|
1. Clone the github repository
|
|
|
|
|
```bash
|
|
|
|
|
$ git clone https://github.com/eikek/docspell
|
|
|
|
|
```
|
|
|
|
|
2. Change into the `docker` directory:
|
|
|
|
|
```bash
|
|
|
|
|
$ cd docspell/docker
|
|
|
|
|
```
|
|
|
|
|
3. Run `docker-compose up`:
|
|
|
|
|
```bash
|
|
|
|
|
$ docker-compose up
|
|
|
|
|
```
|
|
|
|
|
4. Goto <http://localhost:7880>, signup and login
|
|
|
|
|
|
|
|
|
|
The directory contains a file `docspell.conf` that you can
|
|
|
|
|
[modify](configure) as needed.
|
