Overhaul end user documentation
This commit is contained in:
parent
9ed3c8ee15
commit
1ec7e1e8e5
97 changed files with 3240 additions and 1553 deletions
29
docs/user_documentation/subsonic/disable_subsonic.md
Normal file
29
docs/user_documentation/subsonic/disable_subsonic.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
# Disable Subsonic access
|
||||
|
||||
If you don't want to use Subsonic any more, you can disable access. This stops any Subsonic apps being able to log in to your account. To do this:
|
||||
|
||||
```{tabbed} Desktop
|
||||
|
||||
1. Log in to your account.
|
||||
2. Select the cog icon ({fa}`cog`) or your avatar to expand the user menu.
|
||||
3. Select {guilabel}`Settings`.
|
||||
4. Scroll to the {guilabel}`Subsonic API password` section.
|
||||
5. Select {guilabel}`Disable Subsonic access`.
|
||||
6. Select {guilabel}`Disable access` in the warning message that appears.
|
||||
7. The Subsonic password field shows {guilabel}`Access disabled`.
|
||||
|
||||
```
|
||||
|
||||
```{tabbed} Mobile
|
||||
|
||||
1. Log in to your account.
|
||||
2. Select the cog icon ({fa}`cog`) or your avatar to open the {guilabel}`Options` menu.
|
||||
3. Select {guilabel}`Settings`.
|
||||
4. Scroll to the {guilabel}`Subsonic API password` section.
|
||||
5. Select {guilabel}`Disable Subsonic access`.
|
||||
6. Select {guilabel}`Disable access` in the warning message that appears.
|
||||
7. The Subsonic password field shows {guilabel}`Access disabled`.
|
||||
|
||||
```
|
||||
|
||||
You're done! Subsonic apps can no longer access your account. You can re-enable the API at any time by [requesting a new password](subsonic_password).
|
||||
19
docs/user_documentation/subsonic/index.md
Normal file
19
docs/user_documentation/subsonic/index.md
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
# Subsonic access
|
||||
|
||||
```{note}
|
||||
{term}`Pod` admins can choose to disable access to the Subsonic API. If the Subsonic password option isn't available, contact your pod admin.
|
||||
```
|
||||
|
||||
Funkwhale supports a subset of the [Subsonic API](http://www.subsonic.org/pages/index.jsp). This enables you to use Subsonic apps to stream your Funkwhale content. Check out the guides in this section to manage your Subsonic access.
|
||||
|
||||
```{toctree}
|
||||
---
|
||||
maxdepth: 1
|
||||
caption: Manage your Subsonic access
|
||||
---
|
||||
|
||||
subsonic_password
|
||||
reset_subsonic
|
||||
disable_subsonic
|
||||
|
||||
```
|
||||
33
docs/user_documentation/subsonic/reset_subsonic.md
Normal file
33
docs/user_documentation/subsonic/reset_subsonic.md
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# Reset your Subsonic password
|
||||
|
||||
```{warning}
|
||||
Changing your Subsonic password logs you out of any Subsonic apps you are using. You need to log back in using your new password.
|
||||
```
|
||||
|
||||
You can reset your Subsonic password at any time. To do this:
|
||||
|
||||
```{tabbed} Desktop
|
||||
|
||||
1. Log in to your account.
|
||||
2. Select the cog icon ({fa}`cog`) or your avatar to expand the user menu.
|
||||
3. Select {guilabel}`Settings`.
|
||||
4. Scroll to the {guilabel}`Subsonic API password` section.
|
||||
5. Select {guilabel}`Request a new password`.
|
||||
6. Select {guilabel}`Request a new password` in the warning message that appears. The server generates a new password for you.
|
||||
7. Select the {guilabel}`copy` icon next to the password field to copy your password.
|
||||
|
||||
```
|
||||
|
||||
```{tabbed} Mobile
|
||||
|
||||
1. Log in to your account.
|
||||
2. Select the cog icon ({fa}`cog`) or your avatar to open the {guilabel}`Options` menu.
|
||||
3. Select {guilabel}`Settings`.
|
||||
4. Scroll to the {guilabel}`Subsonic API password` section.
|
||||
5. Select {guilabel}`Request a new password`.
|
||||
6. Select {guilabel}`Request a new password` in the warning message that appears. The server generates a new password for you.
|
||||
7. Select the {guilabel}`copy` icon next to the password field to copy your password.
|
||||
|
||||
```
|
||||
|
||||
That's it! Your new password is ready to use.
|
||||
27
docs/user_documentation/subsonic/subsonic_password.md
Normal file
27
docs/user_documentation/subsonic/subsonic_password.md
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# Request your Subsonic password
|
||||
|
||||
To access the Subsonic API, you need to request a Subsonic password. To do this:
|
||||
|
||||
```{tabbed} Desktop
|
||||
|
||||
1. Log in to your account.
|
||||
2. Select the cog icon ({fa}`cog`) or your avatar to expand the user menu.
|
||||
3. Select {guilabel}`Settings`.
|
||||
4. Scroll to the {guilabel}`Subsonic API password` section.
|
||||
5. Select {guilabel}`Request a password`. The server generates your password for you.
|
||||
6. Select the {guilabel}`copy` icon next to the password field to copy your password.
|
||||
|
||||
```
|
||||
|
||||
```{tabbed} Mobile
|
||||
|
||||
1. Log in to your account.
|
||||
2. Select the cog icon ({fa}`cog`) or your avatar to open the {guilabel}`Options` menu.
|
||||
3. Select {guilabel}`Settings`.
|
||||
4. Scroll to the {guilabel}`Subsonic API password` section.
|
||||
5. Select {guilabel}`Request a password`. The server generates your password for you.
|
||||
6. Select the {guilabel}`copy` icon next to the password field to copy your password.
|
||||
|
||||
```
|
||||
|
||||
Congratulations! You've got your Subsonic password. You can now enter this in your Subsonic app to start listening to Funkwhale content.
|
||||
Loading…
Add table
Add a link
Reference in a new issue