diff --git a/README.md b/README.md index 793456b4d110a33e469e39a908a09a1b5cb47e57..b24920b5ecef705f86e80e05ce270a944e7b9708 100644 --- a/README.md +++ b/README.md @@ -50,3 +50,27 @@ for example the `dbp-qualified-signature-pdf-upload` activity to qualifiedly sig [dbp-qualified-signature-pdf-upload/index.html](https://gitlab.tugraz.at/dbp/esign/signature/-/tree/master/examples/dbp-qualified-signature-pdf-upload/index.html) Note that you will need a Keycloak server along with a client id for the domain you are running this html on. + +## Attributes + +- `lang` (optional, default: `de`): set to `de` or `en` for German or English + - example `lang="de"` +- `entry-point-url` (optional, default is the TU Graz entry point url): entry point url to access the api + - example `entry-point-url="https://mw-dev.tugraz.at"` +- `auth` object: you need to set that object property for the auth token + - example auth property: `{token: "THE_BEARER_TOKEN"}` + - note: most often this should be an attribute that is not set directly, but subscribed at a provider +- `show-nextcloud-file-picker` (optional): Needs to be set for the Nextcloud file picker to be shown + - example `show-nextcloud-file-picker` +- `nextcloud-web-app-password-url` (optional): Nextcloud Auth Url to use with the Nextcloud file picker + - example `nextcloud-web-app-password-url="http://localhost:8081/index.php/apps/webapppassword"` + - `nextcloud-web-dav-url` also needs to be set for the Nextcloud file picker to be active +- `nextcloud-web-dav-url` (optional): Nextcloud WebDav Url to use with the Nextcloud file picker + - example `nextcloud-web-dav-url="http://localhost:8081/remote.php/dav/files"` + - `nextcloud-web-app-password-url` also needs to be set for the Nextcloud file picker to be active +- `nextcloud-file-url` (optional): Nextcloud File Url to use with the Nextcloud file picker + - example `nextcloud-file-url="http://localhost:8081/apps/files/?dir="` +- `nextcloud-name` (optional): Name of the Nextcloud service + - example `nextcloud-name="My Nextcloud"` +- `allow-annotating` (optional): Needs to be set to allow annotating the PDFs + - example `allow-annotating`