mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-22 02:18:26 +00:00
Documentation updates/fixes
This commit is contained in:
@ -128,18 +128,19 @@ below.
|
||||
There is a [docker-compose](https://docs.docker.com/compose/) setup
|
||||
available in the `/docker/docker-compose` folder. This setup is
|
||||
similiar to the example above, adding fulltext search and a PostgreSQL
|
||||
database by using just one command. It's only 3 steps to get started:
|
||||
database by using just one command. It's only a few steps to get
|
||||
started.
|
||||
|
||||
### Start Docspell
|
||||
#### Get the docker-compose files
|
||||
#### 1. Get the docker-compose files
|
||||
|
||||
Either via cloning the whole repository:
|
||||
There are two options. You can clone the whole repository:
|
||||
|
||||
```bash
|
||||
$ git clone https://github.com/eikek/docspell
|
||||
```
|
||||
|
||||
This downloads all sources. What you need is only one subdirectory. So
|
||||
This downloads all sources. What you actually need is only 3 files. So
|
||||
if you don't have git or don't want to clone the whole repo, use these
|
||||
steps instead:
|
||||
|
||||
@ -152,7 +153,11 @@ $ wget https://raw.githubusercontent.com/eikek/docspell/master/docker/docker-com
|
||||
```
|
||||
|
||||
You can choose any directory instead of
|
||||
`docspell/docker/docker-compose`, of course.
|
||||
`docspell/docker/docker-compose`, of course. It's only this folder to
|
||||
make the rest of the guide work for both ways of obtaining the
|
||||
docker-compose file.
|
||||
|
||||
#### 2. Run `docker-compose up`
|
||||
|
||||
Change into the new `docker-compose` directory, for example:
|
||||
|
||||
@ -160,7 +165,7 @@ Change into the new `docker-compose` directory, for example:
|
||||
$ cd docspell/docker/docker-compose
|
||||
```
|
||||
|
||||
#### Run `docker-compose up`
|
||||
Then run `docker-compose`:
|
||||
|
||||
```bash
|
||||
$ export DOCSPELL_HEADER_VALUE="my-secret-123"
|
||||
|
@ -3,44 +3,18 @@ title = "Downgrading"
|
||||
weight = 37
|
||||
+++
|
||||
|
||||
{% infobubble(mode="info", title="⚠ Please note") %}
|
||||
Downgrading is currently not supported!
|
||||
|
||||
Note, it is not safe to install a previous version, because the
|
||||
database will not be compatible. Therefore, it is recommended to take
|
||||
a backup of the database before upgrading.
|
||||
It is not safe to install a previous version, because the database
|
||||
will most likely not be compatible. Therefore, it is recommended to
|
||||
take a backup of the database before upgrading.
|
||||
{% end %}
|
||||
|
||||
|
||||
|
||||
Should something not work out as expected, you need to restore the
|
||||
backup and then go back to the previous version.
|
||||
|
||||
## Docker-Compose
|
||||
|
||||
The default `docker-compose.yml` file points to images using the
|
||||
`-LATEST` tag. You need to edit this file and replace `-LATEST` with
|
||||
the concrete version, like `-v0.20.0`.
|
||||
|
||||
Then run the three steps as when upgrading:
|
||||
|
||||
``` bash
|
||||
$ docker-compose down
|
||||
$ docker-compose pull
|
||||
$ docker-compose up --force-recreate --build -d
|
||||
```
|
||||
|
||||
|
||||
## ZIP / Deb Files
|
||||
|
||||
Simply download a concrete version and re-install it using your
|
||||
package manager or unpack the zip file.
|
||||
|
||||
|
||||
## Nix
|
||||
|
||||
When using the provided nix setup, the `currentPkg` always points to
|
||||
the latest version. But most other versions are also provided and can
|
||||
be chosen from:
|
||||
|
||||
``` nix
|
||||
# …
|
||||
docspell = callPackage (docspell.pkg docspell.cfg.v0_20_0) {};
|
||||
# …
|
||||
```
|
||||
If you need to downgrade after running for a while, create an issue or
|
||||
meet on matrix/gitter. We should be able to find a way.
|
||||
|
@ -63,7 +63,6 @@ selecting the most current release. For example it translates to
|
||||
is `{{version()}}`.
|
||||
|
||||
|
||||
|
||||
## Upgrading
|
||||
|
||||
Since [downgrading](@/docs/install/downgrading.md) is not supported,
|
||||
|
@ -21,6 +21,7 @@ configuration file:
|
||||
to change the `bind.address` setting to be either `0.0.0.0` or the
|
||||
ip address of the network interface that the reverse proxy server
|
||||
connects to.
|
||||
|
||||
``` bash
|
||||
docspell.server {
|
||||
# Where the server binds to.
|
||||
@ -32,9 +33,10 @@ configuration file:
|
||||
```
|
||||
Note that a value of `0.0.0.0` instead of `192.168.1.11` will bind
|
||||
the server to every network interface.
|
||||
- Docspell needs to know the external url. The `base-url` setting
|
||||
must point to the external address. Using above values, it must be
|
||||
set to `https://docspell.example.com`.
|
||||
- (Optional) Docspell needs to know the external url. The `base-url`
|
||||
setting should point to the external address. Using above values, it
|
||||
would be `https://docspell.example.com`.
|
||||
|
||||
``` bash
|
||||
docspell.server {
|
||||
# This is the base URL this application is deployed to. This is used
|
||||
@ -44,12 +46,15 @@ configuration file:
|
||||
}
|
||||
```
|
||||
|
||||
You can also leave the default settings (`localhost`), in this case
|
||||
Docspell uses the request header to determine the external url.
|
||||
|
||||
Note that this example assumes that the docspell-joex component is on
|
||||
the same machine. This page is only related for exposing the REST
|
||||
server and web application.
|
||||
|
||||
If you have examples for more servers, please let me know or add it to
|
||||
this site.
|
||||
If you have examples for more http servers (e.g. apache), please let
|
||||
me know or add it to this site.
|
||||
|
||||
# Nginx
|
||||
|
||||
@ -90,6 +95,8 @@ server {
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
|
||||
//client_max_body_size 40M; //to allow larger uploads
|
||||
}
|
||||
}
|
||||
```
|
||||
|
@ -3,15 +3,16 @@ title = "Raspberry-Pi and Similiar"
|
||||
weight = 40
|
||||
+++
|
||||
|
||||
# Raspberry Pi, and similiar
|
||||
|
||||
Both component can run next to each other on a raspberry pi or
|
||||
Both components can run next to each other on a raspberry pi or
|
||||
similiar device.
|
||||
|
||||
There is a [project on
|
||||
github](https://github.com/docspell/rpi-scripts) that can help with
|
||||
setting up a raspberry pi with docspell.
|
||||
|
||||
The docker images are built for arm64 and armv7, these can also be
|
||||
used on the pi.
|
||||
|
||||
|
||||
## REST Server
|
||||
|
||||
|
Reference in New Issue
Block a user