Add upgrade instructions

This commit is contained in:
Eike Kettner 2021-03-14 16:34:39 +01:00
parent 39d6f5789a
commit 7ebf63dd1b
3 changed files with 89 additions and 0 deletions

View File

@ -0,0 +1,46 @@
+++
title = "Downgrading"
weight = 37
+++
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.
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) {};
# …
```

View File

@ -15,6 +15,14 @@ creates a container to watch a directory for incoming files. It's only
```bash
$ git clone https://github.com/eikek/docspell
```
If you don't have git or don't want to clone the whole repo, use these steps instead:
``` bash
mkdir -p docspell/docker
cd docspell/docker
wget https://raw.githubusercontent.com/eikek/docspell/master/docker/docker-compose.yml
wget https://raw.githubusercontent.com/eikek/docspell/master/docker/docspell.conf
wget https://raw.githubusercontent.com/eikek/docspell/master/docker/.env
```
2. Change into the `docker` directory:
```bash
$ cd docspell/docker

View File

@ -0,0 +1,35 @@
+++
title = "Upgrading"
weight = 35
+++
Upgrading docspell requires to download the newer binaries and
re-installing them depending on your setup.
The database is migrated on application start automatically.
Since [downgrading](@/docs/install/downgrading.md) is not supported,
it is recommended to backup your database before upgrading. Should
something not work as expected, restore the database backup and go
back to the previous version.
# Docker-Compose
When using the provided `docker-compose` setup, you only need to pull
the new images. The latest release is always tagged with `-LATEST`.
``` bash
$ docker-compose down
$ docker-compose pull
$ docker-compose up --force-recreate --build -d
```
# Zip / Deb Files
When using the zip or deb files, either install the new deb files via
your package manager or download and unpack the new zip files.
# Nix
When using the provided nix setup, the `currentPkg` always points to
the latest release. Thus it is enough to run `nix-build`.