Skip to content

Commit 9c4d02a

Browse files
authored
minor adjustments (#41)
1 parent c9f770f commit 9c4d02a

File tree

3 files changed

+8
-7
lines changed

3 files changed

+8
-7
lines changed

docs/settings/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ Environment variables have following format:
77

88
PAPERMERGE__<section>__<name>
99

10-
double underscores are used as delimiter; environment variables names must all
10+
double underscores are used as delimiter; environment variables names must be all
1111
upper case.

docs/setup/docker.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88
## TL;DR
99

10-
The only two required environment variables are `PAPERMERGE__MAIN__SECRET_KEY` and `PAPERMERGE__AUTH__PASSWORD`:
10+
The only two required environment variables are `PAPERMERGE__SECURITY__SECRET_KEY` and `PAPERMERGE__AUTH__PASSWORD`:
1111

1212
```console
1313
docker run -p 9400:8000 \
14-
-e PAPERMERGE__MAIN__SECRET_KEY=abc \
14+
-e PAPERMERGE__SECURITY__SECRET_KEY=abc \
1515
-e PAPERMERGE__AUTH__PASSWORD=123 \
16-
papermerge/papermerge:3.0
16+
papermerge/papermerge:{{ extra.docker_image_version }}
1717
```
1818

1919
Point your web browser to http://localhost:9400 and you will see login screen:
@@ -38,13 +38,13 @@ Official {{ extra.project }} docker images are stored in <a href="https://hub.d
3838
The recommended way to get the {{ extra.project }} Docker Image is to pull the prebuilt image from the <a href=" https://github.com/papermerge/papermerge-core/pkgs/container/papermerge" class="external-link" target="_blank">github repository packages</a>:
3939

4040
```console
41-
docker pull papermerge/papermerge:3.0
41+
docker pull papermerge/papermerge:{{ extra.docker_image_version }}
4242
```
4343

4444
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the github repository packages:
4545

4646
```console
47-
docker pull papermerge/papermerge:3.0
47+
docker pull papermerge/papermerge:{{ extra.docker_image_version }}
4848
```
4949

5050

@@ -57,7 +57,7 @@ By default {{ extra.project }} uses sqlite3 database. In order to use PostgreSQL
5757

5858
services:
5959
app:
60-
image: papermerge/papermerge:3.0
60+
image: papermerge/papermerge:{{ extra.docker_image_version }}
6161
environment:
6262
- PAPERMERGE__SECURITY__SECRET_KEY=abc
6363
- PAPERMERGE__AUTH__PASSWORD=12345

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ theme:
7474
repo_url: https://github.com/ciur/papermerge
7575
extra:
7676
project: Papermerge # custom variable for macros plugin
77+
docker_image_version: 3.0a2 # latest docker image version e.g. 3.0, 3.0.1, 3.1.9, 3.0a1
7778
version:
7879
provider: mike
7980
social:

0 commit comments

Comments
 (0)