diff --git a/website/site/content/docs/install/downgrading.md b/website/site/content/docs/install/downgrading.md new file mode 100644 index 00000000..014bc93b --- /dev/null +++ b/website/site/content/docs/install/downgrading.md @@ -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) {}; +# … +``` diff --git a/website/site/content/docs/install/installing.md b/website/site/content/docs/install/installing.md index 9b6a094e..192a89dc 100644 --- a/website/site/content/docs/install/installing.md +++ b/website/site/content/docs/install/installing.md @@ -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 diff --git a/website/site/content/docs/install/upgrading.md b/website/site/content/docs/install/upgrading.md new file mode 100644 index 00000000..1ae2e8ab --- /dev/null +++ b/website/site/content/docs/install/upgrading.md @@ -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`. diff --git a/website/site/content/docs/webapp/scanmailbox.md b/website/site/content/docs/webapp/scanmailbox.md index cc5867d0..e3ca24c9 100644 --- a/website/site/content/docs/webapp/scanmailbox.md +++ b/website/site/content/docs/webapp/scanmailbox.md @@ -43,8 +43,10 @@ special folder, which will usually appear translated in your web-mail client. You can specify "INBOX" case insensitive, it will then read mails in your inbox. Any other folder is usually case-sensitive (depends on the imap server, but usually they are case sensitive -except the INBOX folder). Type in a folder name and click the add -button on the right. +except the INBOX folder). The path separator may also vary depending +on your imap server - if the slash doesn't work, try using a dot +(i.e. "INBOX.invoices" instead of "INBOX/invoices"). +Type in a folder name and click the add button on the right. Then the field *Received Since Hours* defines how many hours to go back and look for mails. Usually there are many mails in your inbox