TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-21 18:08:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'current-docs'

Browse Source
This commit is contained in:
eikek
2021-11-12 22:30:39 +01:00
parent 63d5290761 a1bf3957ba
commit 927c3dfac9
7 changed files with 73 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
website/elm/GetStarted.elm
View File

@ -25,8 +25,7 @@ getStarted version =
3. Run `docker-compose up`:
```bash
$ export DOCSPELL_HEADER_VALUE="my-secret-123"
$ docker-compose up
$ docker-compose up -d
```
The environment variable defines a secret that is shared between

39
website/site/content/docs/install/docker.md
View File

@ -172,18 +172,25 @@ $ cd docspell/docker/docker-compose
Then run `docker-compose`:
```bash
$ export DOCSPELL_HEADER_VALUE="my-secret-123"
$ docker-compose up
$ docker-compose up -d
```
The environment variable defines a secret that is shared between the
container watching a directory and the server. It is the header
defined for the [integration
endpoint](@/docs/api/upload.md#integration-endpoint) containers. You
can use whatever you like. Please see the help to the [dsc
tool](@/docs/tools/cli.md) docs for additional info.
If you look at `docker-compose.yml`, there are several environment
variables defined. A few that you should change, i.e. all "secrets":
Goto `http://localhost:7880`, signup and login. When signing up, you
- `DOCSPELL_SERVER_ADMIN__ENDPOINT_SECRET`
- `DOCSPELL_SERVER_AUTH_SERVER__SECRET`
- `DOCSPELL_SERVER_INTEGRATION__ENDPOINT_HTTP__HEADER_HEADER__VALUE`
Then, the value for
`DOCSPELL_SERVER_INTEGRATION__ENDPOINT_HTTP__HEADER_HEADER__VALUE`
must be duplicated in the consumedir command (both values must match).
It is the header defined for the [integration
endpoint](@/docs/api/upload.md#integration-endpoint). You can use
whatever you like, best something random. Please see the help to the
[dsc tool](@/docs/tools/cli.md) docs for additional info.
Goto `http://localhost:7880`, signup and login. When signing up,
choose the same name for collective and user. Then login with this
name and the password.
@ -191,9 +198,19 @@ name and the password.
chose for the collective at registration) and place files in there for
importing them.
The directory contains a file `docspell.conf` that you can
[modify](@/docs/configure/_index.md) as needed.
Docspell can be configured via environment variables or a config file.
Please see the [configuration](@/docs/configure/_index.md) for more
details and possible values/variables. You can create a config file
and mount it into the container. Then specify the config file as the
an argument to the command, i.e. add a
``` yml
command:
- /path/to/config.conf
```
to the service definition (or add it to an existing `command:`
section).
### Override this setup

3
website/site/content/docs/tools/cli.md
View File

@ -429,8 +429,7 @@ defining an environment variable which gets picked up by the
containers defined in `docker-compose.yml`:
``` bash
export DOCSPELL_HEADER_VALUE="my-secret"
docker-compose up
docker-compose up -d
```