TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2025-06-22 10:28:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some documentation about shares

Browse Source
This commit is contained in:
eikek
2021-10-25 16:30:10 +02:00
parent c21d4c4508
commit 2b215afa81
15 changed files with 215 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
website/site/content/docs/api/intro.md
View File

@ -18,12 +18,13 @@ The "raw" `openapi.yml` specification file can be found
The routes can be divided into protected, unprotected routes and admin
routes. The unprotected, or open routes are at `/open/*` while the
protected routes are at `/sec/*` and admin routes are at `/admin/*`.
Open routes don't require authenticated access and can be used by any
user. The protected routes require an authenticated user. The admin
routes require a special http header with a value from the config
file. They are disabled by default, you need to specify a secret in
order to enable admin routes.
protected routes are at `/sec/*` and `/share/*`, while admin routes
are at `/admin/*`. Open routes don't require authenticated access and
can be used by any user. The protected routes require either an
authenticated user (for `/sec/*`) or a valid share id and possibly the
password (for `/share/*`). The admin routes require a special http
header with a value from the config file. They are disabled by
default, you need to specify a secret in order to enable admin routes.
## Authentication
@ -44,6 +45,16 @@ must be `docspell_auth` and a custom header must be named
The admin route (see below) `/admin/user/resetPassword` can be used to
reset a password of a user.
To authenticate for a share, the `/open/share/verify` endpoint must be
used. It expects the share id and possibly a password. If the share
requires a password, but it was not specified in the request, the
response indicates this. The request must then be replayed with the
correct password to retrieve a token. This token can then be used to
all `/share/*` endpoints to identify the share - analog to the
protected `/sec/*` routes. It can be either specfied as a cookie or
via the header `Docspell-Share-Auth`.
### OpenID Connect
Docspell can be configured to be a relying party for OpenID Connect.