Skip to content

Commit 262f5e5

Browse files
docs(integrations): add app linking and access control (#445)
1 parent c788d98 commit 262f5e5

File tree

3 files changed

+23
-5
lines changed

3 files changed

+23
-5
lines changed
12.5 KB
Loading
14.6 KB
Loading

docs/management/integrations/index.mdx

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,42 @@ Must be at least 1 character long, can be chosen freely.
2525
### Url
2626
This must be the base URL of the application where Homarr should connect to.
2727
A few examples for this field include:
28-
- sabnzbd.example.com
29-
- example.com/sabnzbd
28+
- http://sabnzbd.example.com
29+
- https://example.com/sabnzbd
3030

3131
You must not append any path after the base URL. Some examples for incorrect usage:
32-
- sabnzbd.example.com/settings
33-
- example.com/sabnzbd/settings
32+
- http://sabnzbd.example.com/settings
33+
- https://example.com/sabnzbd/settings
3434

3535
### Secrets
3636
An integration may or may not require secrets to function.
3737
To process to obtain them is usually [documented in the integration pages](/docs/category/integrations).
3838
Secrets are encrypted using a symmetric encryption and stored in the database.
39-
To improve security, they will never be passed to the client and requests to the integrations are performed from the host where Hoamrr is running on.
39+
To improve security, they will never be passed to the client and requests to the integrations are performed from the host where Homarr is running on.
40+
41+
### Linking applications
42+
43+
During the creation of an integration you can choose to add / link an application to the integration.
44+
If you want to add one, you can simply specify the app url which will be used for opening the application from Homarr.
45+
The linked application will also be used for any links the integration widget contains.
46+
If you already have an application created, you can also link it to the integration by selecting it from the dropdown.
47+
On the edit page you can always change or remove the linked application.
4048

4149
### Testing and saving integration
4250
It is not allowed to create an integration without passing the test.
4351
This is to ensure that you minimize the amount of broken applications on your Homarr instance.
4452
The test and create button will perform a network request to the application and authenticate if required.
4553

54+
## Managing permissions
55+
56+
On the edit page of an integration, you can manage which users / groups can
57+
58+
- **Select the integration in items:** Allows users to select the integration and showing data on their board.
59+
- **Interact with the integration:** Allows users to perform actions on the integration, such as pausing a download.
60+
- **Full control over the integration:** Allows users to modify the integration properties, including the URL and secrets.
61+
62+
![](./img/integration-permissions.png)
63+
4664
## Troubleshooting connection
4765
The connection to your integrations can fail due to many factors. Most of the time it should show you the reason why it failed.
4866
If it doesn't, you can follow these steps to troubleshoot the issue:

0 commit comments

Comments
 (0)