mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-04 06:05:59 +00:00
Update documentation
This commit is contained in:
parent
f16632bc7f
commit
785cdde1a6
@ -6,6 +6,8 @@
|
|||||||
|
|
||||||
- New feature "Scan Mailboxes". Docspell can now read mailboxes
|
- New feature "Scan Mailboxes". Docspell can now read mailboxes
|
||||||
periodically to import your mails.
|
periodically to import your mails.
|
||||||
|
- New feature "Integration Endpoint". Allows an admin to upload files
|
||||||
|
to any collective using a separate endpoint.
|
||||||
- Fix the `find-by-checksum` route that, given a sha256 checksum,
|
- Fix the `find-by-checksum` route that, given a sha256 checksum,
|
||||||
returns whether there is such a file in docspell. It falsely
|
returns whether there is such a file in docspell. It falsely
|
||||||
returned `false` although documents existed.
|
returned `false` although documents existed.
|
||||||
@ -20,7 +22,7 @@
|
|||||||
|
|
||||||
### Configuration Changes
|
### Configuration Changes
|
||||||
|
|
||||||
The joex component has new config sections:
|
The joex and rest-server component have new config sections:
|
||||||
|
|
||||||
- Add `docspell.joex.mail-debug` flag to enable debugging e-mail
|
- Add `docspell.joex.mail-debug` flag to enable debugging e-mail
|
||||||
related code. This is only useful if you encounter problems
|
related code. This is only useful if you encounter problems
|
||||||
@ -29,6 +31,8 @@ The joex component has new config sections:
|
|||||||
configure the new scan-mailbox user task.
|
configure the new scan-mailbox user task.
|
||||||
- Add `docspell.joex.files` section that is the same as the
|
- Add `docspell.joex.files` section that is the same as the
|
||||||
corresponding section in the rest server config.
|
corresponding section in the rest server config.
|
||||||
|
- Add `docspell.rest-server.integration-endpoint` with sub-sections to
|
||||||
|
configure an endpoint for uploading files for admin users.
|
||||||
|
|
||||||
### REST Api Changes
|
### REST Api Changes
|
||||||
|
|
||||||
@ -36,6 +40,9 @@ The joex component has new config sections:
|
|||||||
- Add `/sec/email/settings/imap`
|
- Add `/sec/email/settings/imap`
|
||||||
- Add `/sec/usertask/scanmailbox` routes to configure one or more
|
- Add `/sec/usertask/scanmailbox` routes to configure one or more
|
||||||
scan-mailbox tasks
|
scan-mailbox tasks
|
||||||
|
- The data used in `/sec/collective/settings` was extended with a
|
||||||
|
boolean value to enable/disable the "integration endpoint" for a
|
||||||
|
collective.
|
||||||
|
|
||||||
|
|
||||||
## v0.5.0
|
## v0.5.0
|
||||||
|
@ -85,6 +85,31 @@ docspell count the files uploaded through the web interface, just
|
|||||||
create a source (can be inactive) with that name (`webapp`).
|
create a source (can be inactive) with that name (`webapp`).
|
||||||
|
|
||||||
|
|
||||||
|
## Integration Endpoint
|
||||||
|
|
||||||
|
Another option for uploading files is the special *integration
|
||||||
|
endpoint*. This endpoint allows an admin to upload files to any
|
||||||
|
collective, that is known by name.
|
||||||
|
|
||||||
|
```
|
||||||
|
/api/v1/open/integration/item/[collective-name]
|
||||||
|
```
|
||||||
|
|
||||||
|
The endpoint is behind `/api/v1/open`, so this route is not protected
|
||||||
|
by an authentication token (see [REST Api](../api) for more
|
||||||
|
information). However, it can be protected via settings in the
|
||||||
|
configuration file. The idea is that this endpoint is controlled by an
|
||||||
|
administrator and not the user of the application. The admin can
|
||||||
|
enable this endpoint and choose between some methods to protect it.
|
||||||
|
Then the administrator can upload files to any collective. This might
|
||||||
|
be useful to connect other trusted applications to docspell (that run
|
||||||
|
on the same host or network).
|
||||||
|
|
||||||
|
The endpoint is disabled by default, an admin must change the
|
||||||
|
`docspell.restserver.integration-endpoint.enabled` flag to `true` in
|
||||||
|
the [configuration file](configure#rest-server).
|
||||||
|
|
||||||
|
|
||||||
## The Request
|
## The Request
|
||||||
|
|
||||||
This gives more details about the request for uploads. It is a http
|
This gives more details about the request for uploads. It is a http
|
||||||
|
Loading…
x
Reference in New Issue
Block a user