Website redesign

This commit is contained in:
eikek
2022-01-27 20:23:15 +01:00
parent 3fc7f54f1a
commit 261d2af9bb
248 changed files with 3519 additions and 1484 deletions

View File

@ -1,9 +1,10 @@
+++
title = "Installation and Deployment"
title = "Installation"
description = "There are multiple ways to install Docspell. This section contains detailed instructions."
weight = 30
weight = 5
sort_by = "weight"
insert_anchor_links = "right"
template = "pages.html"
template = "docs.html"
page_template = "docs.html"
redirect_to = "/docs/install/quickstart"
+++

View File

@ -3,7 +3,7 @@ title = "Docker"
weight = 20
+++
## Docker Images
# Docker Images
The docker images are at
[hub.docker.com](https://hub.docker.com/u/docspell). The `latest` tag
@ -29,7 +29,7 @@ release page. The images contain all the necessary
is used to watch a directory for uploading files. This runs the `dsc
watch` command.
### Examples
## Examples
These examples use `docker run` to start the restserver and
jobexecutor. Both must be connected to the same database. For this
@ -127,7 +127,7 @@ fulltext search. For a more sophisticated docker setup, use
appropriate tools, for example `docker-compose` which is explained
below.
## Docker Compose
# Docker Compose
There is a [docker-compose](https://docs.docker.com/compose/) setup
available in the `/docker/docker-compose` folder. This setup is
@ -135,8 +135,8 @@ similiar to the example above, but adding fulltext search and a
PostgreSQL database by using just one command. It's only a few steps
to get started.
### Start Docspell
#### 1. Get the docker-compose files
## Start Docspell
### 1. Get the docker-compose files
There are two options. You can clone the whole repository:
@ -159,7 +159,7 @@ You can choose any directory instead of
make the rest of the guide work for both ways of obtaining the
docker-compose file.
#### 2. Run `docker-compose up`
### 2. Run `docker-compose up`
Change into the new `docker-compose` directory, for example:
@ -210,7 +210,7 @@ command:
to the service definition (or add it to an existing `command:`
section).
### Override this setup
## Override this setup
If you want to change this setup, you can simply use your own compose
file or add a `docker-compose.override.yml` that allows to amend
@ -251,7 +251,7 @@ volumes:
```
### Upgrading
## Upgrading
Since [downgrading](@/docs/install/downgrading.md) is not supported,
it is recommended to backup your database before upgrading. Should
@ -267,7 +267,7 @@ $ docker-compose pull
$ docker-compose up --force-recreate --build -d
```
### Backups
## Backups
When running the docker compose setup, you can use the following to
backup the database.

View File

@ -3,7 +3,9 @@ title = "Downgrading"
weight = 37
+++
{% infobubble(mode="info", title="⚠ Please note") %}
# Downgrading
{% warningbubble(title="Note") %}
Downgrading is currently not supported!
It is not safe to install a previous version, because the database

View File

@ -3,24 +3,23 @@ title = "Download & Run"
weight = 22
+++
# Download and Run
You can install via zip or deb archives. Please see the
[prerequisites](@/docs/install/prereq.md) first.
## Using zip files
You need to download the two files:
- [docspell-restserver-{{version()}}.zip](https://github.com/eikek/docspell/releases/download/v{{version()}}/docspell-restserver-{{version()}}.zip)
- [docspell-joex-{{version()}}.zip](https://github.com/eikek/docspell/releases/download/v{{version()}}/docspell-joex-{{version()}}.zip)
1. Unzip both files:
1. Download the two files:
- <a href="https://github.com/eikek/docspell/releases/download/v{{version()}}/docspell-restserver-{{version()}}.zip">docspell-restserver-{{version()}}.zip</a>
- <a href="https://github.com/eikek/docspell/releases/download/v{{version()}}/docspell-joex-{{version()}}.zip">docspell-joex-{{version()}}.zip</a>
2. Unzip both files:
``` bash
$ unzip docspell-*.zip
```
2. Open two terminal windows and navigate to the the directory
3. Open two terminal windows and navigate to the the directory
containing the zip files.
3. Start both components executing:
4. Start both components executing:
``` bash
$ ./docspell-restserver*/bin/docspell-restserver
```
@ -29,8 +28,8 @@ You need to download the two files:
$ ./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.
5. Point your browser to: <http://localhost:7880/app>
6. Register a new account, sign in and try it.
Note, that this setup doesn't include watching a directory nor
fulltext search. Using zip/deb files requires to take care of the
@ -64,7 +63,7 @@ extracted and installed manually somewhere in your `$PATH`. There are
no deb files provided.
## Running
# Running
Run the start script (in the corresponding `bin/` directory when using
the zip files):

View File

@ -3,6 +3,7 @@ title = "Nix / NixOS"
weight = 24
+++
# Nix
## Install via Nix
@ -73,7 +74,7 @@ back to the previous version.
When using the provided nix setup, the `currentPkg` always points to
the latest release. Thus it is enough to run `nix-build`.
## Docspell on NixOS {#nixos}
# Docspell on NixOS {#nixos}
If you are running [NixOS](https://nixos.org), there is a module
definition for installing Docspell as a service using systemd.
@ -141,7 +142,7 @@ The modules files are only applicable to the newest version of
Docspell. If you really need an older version, checkout the
appropriate commit.
### NixOS Example
## NixOS Example
This is a example system configuration that installs docspell with a
postgres database. This snippet can be used to create a vm (using

View File

@ -3,6 +3,8 @@ title = "Prerequisites"
weight = 10
+++
# Prerequisites
The two components have one prerequisite in common: they both require
Java to run. While this is the only requirement for the *REST server*,
the *Joex* components requires some more external programs.
@ -10,7 +12,7 @@ the *Joex* components requires some more external programs.
The rest server and joex components are not required to "see" each
other, though it is recommended.
# Java
## Java
Very often, Java is already installed. You can check this by opening a
terminal and typing `java -version`. Otherwise install Java using your
@ -28,7 +30,7 @@ works on newer java versions. The provided docker images use JDK11.
The next tools are only required on machines running the *Joex*
component.
# External Programs for Joex
## External Programs for Joex
- [Ghostscript](http://pages.cs.wisc.edu/~ghost/) (the `gs` command)
is used to extract/convert PDF files into images that are then fed
@ -57,7 +59,7 @@ The performance of `unoconv` can be improved by starting `unoconv -l`
in a separate process. This runs a libreoffice/openoffice listener and
therefore avoids starting one each time `unoconv` is called.
## Example Debian
### Example Debian
On Debian this should install all joex requirements:

View File

@ -1,8 +1,10 @@
+++
title = "Quickstart"
title = "Getting started"
weight = 0
+++
# Getting started
To get started, here are some quick links:
- Using [docker and docker-compose](@/docs/install/docker.md). This
@ -28,7 +30,7 @@ To get started, here are some quick links:
thread](https://forums.unraid.net/topic/103425-docspell-hilfe/) in
the German Unraid forum. Thanks for providing these!
Every [component](@/docs/intro/_index.md#components) (restserver,
Every [component](@/docs/_index.md#components) (restserver,
joex, dsc watch) can run on different machines and multiple times.
Most of the time running all on one machine is sufficient and also for
simplicity, the docker-compose setup reflects this variant.
@ -39,7 +41,7 @@ file](@/docs/configure/_index.md). If this is not given, the default
is used, which gets you started on a single machine, but it is very
likely you want to change these to match your use-case/setup.
{% infobubble(mode="info", title="⚠ Please note") %}
{% infobubble(title="Note") %}
Please have a look at the [configuration page](/docs/configure/) page,
before making docspell publicly available. By default, everyone can

View File

@ -3,6 +3,8 @@ title = "Reverse Proxy"
weight = 50
+++
# Reverse Proxy
This contains examples for how to use docspell behind a reverse proxy.
For the examples below, assume the following:

View File

@ -1,8 +1,10 @@
+++
title = "Raspberry-Pi and Similiar"
title = "Raspberry-Pi"
weight = 40
+++
# Raspberry Pi
Both components can run next to each other on a raspberry pi or
similiar device.