updated docs about webhook support for sub users.

This commit is contained in:
ArabCoders
2025-02-05 17:00:12 +03:00
parent 87efadde7e
commit e555f1792b
3 changed files with 16 additions and 11 deletions

7
FAQ.md
View File

@@ -418,7 +418,7 @@ These environment variables relates to the tool itself, You should manage them v
command via CLI. command via CLI.
| Key | Type | Description | Default | | Key | Type | Description | Default |
|-------------------------|---------|-------------------------------------------------------------------------|--------------------------| | ----------------------- | ------- | ----------------------------------------------------------------------- | ------------------------ |
| WS_DATA_PATH | string | Where to store main data. (config, db). | `${BASE_PATH}/var` | | WS_DATA_PATH | string | Where to store main data. (config, db). | `${BASE_PATH}/var` |
| WS_TMP_DIR | string | Where to store temp data. (logs, cache) | `${WS_DATA_PATH}` | | WS_TMP_DIR | string | Where to store temp data. (logs, cache) | `${WS_DATA_PATH}` |
| WS_TZ | string | Set timezone. Fallback to to `TZ` variable if `WS_TZ` not set. | `UTC` | | WS_TZ | string | Set timezone. Fallback to to `TZ` variable if `WS_TZ` not set. | `UTC` |
@@ -463,7 +463,7 @@ $ docker exec -ti watchstate console system:env --list
> the `compose.yaml` file. > the `compose.yaml` file.
| Key | Type | Description | Default | | Key | Type | Description | Default |
|---------------|---------|--------------------------------------|----------| | ------------- | ------- | ------------------------------------ | -------- |
| WEBUI_ENABLED | bool | Enable WebUI. Value casted to a bool | `true` | | WEBUI_ENABLED | bool | Enable WebUI. Value casted to a bool | `true` |
| DISABLE_HTTP | integer | Disable included `HTTP Server`. | `0` | | DISABLE_HTTP | integer | Disable included `HTTP Server`. | `0` |
| DISABLE_CRON | integer | Disable included `Task Scheduler`. | `0` | | DISABLE_CRON | integer | Disable included `Task Scheduler`. | `0` |
@@ -483,8 +483,7 @@ The Webhook URL is backend specific, the request path is `/v1/api/backend/[USER]
Where `[USER]` is the username for sub user or `main` for main user and `[BACKEND_NAME]` is the name of the backend you Where `[USER]` is the username for sub user or `main` for main user and `[BACKEND_NAME]` is the name of the backend you
want to add webhook for. Typically, the full URL want to add webhook for. Typically, the full URL
is `http://localhost:8080/v1/api/backend/[USER]@[BACKEND_NAME]/webhook`. Or simply go to the `WebUI > Backends` and is `http://localhost:8080/v1/api/backend/[USER]@[BACKEND_NAME]/webhook`. Or simply go to the `WebUI > Backends` and
click click on `Copy Webhook URL`.
on `Copy Webhook URL`.
> [!NOTE] > [!NOTE]
> You will keep seeing the `webhook.token` key, it's being kept for backward compatibility, and will be removed in the > You will keep seeing the `webhook.token` key, it's being kept for backward compatibility, and will be removed in the

View File

@@ -1,5 +1,12 @@
# Old Updates # Old Updates
### 2025-01-24
We are excited to share that multi-user sync is now fully supported! Our first goal was to make sure the feature worked,
and since releasing it, weve worked hard to improve it based on feedback and testing. Were now confident that it works
as expected and are happy to invite you to start using it. To learn more and get started, please check out the FAQ entry
here: [this link](FAQ.md#is-there-support-for-multi-user-setup).
### 2025-01-18 ### 2025-01-18
Due to popular demand, we finally have added the ability to sync all users data, however, it's limited to only Due to popular demand, we finally have added the ability to sync all users data, however, it's limited to only

View File

@@ -9,6 +9,12 @@ out of the box, this tool support `Jellyfin`, `Plex` and `Emby` media servers.
## Updates ## Updates
### 2025-02-05
We have added initial support to browse the WebUI as sub user, it's still in early stages, only few Endpoints support it.
We have also added support to webhooks to allow sub users, you simply have to add new hooks using `user@backend`. Please
take look at [this FAQ](FAQ.md#how-to-add-webhooks) to learn how to use it for sub users.
### 2025-02-02 ### 2025-02-02
We are happy to announce that we have merged in direct support for multi-user in `state:import` and `state:export` We are happy to announce that we have merged in direct support for multi-user in `state:import` and `state:export`
@@ -30,13 +36,6 @@ this change shouldn't effect you as we have backward compatibility in place to r
for more information about multi-user, Please read the FAQ entry about it for more information about multi-user, Please read the FAQ entry about it
at [this link](FAQ.md#is-there-support-for-multi-user-setup). at [this link](FAQ.md#is-there-support-for-multi-user-setup).
### 2025-01-24
We are excited to share that multi-user sync is now fully supported! Our first goal was to make sure the feature worked,
and since releasing it, weve worked hard to improve it based on feedback and testing. Were now confident that it works
as expected and are happy to invite you to start using it. To learn more and get started, please check out the FAQ entry
here: [this link](FAQ.md#is-there-support-for-multi-user-setup).
--- ---
Refer to [NEWS](NEWS.md) for old updates. Refer to [NEWS](NEWS.md) for old updates.