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

Update documentation and changelog

Browse Source
This commit is contained in:
Eike Kettner
2020-06-28 14:44:11 +02:00
parent f883648839
commit 82104ff148
3 changed files with 80 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
modules/microsite/docs/doc/tools/consumedir.md
View File

@ -116,21 +116,26 @@ url as described [here](../uploading#anonymous-upload).
## Docker
The provided docker image runs this script to watch a directory for
new files. If a new file is detected, it is pushed to docspell.
The provided docker image runs this script to watch a single
directory, `./docs` in current directory, for new files. If a new file
is detected, it is pushed to docspell.
For this to work, the container must know about a valid upload url.
Therefore, you must first signup and create such an upload url, as
described [here](doc/uploading#anonymous-upload). Get only the id
(something like `AvR6sA8GKFm-hgYDgZfwzXa-Tqnu8yqyz6X-KzuefvEvrRf`) and
define an environment variable `SOURCE_ID` with that value before
running `docker-compose up` a second time.
This utilizes the [integration
endpoint](../uploading#integration-endpoint), which is enabled in the
config file, to allow uploading documents for all collectives. A
subfolder must be created for each registered collective. The docker
containers are configured to use http-header protection for the
integration endpoint. This requires you to provide a secret, that is
shared between the rest-server and the `consumedir.sh` script. This
can be done by defining an environment variable which gets picked up
by the containers defined in `docker-compose.yml`:
```
export SOURCE_ID="AvR6sA8GKFm-hgYDgZfwzXa-Tqnu8yqyz6X-KzuefvEvrRf"
export DOCSPELL_HEADER_VALUE="my-secret"
docker-compose up
```
Now you can create a folder `./docs` and place all files in there that
you want to import. Once dropped in this folder the `consumedir`
container will push it to docspell.
Now you can create a folder `./docs/<collective-name>` and place all
files in there that you want to import. Once dropped in this folder
the `consumedir` container will push it to docspell.

23
modules/microsite/docs/getit.md
View File

@ -69,6 +69,9 @@ You need to download the two files:
4. Point your browser to: <http://localhost:7880/app>
5. Register a new account, sign in and try it.
Note, that this setup doesn't include watching a directory. You can
use the [`consumedir.sh`](doc/tools/consumedir) tool for this or use
the docker variant below.
## With Docker
@ -84,19 +87,19 @@ available in the `/docker` folder.
$ cd docspell/docker
```
3. Run `docker-compose up`:
```bash
$ export DOCSPELL_HEADER_VALUE="my-secret-123"
$ docker-compose up
```
4. Goto <http://localhost:7880>, signup and login
The environment variable defines a secret that is shared between
some containers. You can define whatever you like. Please see the
[`consumedir.sh`](doc/tools/consumedir#docker) docs for additional
info.
4. Goto <http://localhost:7880>, signup and login. Create a folder
`./docs/<collective-name>` and place files in there for importing
them.
The directory contains a file `docspell.conf` that you can
[modify](doc/configure) as needed.
### Watching files in a directory
This setup starts a container running the
[`consumedir.sh`](doc/tools/consumedir) script. It is configured to
watch one directory and upload files arriving in there to docspell.
Please see the [`consumedir.sh`](doc/tools/consumedir#docker) docs for
additional steps.