novaburst/funquail
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Overhaul end user documentation

Browse source
This commit is contained in:
Ciarán Ainsworth 2022-01-19 18:49:46 +00:00
commit 1ec7e1e8e5
97 changed files with 3240 additions and 1553 deletions
Download patch file Download diff file Expand all files Collapse all files

33
docs/user_documentation/accounts/activity_visibility.md Normal file
View file

@ -0,0 +1,33 @@
# Change your activity visibility
Your __activity visibility__ determines who can see your listening activity on Funkwhale. There are three visibility options:
- __Nobody except me__ – only you can see your listening activity.
- __Everyone on this instance__ – users who have an account on the same {term}`pod` as you can see your listening activity.
- __Everyone, across all instances__ – anybody can see your listening activity.
To change your activity visibility:
```{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. Find {guilabel}`Activity visibility` in the {guilabel}`Account settings` section.
5. Select your visibility level from the dropdown menu.
6. Select {guilabel}`Update settings` to save your changes.
```
```{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. Find {guilabel}`Activity visibility` in the {guilabel}`Account settings` section.
5. Select your visibility level from the dropdown menu.
6. Select {guilabel}`Update settings` to save your changes.
```
That's it! You've updated your activity visibility. This change takes effect as soon as you update your settings.

27
docs/user_documentation/accounts/add_avatar.md Normal file
View file

@ -0,0 +1,27 @@
# Add your avatar
You can upload an avatar to your account. Other users can see this when they visit your profile. To add an avatar:
```{tabbed} Desktop
1. Log in to your account.
2. Select the cog icon ({fa}`cog`) or your existing avatar to expand the user menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Avatar` section.
5. Select {guilabel}`Browse…` to open the file picker.
6. Select the image you want to use as your avatar and confirm.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the cog icon ({fa}`cog`) or your existing avatar to open the {guilabel}`Options` menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Avatar` section.
5. Select {guilabel}`Choose File` to open the file picker.
6. Select the image you want to use as your avatar and confirm.
```
Congratulations! You've updated your avatar.

29
docs/user_documentation/accounts/change_email.md Normal file
View file

@ -0,0 +1,29 @@
# Change your email address
You can update your email address whenever you need to. 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}`Change my e-mail address` section.
5. Enter your {guilabel}`New e-mail address`.
6. Enter your {guilabel}`Password`.
7. Select {guilabel}`Update`.
```
```{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}`Change my e-mail address` section.
5. Enter your {guilabel}`New e-mail address`.
6. Enter your {guilabel}`Password`.
7. Select {guilabel}`Update`.
```
That's it! If your pod admin has email verification enabled, you'll receive a confirmation email. Follow the instructions in this email to finish changing your email address.

33
docs/user_documentation/accounts/change_password.md Normal file
View file

@ -0,0 +1,33 @@
# Change your password
```{warning}
Changing your account password also changes your Subsonic API password. If you are using a Subsonic app, you need to update your password in the app as well.
```
You can update your account password whenever you need to. 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}`Change my password` section.
5. Enter your {guilabel}`Current password`.
6. Enter your {guilabel}`New password`.
7. Select {guilabel}`Change 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}`Change my password` section.
5. Enter your {guilabel}`Current password`.
6. Enter your {guilabel}`New password`.
7. Select {guilabel}`Change password`.
```
That's it! Your password is reset. You need to use your new password to log in from now on.

27
docs/user_documentation/accounts/check_quota.md Normal file
View file

@ -0,0 +1,27 @@
# Check your upload quota
Your {term}`pod` admin can assign users an __upload quota__. This is the amount of storage you have access to. Pod admins can assign a default quota to all users. They can also increase or decrease quotas for individual users. Your upload quota applies to content in [libraries](../libraries/index.md) and [channels](../channels/index.md).
If you run out of space, you can contact your pod admin to request more.
To check your upload quota:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. The {guilabel}`My libraries` screen appears showing your upload quota and your libraries.
5. The {guilabel}`Current usage` section shows you how much of your quota you are using.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. The {guilabel}`My libraries` screen appears showing your upload quota and your libraries.
5. The {guilabel}`Current usage` section shows you how much of your quota you are using.
```

44
docs/user_documentation/accounts/create_account.md Normal file
View file

@ -0,0 +1,44 @@
# Create your Funkwhale account
```{tip}
Use our [Pod Picker tool](https://network.funkwhale.audio/dashboards/d/overview/network-overview) to find the perfect pod for you!
```
To use Funkwhale, you need to create an account on a {term}`Funkwhale pod <Pod>`. Signing up to a pod requires the following information:
- A valid email address. Administrators can use this to verify you are not a bot.
- A username.
- A password.
## Check your pod's policies
Before you sign up to a pod, you should check its __policies__. You can find these by navigating to the pod's {guilabel}`About this pod` page.
1. Navigate to the pod.
2. Select the {guilabel}`About this pod` link in the sidebar.
3. Select the {guilabel}`Learn more` button in the {guilabel}`About this pod` section.
Administrators can add a pod's {guilabel}`Rules` and {guilabel}`Terms and privacy policy` to this page. Make sure to read through them before signing up. Also check the {guilabel}`Upload quota` to see how much space users have access to.
## Sign up
Once you've found an instance you like the look of, you can create your account.
1. Select the {guilabel}`Create an account` button in the sidebar.
2. Enter the {guilabel}`Username` you have chosen.
3. Enter your {guilabel}`Email` address.
4. Enter your {guilabel}`Password`.
5. Pod administrators can add extra requirements for new accounts. Fields marked with an asterisk ({guilabel}`*`) are required.
6. Select {guilabel}`Create my account`.
7. Pod administrators may require you to verify your email address before you can use your account. Check your email for more instructions.
## Log in
When you've created and activated your account, you can log in.
1. Select the {guilabel}`Login` button in the sidebar.
2. Enter your {guilabel}`Username or e-mail address`.
3. Enter your {guilabel}`Password`.
4. Select {guilabel}`Login`.
Congratulations! You've set up your Funkwhale account. Check out what you can do now in our user documentation.

45
docs/user_documentation/accounts/delete_account.md Normal file
View file

@ -0,0 +1,45 @@
# Delete your Funkwhale account
If you have decided you no longer want your Funkwhale account, you can delete it. This action removes your profile and all your data from your {term}`pod`, including:
- Your user avatar.
- Your email address.
- The list of your followers.
- Music files you have uploaded.
- Radios you have created.
- Playlists you have created.
- Your favorites.
When you delete your account, your pod sends a message to other Funkwhale pods notifying them. If these pods hold any of your data, they should also delete it.
```{note}
Other pods should delete local copies of your data in compliance with your request. There is no guarantee that they will do so, and some data may remain available. This can happen if a pod is offline or unavailable when your pod sends out the deletion message.
```
To delete your account:
```{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}`Delete my account` section.
5. Enter your {guilabel}`Password`.
6. Select {guilabel}`Delete my account…`.
7. Select {guilabel}`Delete my account` on the warning notice that appears.
```
```{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}`Delete my account` section.
5. Enter your {guilabel}`Password`.
6. Select {guilabel}`Delete my account…`.
7. Select {guilabel}`Delete my account` on the warning notice that appears.
```
That's it! You've deleted your account. You can [create another account](create_account.md) at any time.

25
docs/user_documentation/accounts/delete_avatar.md Normal file
View file

@ -0,0 +1,25 @@
# Remove your avatar
If you don't want to have an avatar any more, you can remove it. To do this:
```{tabbed} Desktop
1. Log in to your account.
2. Select your avatar to expand the user menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Avatar` section.
5. Select {guilabel}`Remove`.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select your avatar to open the {guilabel}`Options` menu.
3. Select {guilabel}`Settings`.
4. Scroll down to the {guilabel}`Avatar` section.
5. Select {guilabel}`Remove`.
```
That's it! You've removed your avatar from your account. Other users will only see the initials of your username when they visit your profile.

31
docs/user_documentation/accounts/index.md Normal file
View file

@ -0,0 +1,31 @@
# Your account
Your Funkwhale account is the key to your Funkwhale experience. Creating an account on a {term}`pod` gives you the ability to upload content, follow channels, and listen to audio.
Follow the guides in this section to manage your Funkwhale account.
```{toctree}
---
maxdepth: 1
caption: Manage your account
---
create_account
check_quota
delete_account
```
```{toctree}
---
maxdepth: 1
caption: Change account settings
---
change_email
change_password
add_avatar
delete_avatar
activity_visibility
```

99
docs/user_documentation/channels/create_channel.md Normal file
View file

@ -0,0 +1,99 @@
# Create a channel
```{warning}
Your channel's __Fediverse handle__ needs to be unique. This is how other {term}`Fediverse` software identifies your channel. You can't change the __Fediverse handle__ once you've created your channel.
```
Create a channel to start publishing your content on your {term}`Funkwhale pod <Pod>`. Users can access channel content from Funkwhale or other Fediverse software.
You can create two types of channel:
```{contents}
:local:
```
## Artist discography
To create an __Artist discography__ channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select {guilabel}`+ Add new` next to the {guilabel}`Channels` header. A {guilabel}`Create channel` pop-up window appears.
5. Select {guilabel}`Artist discography` and select {guilabel}`Next step`. The {guilabel}`Artist channel` form appears.
6. Enter the {guilabel}`Name` of your channel. Users see this when they visit your channel page.
7. Enter the {guilabel}`Fediverse handle` of your channel. This is how other Fediverse software identifies your channel.
8. __Optional__ – upload a {guilabel}`Channel picture`. Users see this when they visit your channel page. Select {guilabel}`Browse…` to open a file picker.
9. __Optional__ – add {guilabel}`Tags` that describe your channel. Start typing in the {guilabel}`Search…` input box to find existing tags. You can also create new tags by typing them in and selecting them or hitting {kbd}`⏎ Return`.
10. __Optional__ – enter a {guilabel}`Description` of your channel. You can {guilabel}`Write` using [Markdown](https://www.markdownguide.org/) syntax and {guilabel}`Preview` how it will look. Users see this when they visit your channel page.
11. Select {guilabel}`Create channel` to create your channel.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select {guilabel}`+ Add new` next to the {guilabel}`Channels` header. A {guilabel}`Create channel` pop-up window appears.
5. Select {guilabel}`Artist discography` and select {guilabel}`Next step`. The {guilabel}`Artist channel` form appears.
6. Enter the {guilabel}`Name` of your channel. Users see this when they visit your channel page.
7. Enter the {guilabel}`Fediverse handle` of your channel. This is how other Fediverse software identifies your channel.
8. __Optional__ – upload a {guilabel}`Channel picture`. Users see this when they visit your channel page. Select {guilabel}`Browse…` to open a file picker.
9. __Optional__ – add {guilabel}`Tags` that describe your channel. Start typing in the {guilabel}`Search…` input box to find existing tags. You can also create new tags by typing them in and selecting them or hitting {kbd}`⏎ Return`.
10. __Optional__ – enter a {guilabel}`Description` of your channel. You can {guilabel}`Write` using [Markdown](https://www.markdownguide.org/) syntax and {guilabel}`Preview` how it will look. Users see this when they visit your channel page.
11. Select {guilabel}`Create channel` to create your channel.
```
That's it! You've created your artist channel. You can now [add some music to it](upload_artist.md).
## Podcast
To create a __Podcast__ channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select {guilabel}`+ Add new` next to the {guilabel}`Channels` header. A {guilabel}`Create channel` pop-up window appears.
5. Select {guilabel}`Podcasts` and select {guilabel}`Next step`. The {guilabel}`Podcast channel` form appears.
6. Enter the {guilabel}`Name` of your channel. Users see this when they visit your channel page.
7. Enter the {guilabel}`Fediverse handle` of your channel. This is how other Fediverse software identifies your channel.
8. __Optional__ – upload a {guilabel}`Channel picture`. Users see this when they visit your channel page. Select {guilabel}`Browse…` to open a file picker.
9. __Optional__ – add {guilabel}`Tags` that describe your channel. Start typing in the {guilabel}`Search…` input box to find existing tags. You can also create new tags by typing them in and selecting them or hitting {kbd}`⏎ Return`.
10. Choose the {guilabel}`Language` of your podcast.
11. __Optional__ – enter a {guilabel}`Description` of your channel. You can {guilabel}`Write` using [Markdown](https://www.markdownguide.org/) syntax and {guilabel}`Preview` how it will look. Users see this when they visit your channel page.
12. Select the {guilabel}`Category` of your podcast. {term}`Podcatchers<Podcatcher>` use this information to sort your podcast content.
13. __Optional__ – select the {guilabel}`Subcategory` of your podcast.
14. __Optional__ – enter the {guilabel}`Owner e-mail address`. This populates the ``itunes:email`` field of your podcast's {abbr}`RSS (Really Simple Syndication)` feed.
15. __Optional__ – enter the {guilabel}`Owner name`. This populates the ``itunes:name`` field of your podcast's {abbr}`RSS (Really Simple Syndication)` feed.
16. Select {guilabel}`Create channel` to create your channel.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select {guilabel}`+ Add new` next to the {guilabel}`Channels` header. A {guilabel}`Create channel` pop-up window appears.
5. Select {guilabel}`Podcasts` and select {guilabel}`Next step`. The {guilabel}`Podcast channel` form appears.
6. Enter the {guilabel}`Name` of your channel. Users see this when they visit your channel page.
7. Enter the {guilabel}`Fediverse handle` of your channel. This is how other Fediverse software identifies your channel.
8. __Optional__ – upload a {guilabel}`Channel picture`. Users see this when they visit your channel page. Select {guilabel}`Browse…` to open a file picker.
9. __Optional__ – add {guilabel}`Tags` that describe your channel. Start typing in the {guilabel}`Search…` input box to find existing tags. You can also create new tags by typing them in and selecting them or hitting {kbd}`⏎ Return`.
10. Choose the {guilabel}`Language` of your podcast.
11. __Optional__ – enter a {guilabel}`Description` of your channel. You can {guilabel}`Write` using [Markdown](https://www.markdownguide.org/) syntax and {guilabel}`Preview` how it will look. Users see this when they visit your channel page.
12. Select the {guilabel}`Category` of your podcast. {term}`Podcatchers<Podcatcher>` use this information to sort your podcast content.
13. __Optional__ – select the {guilabel}`Subcategory` of your podcast.
14. __Optional__ – enter the {guilabel}`Owner e-mail address`. This populates the ``itunes:email`` field of your podcast's {abbr}`RSS (Really Simple Syndication)` feed.
15. __Optional__ – enter the {guilabel}`Owner name`. This populates the ``itunes:name`` field of your podcast's {abbr}`RSS (Really Simple Syndication)` feed.
16. Select {guilabel}`Create channel` to create your channel.
```
You're done! You've created your podcast channel. Now you can [add some episodes to it](upload_podcast.md).

81
docs/user_documentation/channels/delete_artist.md Normal file
View file

@ -0,0 +1,81 @@
# Delete content from an Artist channel
You can delete content from your artist channel. This means that your followers won't be able to listen to the deleted content any more.
```{contents}
:local:
```
## Delete a track
```{warning}
Deleting a track also deletes the file from your {term}`Funkwhale pod <Pod>`. This action is irreversible.
```
To delete a single track from a channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) next to the track in question. This opens the track options menu.
6. Select {guilabel}`ℹ︎ Track details`. The track details page opens.
7. Select the kebab menu ({fa}`ellipsis-v`) at the top of the page.
8. Select {guilabel}`Delete…`. A {guilabel}`Delete this track?` warning appears.
9. Select {guilabel}`Delete` to delete the track.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) next to the track in question. This opens the track options menu.
6. Select {guilabel}`ℹ︎ Track details`. The track details page opens.
7. Select the kebab menu ({fa}`ellipsis-v`) at the top of the page.
8. Select {guilabel}`Delete…`. A {guilabel}`Delete this track?` warning appears.
9. Select {guilabel}`Delete` to delete the track.
```
That's it! You've deleted your track. You can add it again by [uploading it to your channel](upload_artist.md).
## Delete an album
```{warning}
Deleting an album also deletes all tracks in the album and removes the files from the server. This action is irreversible.
```
Delete an album to remove all tracks it contains. To do this:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select your album in the {guilabel}`Albums` section. The album detail page opens.
6. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
7. Select {guilabel}`Delete…`. A {guilabel}`Delete this album?` warning appears.
8. Select {guilabel}`Delete` to delete the album.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select your album in the {guilabel}`Albums` section. The album detail page opens.
6. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
7. Select {guilabel}`Delete…`. A {guilabel}`Delete this album?` warning appears.
8. Select {guilabel}`Delete` to delete the album.
```
You're done! You've deleted the album and all the tracks it contained. You can add them again by [uploading it to your channel](upload_artist.md).

33
docs/user_documentation/channels/delete_channel.md Normal file
View file

@ -0,0 +1,33 @@
# Delete a channel
```{warning}
Deleting a channel is irreversible. If you delete a channel you also delete the content associated with it. Users won't be able to access the channel any more. You can't re-use the channel's __Fediverse handle__ for another channel.
```
If you want to delete your channel, follow these steps:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Delete…`. A {guilabel}`Delete this Channel?` warning message appears
7. Select {guilabel}`Delete`.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Delete…`. A {guilabel}`Delete this Channel?` warning message appears
7. Select {guilabel}`Delete`.
```
That's it! You deleted your channel.

81
docs/user_documentation/channels/delete_podcast.md Normal file
View file

@ -0,0 +1,81 @@
# Delete content from a Podcast channel
You can delete content from your podcast channel. This means that your followers won't be able to listen to the deleted content any more.
```{contents}
:local:
```
## Delete an episode
```{warning}
Deleting an episode also deletes the file from the {term}`pod`. This action is irreversible.
```
To delete a single episode from a channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) next to the episode in question. This opens the track options menu.
6. Select {guilabel}`ℹ︎ Episode details`. The episode details page opens.
7. Select the kebab menu ({fa}`ellipsis-v`) at the top of the page.
8. Select {guilabel}`Delete…`. A {guilabel}`Delete this track?` warning appears.
9. Select {guilabel}`Delete` to delete the episode.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) next to the episode in question. This opens the track options menu.
6. Select {guilabel}`ℹ︎ Episode details`. The episode details page opens.
7. Select the kebab menu ({fa}`ellipsis-v`) at the top of the page.
8. Select {guilabel}`Delete…`. A {guilabel}`Delete this track?` warning appears.
9. Select {guilabel}`Delete` to delete the episode.
```
That's it! You've deleted your episode. You can add it again by [uploading it to your channel](upload_podcast.md).
## Delete a series
```{warning}
Deleting a series also deletes all episodes in the series and deletes the files from the {term}`pod`. This action is irreversible.
```
Delete a series to remove all episodes it contains. To do this:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select your series in the {guilabel}`Series` section. The series detail page opens.
6. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
7. Select {guilabel}`Delete…`. A {guilabel}`Delete this album?` warning appears.
8. Select {guilabel}`Delete` to delete the series.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel containing the content under the {guilabel}`Channels` header. The channel's page opens.
5. Select your series in the {guilabel}`Series` section. The series detail page opens.
6. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
7. Select {guilabel}`Delete…`. A {guilabel}`Delete this album?` warning appears.
8. Select {guilabel}`Delete` to delete the series.
```
You're done! You've deleted the series and all the episodes it contained. You can add them again by [uploading it to your channel](upload_podcast.md).

103
docs/user_documentation/channels/edit_channel.md Normal file
View file

@ -0,0 +1,103 @@
# Edit a channel
```{note}
You can't change a channel's __Fediverse handle__.
```
Channels are like user profiles on other {term}`Fediverse` software. This means you can edit their details at any time to reflect changes you've made.
You can change different details depending on what type of channel you are editing:
```{contents}
:local:
```
## Edit an Artist channel
To edit an __Artist channel__:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Edit…`. The {guilabel}`Artist channel` form appears.
7. Change the details in any of these fields:
- {guilabel}`Name`
- {guilabel}`Channel Picture`
- {guilabel}`Tags`
- {guilabel}`Description`
8. Select {guilabel}`Update channel` to save your changes.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Edit…`. The {guilabel}`Artist channel` form appears.
7. Change the details in any of these fields:
- {guilabel}`Name`
- {guilabel}`Channel Picture`
- {guilabel}`Tags`
- {guilabel}`Description`
8. Select {guilabel}`Update channel` to save your changes.
```
That's it! You've updated your channel details. Users see the new details when they visit your channel page.
## Edit a Podcast channel
To edit a __Podcast channel__:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Edit…`. The {guilabel}`Artist channel` form appears.
7. Change the details in any of these fields:
- {guilabel}`Name`
- {guilabel}`Channel Picture`
- {guilabel}`Tags`
- {guilabel}`Language`
- {guilabel}`Description`
- {guilabel}`Category`
- {guilabel}`Subcategory`
- {guilabel}`Owner e-mail address`
- {guilabel}`Owner name`
8. Select {guilabel}`Update channel` to save your changes.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to delete under the {guilabel}`Channels` header. The channel's page opens.
5. Select the kebab menu ({fa}`ellipsis-v`) to show the channel options.
6. Select {guilabel}`Edit…`. The {guilabel}`Artist channel` form appears.
7. Change the details in any of these fields:
- {guilabel}`Name`
- {guilabel}`Channel Picture`
- {guilabel}`Tags`
- {guilabel}`Language`
- {guilabel}`Description`
- {guilabel}`Category`
- {guilabel}`Subcategory`
- {guilabel}`Owner e-mail address`
- {guilabel}`Owner name`
8. Select {guilabel}`Update channel` to save your changes.
```
You're done! Users see the new details when they visit your channel page. The changes also reflect on your podcast's {abbr}`RSS (Really Simple Syndication)` feed.

58
docs/user_documentation/channels/follow_channel.md Normal file
View file

@ -0,0 +1,58 @@
# Follow a channel
Get access to a channel's content by following it. Following a channel makes its content visible to all users on your {term}`pod`.
You can follow channels in a few different ways:
```{contents}
:local:
````
## Follow a channel on your pod
If a user on your pod follows a channel or has published a channel, you can follow it from your pod. To do this:
1. Select the channel you want to follow. The channel details page opens.
2. Select the {guilabel}`Subscribe` button. The label changes to {guilabel}`Subscribed`.
That's it! You've subscribed to the channel. You can see the channel in the {guilabel}`Channels` page.
## Follow a remote channel
To follow a channel located on another pod, you need its __Federation handle__. A __Federation handle__ uses the following format: ``@{username}@{domain}``. Once you have the channel's __Federation handle__, you can follow it from the {guilabel}`Channels` page. To do this:
```{tabbed} Desktop
1. Select {guilabel}`Channels` in the sidebar. The {guilabel}`Channels` page opens.
2. Select {guilabel}`+ Add new` at the top of the page. The {guilabel}`Subscriptions` screen appears.
3. Select {guilabel}`Fediverse`.
4. Enter the channel's __Federation handle__ in the {guilabel}`Fediverse object` input.
5. Select {guilabel}`Subscribe`. The channel details page appears.
6. Select the {guilabel}`Subscribe}` button. The label changes to {guilabel}`Subscribed`.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {guilabel}`Channels`. The {guilabel}`Channels` page opens.
3. Select {guilabel}`+ Add new` at the top of the page. The {guilabel}`Subscriptions` screen appears.
4. Select {guilabel}`Fediverse`.
5. Enter the channel's __Federation handle__ in the {guilabel}`Fediverse object` input.
6. Select {guilabel}`Subscribe`. The channel details page appears.
7. Select the {guilabel}`Subscribe}` button. The label changes to {guilabel}`Subscribed`.
```
That's it! You can now see the channel's content on your pod. Other users of your pod can also see this channel.
## Follow a Funkwhale podcast with a podcatcher
You can follow podcasts published in channels using a standard podcatcher. To do this:
1. Select the channel you want to follow. The channel details page opens.
2. Select the feed button ({fa}`feed`). The {guilabel}`Subscribe to this channel` window appears.
3. Select {guilabel}`Copy` under the {guilabel}`Subscribe via RSS` to copy the channel's {abbr}`RSS (Really Simple Syndication)` feed URL.
4. Paste the URL in your podcatcher.
That's it! Your podcatcher fetches the podcast details from Funkwhale.

46
docs/user_documentation/channels/index.md Normal file
View file

@ -0,0 +1,46 @@
# Channels
Use channels to publish your own audio content on Funkwhale. Channels enable you to create and share your creations with the whole {term}`Fediverse`.
Funkwhale supports two types of channel:
- __Podcasts__ – broadcast your podcast over the Fediverse. Listeners can also use their favorite {term}`podcatcher` to listen to podcasts using {abbr}`RSS (Really Simple Syndication)`.
- __Artist Discography__ – upload your own music and create a following.
Follow the guides in this section to get started.
```{toctree}
---
caption: Manage your channels
maxdepth: 1
---
create_channel
edit_channel
delete_channel
```
```{toctree}
---
caption: Manage channel content
maxdepth: 1
---
upload_artist
upload_podcast
delete_artist
delete_podcast
```
```{toctree}
---
caption: Follow channels
maxdepth: 1
---
follow_channel
subscribe_rss
```

30
docs/user_documentation/channels/subscribe_rss.md Normal file
View file

@ -0,0 +1,30 @@
# Subscribe to an RSS feed
```{note}
Other users on your pod can't see podcasts you import using RSS. They need to subscribe to the feed themselves.
```
You can use Funkwhale as a {term}`podcatcher` to listen to your favorite podcasts. Funkwhale can read {abbr}`RSS (Really Simple Syndication)` feeds to import podcasts. To add an RSS feed to Funkwhale:
```{tabbed} Desktop
1. Select {guilabel}`Channels` in the sidebar. The {guilabel}`Channels` page opens.
2. Select {guilabel}`+ Add new` at the top of the page. The {guilabel}`Subscriptions` screen appears.
3. Select {guilabel}`RSS`.
4. Enter the URL of the RSS feed in the {guilabel}`RSS feed location` input.
5. Select {guilabel}`Subscribe`.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {guilabel}`Channels`. The {guilabel}`Channels` page opens.
3. Select {guilabel}`+ Add new` at the top of the page. The {guilabel}`Subscriptions` screen appears.
4. Select {guilabel}`RSS`.
5. Enter the URL of the RSS feed in the {guilabel}`RSS feed location` input.
6. Select {guilabel}`Subscribe`.
```
That's it! Your favorite podcast is now available in the {guilabel}`Channels` page. Funkwhale updates the feed to make sure you always have the latest episodes.

147
docs/user_documentation/channels/upload_artist.md Normal file
View file

@ -0,0 +1,147 @@
# Upload content to an Artist channel
Once you have [created a channel](create_channel.md), you can start to add content to it. Users who follow your channel can see and play your content from their {term}`pods <Pod>`.
You can also create albums to organize your channel content.
```{contents}
:local:
```
## Create an album (optional)
Albums are a good way of organizing your content. You can create as many albums as you want. To create a new album:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add an album to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`+ Add new` next to the {guilabel}`Albums` section. A {guilabel}`New album` screen appears.
6. Enter the {guilabel}`Title` of your album.
7. Select {guilabel}`Create` to create your new album. The album appears on the screen.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add an album to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`+ Add new` next to the {guilabel}`Albums` section. A {guilabel}`New album` screen appears.
6. Enter the {guilabel}`Title` of your album.
7. Select {guilabel}`Create` to create your new album. The album appears on the screen.
```
Once you've created your album, you can add some details to it. To do this:
1. Select the album. The album details screen opens.
2. Select the kebab menu ({fa}`ellipsis-v`) to show the album options.
3. Select {guilabel}`Edit`. The {guilabel}`Edit this album` screen opens.
4. Change the details in any of these fields:
- {guilabel}`Title` – the title of the album.
- {guilabel}`Description` – a description of the album.
- {guilabel}`Release date` – the release date of the album.
- {guilabel}`Cover` – the cover art of the album.
- {guilabel}`Tags` – the genre of the album.
5. __Optional__ – enter a {guilabel}`Summary` of your changes.
6. Select {guilabel}`Submit and apply edit` to save your changes.
That's it! You can now add content to your album.
## Add your content
To add content to your channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Album`](#create-an-album-optional) you want to publish the music in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. Click on the section marked {guilabel}`Browse…` to open a file picker, or drag and drop your files on to it.
- If you opened the file picker, select the files you want to upload and confirm.
11. The files appear at the top when you upload them. Select {guilabel}`Remove` to remove them.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Album`](#create-an-album-optional) you want to publish the music in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. Click on the section marked {guilabel}`Browse…` to open a file picker. Select the files you want to upload and confirm.
11. The files appear at the top when you upload them. Select {guilabel}`Remove` to remove them.
```
### Edit your uploads
Once you have uploaded your files, you can change their details. To do this:
1. Select the edit icon ({fa}`edit`) to edit the track details. The {guilabel}`Upload details` screen appears.
2. Change the details in any of these fields:
- {guilabel}`Title` – the title of the track
- {guilabel}`Track Picture` – the picture that shows up next to the track.
- {guilabel}`Tags` – the genre of the track.
- {guilabel}`Position` – the position of the track in the album.
- {guilabel}`Description` – a description of the track.
3. Select {guilabel}`Update` to save the track details.
4. Do this for all tracks you want to publish.
5. Select {guilabel}`Publish` to publish the content. To save the content to [upload later](#continue-your-upload-later), select {menuselection}`Down arrow --> Finish later`.
That's it! You've added content to your channel. Your followers can now listen to your content from their pods.
## Continue your upload later
If you selected {guilabel}`Finish later`, Funkwhale saves your files and edits. You can continue your upload later by doing the following:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Album`](#create-an-album-optional) you want to publish the music in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. If there are pending uploads, a {guilabel}`You have some draft uploads pending publication` note shows. Select {guilabel}`Resume` to resume your upload.
11. [Add new files](#add-your-content) or [edit the pending files](#edit-your-uploads).
12. Once you're finished, select {guilabel}`Publish` to publish your music.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Album`](#create-an-album-optional) you want to publish the music in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. If there are pending uploads, a {guilabel}`You have some draft uploads pending publication` note shows. Select {guilabel}`Resume` to resume your upload.
11. [Add new files](#add-your-content) or [edit the pending files](#edit-your-uploads).
12. Once you're finished, select {guilabel}`Publish` to publish your music.
```
Congratulations! You've finished uploading the saved content. Your followers can now listen to your content from their pods.

147
docs/user_documentation/channels/upload_podcast.md Normal file
View file

@ -0,0 +1,147 @@
# Upload content to an Podcast channel
Once you have [created a channel](create_channel.md), you can start to add content to it. Users who follow your channel can see and play your content from their {term}`pods <Pod>`.
You can also create series to organize your channel content.
```{contents}
:local:
```
## Create a series (optional)
Series are a good way of organizing your content. You can create as many series as you want. To create a new series:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add a series to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`+ Add new` next to the {guilabel}`Series` section. A {guilabel}`New album` screen appears.
6. Enter the {guilabel}`Title` of your series.
7. Select {guilabel}`Create` to create your new series. The series appears on the screen.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add a series to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`+ Add new` next to the {guilabel}`Series` section. A {guilabel}`New album` screen appears.
6. Enter the {guilabel}`Title` of your series.
7. Select {guilabel}`Create` to create your new series. The series appears on the screen.
```
Once you've created your series, you can add some details to it. To do this:
1. Select the series. The series details screen opens.
2. Select the kebab menu ({fa}`ellipsis-v`) to show the album options.
3. Select {guilabel}`✎ Edit`. The {guilabel}`Edit this album` screen opens.
4. Change the details in any of these fields:
- {guilabel}`Title` – the title of the series.
- {guilabel}`Description` – a description of the series.
- {guilabel}`Release date` – the date on which the series aired.
- {guilabel}`Cover` – a cover image for the series.
- {guilabel}`Tags` – tags relating to the series' content.
5. __Optional__ – enter a {guilabel}`Summary` of your changes.
6. Select {guilabel}`Submit and apply edit` to save your changes.
That's it! Your series is ready to use.
## Add your content
To add content to your channel:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Series`](#create-a-series-optional) you want to publish the content in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. Click on the section marked {guilabel}`Browse…` to open a file picker, or drag and drop your files on to it.
- If you opened the file picker, select the files you want to upload and confirm.
11. The files appear at the top when you upload them. Select {guilabel}`Remove` to remove them.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Series`](#create-a-series-optional) you want to publish the content in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. Click on the section marked {guilabel}`Browse…` to open a file picker. Select the files you want to upload and confirm.
11. The files appear at the top when you upload them. Select {guilabel}`Remove` to remove them.
```
### Edit your uploads
Once you have uploaded your files, you can change their details. To do this:
1. Select the edit icon ({fa}`edit`) to edit the track details. The {guilabel}`Upload details` screen appears.
2. Change the details in any of these fields:
- {guilabel}`Title` – the title of the episode
- {guilabel}`Track Picture` – the picture that shows up next to the episode.
- {guilabel}`Tags` – tags relating to the episode content.
- {guilabel}`Position` – the position of the track in the series.
- {guilabel}`Description` – a description of the track.
3. Select {guilabel}`Update` to save the track details.
4. Do this for all episodes you want to publish.
5. Select {guilabel}`Publish` to publish the content. To save the content to upload later, select {menuselection}`Down arrow --> Finish later`.
That's it! You've added content to your channel. Your followers can now listen to your content from their pods or podcatchers.
## Continue your upload later
If you selected {guilabel}`Finish later`, Funkwhale saves your files and edits. You can continue your upload later by doing the following:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Series`](#create-a-series-optional) you want to publish the content in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. If there are pending uploads, a {guilabel}`You have some draft uploads pending publication` note shows. Select {guilabel}`Resume` to resume your upload.
11. [Add new files](#add-your-content) or [edit the pending files](#edit-your-uploads).
12. Once you're finished, select {guilabel}`Publish` to publish your music.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Publish your work in a channel`. Your user profile opens.
4. Select the channel you want to add content to under the {guilabel}`Channels` header. The channel's page opens.
5. Select {guilabel}`⇧ Upload`. The {guilabel}`Publish audio` screen appears.
6. Select the {guilabel}`Channel` you want to publish your audio in. This populates with the channel you selected by default.
7. __Optional__ – choose which [{guilabel}`Series`](#create-a-series-optional) you want to publish the content in.
8. __Optional__ – choose a {guilabel}`License` to apply to your music. Funkwhale supports [Creative Commons](https://creativecommons.org/) licenses.
9. Select {guilabel}`Next step`. The {guilabel}`Files to upload` screen appears.
10. If there are pending uploads, a {guilabel}`You have some draft uploads pending publication` note shows. Select {guilabel}`Resume` to resume your upload.
11. [Add new files](#add-your-content) or [edit the pending files](#edit-your-uploads).
12. Once you're finished, select {guilabel}`Publish` to publish your music.
```
Congratulations! You've finished uploading the saved content. Your followers can now listen to your content from their pods.

57
docs/user_documentation/favorites/add_favorites.md Normal file
View file

@ -0,0 +1,57 @@
# Add tracks to your favorites
You can add tracks to your favorites list at any time. There are a few ways you can add tracks to your favorites:
```{contents}
:local:
```
## Add the currently playing track
To add the currently playing track to your favorites, do one of the following:
```{tabbed} Desktop
- Select the gray heart icon ({fa}`heart`) on the player bar. The heart turns pink to show that the track is in your favorites.
- Hit the {kbd}`l` key on your keyboard. The heart icon on the player turns pink to show that the track is in your favorites.
```
```{tabbed} Mobile
- Select the player at the bottom of the screen to expand it. Select the gray heart icon ({fa}`heart`) under the track art. The heart turns pink to show that the track is in your favorites.
```
That's all there is to it! The currently playing track is now in your favorites list.
## Add a track from a track table
You can favorite tracks on any page with a track table. This includes artist pages, album pages, and the search page. To favorite tracks on the track table:
```{tabbed} Desktop
1. Find your track in a track table.
2. Hover over the track row. A gray heart icon ({fa}`heart`) appears.
3. Select the heart icon. The heart turns pink to show that the track is in your favorites.
```
```{tabbed} Mobile
1. Find your track in a track table.
2. Tap on the kebab menu ({fa}`ellipsis-v`) on the track row. The track menu opens.
3. Select {guilabel}`Add to favorites`. The heart turns pink to show that the track is in your favorites.
```
You're done! The track is in your favorites.
## Add a track from the track details page
You can add a track to your favorites from its details page. To do this:
1. Go to the track's details page.
2. Select the gray heart icon ({fa}`heart`) at the top of the screen. The heart turns pink to show that the track is in your favorites.
That's it! The track is in your favorites.

14
docs/user_documentation/favorites/index.md Normal file
View file

@ -0,0 +1,14 @@
# Favorites
Your favorites is a list of tracks you've liked while listening on Funkwhale. Follow the guides in this section to manage your favorites.
```{toctree}
---
caption: Manage your favorites
maxdepth: 1
---
add_favorites
remove_favorites
```

82
docs/user_documentation/favorites/remove_favorites.md Normal file
View file

@ -0,0 +1,82 @@
# Remove tracks from your favorites
If you no longer want a track in your favorites list, you can remove it. There are a few ways to do this.
```{contents}
:local:
```
## Remove tracks from your favorites page
The easiest way to remove tracks from your favorites is using the __Favorites__ page. This page includes a list of all your favorites. To remove a track from this page:
```{tabbed} Desktop
1. Select {guilabel}`Favorites` under the {guilabel}`My Library` section in the sidebar. The {guilabel}`Favorites` page opens.
2. Use the filters to find the track you want to remove.
3. Select the pink heart icon ({fa}`heart`) next to the track you want to remove. The heart turns gray to show that the track isn't in your favorites.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {guilabel}`My Library`.
3. Select {guilabel}`Favorites`. The {guilabel}`Favorites` page opens.
4. Use the filters to find the track you want to remove.
5. Tap on the kebab menu ({fa}`ellipsis-v`) on the track row. The track menu opens.
6. Select {guilabel}`Remove from favorites`. The heart turns gray to show that the track isn't in your favorites.
```
That's all there is to it! You've removed the track from your favorites.
## Remove the currently playing track from your favorites
If you favorited the current track and want to remove it from your favorites, do one of the following:
```{tabbed} Desktop
- Select the pink heart icon ({fa}`heart`) on the player bar. The heart turns gray to show that the track isn't in your favorites.
- Hit the {kbd}`l` key on your keyboard. The heart icon on the player turns gray to show that the track isn't in your favorites.
```
```{tabbed} Mobile
- Select the player at the bottom of the screen to expand it. Select the pink heart icon ({fa}`heart`) under the track art. The heart turns gray to show that the track isn't in your favorites.
```
That's it! You've removed the currently playing track from your favorites.
## Remove a track from a track table
You can remove tracks on track tables from your favorites. You can find track tables on artist pages, album pages, and the search page. To remove a track on a track table from your favorites:
```{tabbed} Desktop
1. Find your track in a track table.
2. A pink heart icon ({fa}`heart`) shows next to all tracks in your favorites.
3. Select the heart icon on the track you want to remove. The heart turns gray to show that the track isn't in your favorites.
```
```{tabbed} Mobile
1. Find your track in a track table.
2. Tap on the kebab menu ({fa}`ellipsis-v`) on the track row. The track menu opens.
3. Select {guilabel}`Remove from favorites`. The heart turns gray to show that the track isn't in your favorites.
```
You're done! You've removed the track from your favorites.
## Remove a track from the track details page
You can remove a track from your favorites from its details page. To do this:
1. Go to the track's details page.
2. Select the pink heart icon ({fa}`heart`) at the top of the screen. The heart turns gray to show that the track isn't your favorites.
That's it! You've removed the track from your favorites.

39
docs/user_documentation/index.md Normal file
View file

@ -0,0 +1,39 @@
# Get started
Follow the guides in our user documentation to get started using Funkwhale.
```{contents}
:local:
```
## Set up your Funkwhale account
Some {term}`Funkwhale pods <Pod>` allow you to listen to music without signing up. To get the most out of Funkwhale, you should create an account. Check out [Your account](accounts/index.md) to get started.
## Publish your content on Funkwhale
Got a podcast you want to share with the world? Working on a new album? Funkwhale gives you the tools you need to share your creativity with the {term}`Fediverse`. Publish your work in [Channels](channels/index.md) to start building up your following.
## Upload your collection to Funkwhale
Want to listen to your private collection using Funkwhale? Upload your files to [Libraries](libraries/index.md) to store your collection on your pod and share it with others.
## Start listening
Want to listen to something new or enjoy an old favorite? Follow the guides in the sections linked below to master playback in Funkwhale:
- Learn how to use the [Queue](queue/index.md) to organize playback.
- Build [Playlists](playlists/index.md) to personalize how you enjoy your favorite content.
- Create new [Radios](radios/index.md) to automate your listening experience.
## Report content and users
If you've come across something that doesn't abide by a pod's rules or the law, you can report it. Follow the guides in the [Reporting](reports/index.md) section to see how.
## Access Funkwhale from other apps
Funkwhale supports a subset of the Subsonic API. This means you can play your Funkwhale content on Subsonic apps. Learn more about how to do this in the [Subsonic](subsonic/index.md) section.
## Enhance your experience with plugins
Funkwhale supports plugins to extend its features or to add new features. Check out our [Plugins](plugins/index.md) section for details about our plugins and how to use them.

311
docs/user_documentation/info/cli.rst Normal file
View file

@ -0,0 +1,311 @@
Funkwhale CLI
=============
`Funkwhale CLI <https://dev.funkwhale.audio/funkwhale/cli/>`_ is a command-line interface you can install on your local computer
to interact with any Funkwhale server via the REST API. It's especially useful if you need to do repetitive operations
or write scripts that interact with Funkwhale servers.
Here is a (non-exhaustive) list of operations you can perform via the CLI:
- Manage libraries
- Upload local files
- Retrieve and search tracks, albums and artists
- Download tracks
- Manage playlists
- Manage favorites
.. contents:: Table of Contents
Installation
------------
We provide a prebuilt binary for Linux::
curl -L "https://dev.funkwhale.audio/funkwhale/cli/-/jobs/artifacts/stable/raw/funkwhale?job=build-linux" -o /usr/local/bin/funkwhale
chmod +x /usr/local/bin/funkwhale
You can also install from source with::
pip3 install --user git+https://dev.funkwhale.audio/funkwhale/cli
# the executable will be available at ~/.local/bin/funkwhale
.. note::
Installing from source requires you have Python 3.6 or higher available.
You can check the installation was successful by running ``funkwhale --help``. This should output
the list of available commands and the CLI description.
Basic usage
-----------
Here are a couple of commands you can try to get started:
.. code-block:: shell
# Display public server info of demo.funkwhale.audio
funkwhale -H https://demo.funkwhale.audio server info
# List tracks from open.audio
funkwhale -H https://open.audio tracks ls
# Search artists matching "zebra" on open.audio
funkwhale -H https://open.audio artists ls "zebra"
Getting help
------------
The most basic way to get help is to run ``funkwhale --help``. It will list available commands, namespaces and arguments that are common to all commands.
You can also append the ``--help`` flag after any command to get more information about its arguments and options, like this: ``funkwhale albums ls --help``
The CLI offers nested commands. For instance, ``funkwhale albums`` isn't a valid command in itself, but a namespace for all albums-related commands.
To get the help of a specific namespace and list all its available commands, simply run ``funkwhale <namespace> --help``.
Authentication
--------------
The CLI uses JWT tokens to interact with the API. You can either:
1. Run ``funkwhale login``, which will ask you your Funkwhale username and password and store a JWT token in your local keyring. This token will be used automatically afterwards.
2. Explicitly pass a token to the command via the ``-t`` flag or the ``FUNKWHALE_TOKEN`` environment variable
If you use ``funkwhale login``, you can delete the local token with ``funkwhale logout``.
You can check that you are fully authenticated by running ``funkwhale users me``. It will display information relating to your user profile.
Configuration
-------------
To work, the CLI needs to be pointed to a Funkwhale server. This can be done in various ways:
- Via the ``-H https://funkwhale.domain`` flag when calling the CLI
- Via the ``FUNKWHALE_SERVER_URL`` environment variable
- Via an env file (see below)
Env file
^^^^^^^^
The CLI will try to read configuration options from a ``.env`` file in the current directory. If this file is not present, it will read the configuration options from ``~/.config/funkwhale/env`` on Linux or ``~/Library/Application Support/funkwhale/env`` on macOS.
You can also give it a path to another env file via the ``-e /path/to/.envfile`` flag or the ``ENV_FILE`` environment variable.
An env file simply contains a list of variables, using the same syntax as environment variables (comments starting with # are allowed). Example::
# ~/Music/.env
FUNKWHALE_SERVER_URL=https://my.funkwhale.server
List of configuration options
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+--------------------------------------+------------------------------------------------+--------------------------------------------+---------------------------------------------------------------+
| CLI Flag | Environment variable | Example value | Description |
+--------------------------------------+------------------------------------------------+--------------------------------------------+---------------------------------------------------------------+
| ``-e``, ``--env-file`` | ``ENV_FILE`` | ``~/Music/.env`` | Path to a local env file to use for configuration |
+--------------------------------------+------------------------------------------------+--------------------------------------------+---------------------------------------------------------------+
| ``-H``, ``--url`` | ``FUNKWHALE_SERVER_URL`` | ``https://demo.funkwhale.audio`` | The URL of the Funkwhale server the CLI should contact |
+--------------------------------------+------------------------------------------------+--------------------------------------------+---------------------------------------------------------------+
| ``-t``, ``--token`` | ``FUNKWHALE_TOKEN`` | ``eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI`` | A JWT token to use for authentication |
+--------------------------------------+------------------------------------------------+--------------------------------------------+---------------------------------------------------------------+
| ``--no-login`` | ``FUNKWHALE_NO_LOGIN`` | ``true`` | Completely disable authentication and keyring |
+--------------------------------------+------------------------------------------------+--------------------------------------------+---------------------------------------------------------------+
| ``-v``, ``--verbosity`` | | One of ``CRITICAL``, ``ERROR``, | Control the verbosity (default is INFO) |
| | | ``WARNING``, ``INFO`` or ``DEBUG`` | |
+--------------------------------------+------------------------------------------------+--------------------------------------------+---------------------------------------------------------------+
| ``-q``, ``--quiet`` | ``FUNKWHALE_QUIET`` | ``true`` | Completely disable logging |
+--------------------------------------+------------------------------------------------+--------------------------------------------+---------------------------------------------------------------+
Read commands
-------------
All commands that list results - such as ``funkwhale albums ls`` or ``funkwhale tracks ls`` - share similar behaviors and sets of arguments.
Filtering
^^^^^^^^^
Results can be filtered using the ``-f`` or ``--filter`` flag. Provided values are transmitted directly in the querystring when the requests to the API is made::
# retrieve playable tracks
funkwhale tracks ls -f "playable=true"
The flag can be provided multiple times, to add multiple filter conditions::
# retrieve playable tracks with a CC-BY-SA 4.0 license
funkwhale tracks ls -f "playable=true" -f "license=cc-by-sa-4.0"
.. note::
The list of supported fields for filtering depends on the resource being queried, and can be found in our `API documentation`_.
Searching
^^^^^^^^^
Any text provided after the ``ls`` command will be considered a search query and transmitted to the API::
# retrieve tracks matching the search query "Electro Swing"
funkwhale tracks ls Electro Swing
.. note::
This is technically equivalent to filtering with a ``q`` parameter as described above::
funkwhale tracks ls -f "q=Electro Swing"
Ordering
^^^^^^^^
You can control the ordering of the results with the `-o` or ``--ordering`` flag::
# retrieve albums by creation date, in ascending order
funkwhale albums ls -o creation_date
.. note::
Ordering in descending order is supported by prefixing the field name with ``-``, e.g: ``-o -creation_date``
.. note::
The list of supported fields for ordering depends on the resource being queried, and can be found in our `API documentation`_.
Pagination
^^^^^^^^^^
You can retrieve a specific result page using the ``-p`` or ``--page`` flag::
# retrieve the second page of albums
funkwhale albums ls -p 2
You can also alter the size of the pages using the ``-s`` or ``--page-size`` flag::
# retrieve five albums
funkwhale albums ls -s 5
Sometimes, you may want to retrieve multiple pages of results at once. This is supported using the ``-l`` or ``--limit`` flag::
# retrieve the first 3 pages of albums
funkwhale albums ls -l 3
You can, of course, combine these flags::
# retrieve 3 pages of 12 albums, starting on the 4th page
funkwhale albums ls --limit 3 --page-size 12 --page 4
Output
^^^^^^
While the default output displays a human-readable table, you can customize it.
The ``--raw`` flag will simply output the raw JSON payload returned by the API server::
funkwhale artists ls --raw
The ``-h`` or ``--no-headers`` flag simply removes the table column headers.
The ``-t`` or ``--format`` flag alters the rendering of result, depending on the provided value::
# list artists outputting a html table
funkwhale artists ls -t html
# output a github/markdown table
funkwhale artists ls -t github
Available formats are: ``fancy_grid``, ``github``, ``grid``, ``html``, ``jira``, ``latex``, ``latex_booktabs``, ``latex_raw``, ``mediawiki``, ``moinmoin``, ``orgtbl``, ``pipe``, ``plain``, ``presto``, ``psql``, ``rst``, ``simple``, ``textile``, ``tsv``, ``youtrack``
The ``-c`` or ``--column`` flag gives you control on the displayed columns::
# list artists, displaying only artist ID and number of tracks
funkwhale artists ls -c ID -c Tracks
For a given resource, the list of available columns can be found by running ``funkwhale <resource> ls --help``.
The ``-i`` or ``--ids`` flag displays only the IDs of results, one per line::
funkwhale artists ls --ids
This is especially useful in conjunction with other commands (like deletion commands) and piping.
Note that this is also technically equivalent to applying the ``--no-headers``, ``--format plain`` and ``--column ID`` flags.
Write commands
--------------
Deleting objects
^^^^^^^^^^^^^^^^
Some resources support deletion, via commands such as ``funkwhale libraries rm`` or ``funkwhale playlists rm``, followed by one or more IDs::
# delete playlists 42 and 23
funkwhale playlists rm 42 23
By default, the ``rm`` command will ask for confirmation, but you can disable this behavior by providing the ``--no-input`` flag.
.. _API Documentation: https://docs.funkwhale.audio/swagger/
Examples
--------
Uploading local files
^^^^^^^^^^^^^^^^^^^^^
**Goal**: create a library and upload all MP3 files from ``~/Music`` to it
**Commands**::
funkwhale libraries create --name "My awesome library" --visibility me
# copy the returned UUID
funkwhale uploads create <UUID> ~/Music/**/*.mp3
Favorite an entire album
^^^^^^^^^^^^^^^^^^^^^^^^
**Goal**: retrieve all the tracks from an album and add these to your favorites
**Commands**::
# retrieve the album ID
funkwhale albums ls "The Slip"
# Copy the ID, then retrieve 100 pages of tracks from that album
# get only the IDs and pipe those to the favorite creation command
funkwhale tracks ls -f "album=<ID>" --ids --limit 100 \
| xargs funkwhale favorites tracks create
Mirror an artist discography locally
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
**Goal**: Download the discography of an artist locally, in the ``~/Music`` directory, in an ``Artist/Album/Track`` folder hierarchy
**Commands**::
# retrieve the artist ID
funkwhale artists ls "Nine Inch Nails"
# Copy the ID, then retrieve 100 pages of tracks from that artist
# get only the IDs and pipe those to the download command
funkwhale tracks ls -f "artist=<ID>" --ids --limit 100 \
| xargs funkwhale tracks download \
-f mp3 -d ~/Music -t "{artist}/{album}/{title}.{extension}"
Open a remote album in VLC
^^^^^^^^^^^^^^^^^^^^^^^^^^
**Goal**: Variation of the previous example, but instead of downloading an artist discography, we listen to an album in VLC
**Commands**::
# retrieve the album ID
funkwhale albums ls "The Slip"
# Copy the ID, then retrieve 100 pages of tracks from that album
# get only the IDs, download the corresponding tracks and pipe the audio
# directly to VLC
funkwhale tracks ls -f "album=<ID>" --ids --limit 100 \
| xargs funkwhale tracks download \
| vlc -

51
docs/user_documentation/libraries/create_library.md Normal file
View file

@ -0,0 +1,51 @@
# Create a library
```{tip}
Want to publish your own content on your {term}`pod`? Take a look at [channels](../channels/index).
```
To start uploading your collection to your pod, you need to create a library. You can create as many libraries as you need.
To create a library:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota. If you have created any libraries, these are also shown.
5. Select {guilabel}`Create a new library`.
6. Enter a {guilabel}`Name` for your library (required).
7. Enter {guilabel}`Description` for your library.
8. Set the {guilabel}`Visibility` of your library. This determines who can access the content.
- {guilabel}`Everyone, across all instances` – the library's content is available to everybody who interacts with your pod. This includes users of other pods.
- {guilabel}`Everyone on this instance` – the library's content is available to all users on your pod. This does not include users of other pods.
- {guilabel}`Nobody except me` – the library's content is only available to you and people you share the library with.
9. Select {guilabel}`Create library`.
10. A screen appears showing you a summary of your library.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota. If you have created any libraries, these are also shown.
5. Select {guilabel}`Create a new library`.
6. Enter a {guilabel}`Name` for your library (required).
7. Enter {guilabel}`Description` for your library.
8. Set the {guilabel}`Visibility` of your library. This determines who can access the content.
- {guilabel}`Everyone, across all instances` – the library's content is available to everybody who interacts with your pod. This includes users of other pods.
- {guilabel}`Everyone on this instance` – the library's content is available to all users on your pod. This does not include users of other pods.
- {guilabel}`Nobody except me` – the library's content is only available to you and people you share the library with.
9. Select {guilabel}`Create library`.
10. A screen appears showing you a summary of your library.
```
```{warning}
Select {guilabel}`Nobody except me` if you don't own the copyright for the content or it isn't freely licensed.
```
Well done! You've created your library. Now you can add some content to it.

41
docs/user_documentation/libraries/delete_content.md Normal file
View file

@ -0,0 +1,41 @@
# Delete content from a library
```{warning}
When you delete content from a library you delete the audio files from your {term}`pod`. Make sure you have a backup of any files you want to keep.
```
You can delete content from a library at any time. To do this:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Library Details` under the library you want to edit.
6. Select the {guilabel}`✎ Edit` button at the top of the screen.
7. Scroll down to the {guilabel}`Library contents` section. A list of tracks is shown.
8. Select the checkbox ({fa}`square`) next to the tracks you want to delete. Selected tracks show a tick ({fa}`check-square`).
9. Select {menuselection}`Actions --> Delete`.
10. Select {guilabel}`Go`.
11. Select {guilabel}`Launch` on the warning message that appears.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Library Details` under the library you want to edit.
6. Select the {guilabel}`✎ Edit` button at the top of the screen.
7. Scroll down to the {guilabel}`Library contents` section. A list of tracks is shown.
8. Select the checkbox ({fa}`square`) next to the tracks you want to delete. Selected tracks show a tick ({fa}`check-square`).
9. Select {menuselection}`Actions --> Delete`.
10. Select {guilabel}`Go`.
11. Select {guilabel}`Launch` on the warning message that appears.
```
That's it! You've successfully deleted the content from your library.

35
docs/user_documentation/libraries/delete_library.md Normal file
View file

@ -0,0 +1,35 @@
# Delete a library
```{warning}
Deleting a library also deletes all content in the library.
```
You can delete a library at any time. To do this:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Library Details` under the library you want to edit.
6. Select the {guilabel}`✎ Edit` button at the top of the screen.
7. Select {guilabel}`Delete`.
8. Select {guilabel}`Delete library` on the warning notice that appears.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Library Details` under the library you want to edit.
6. Select the {guilabel}`✎ Edit` button at the top of the screen.
7. Select {guilabel}`Delete`.
8. Select {guilabel}`Delete library` on the warning notice that appears.
```
That's it! You've deleted your library and all its content.

136
docs/user_documentation/libraries/edit_content.md Normal file
View file

@ -0,0 +1,136 @@
# Edit library content
```{note}
You can only edit content in libraries you own. {term}`Pod` admins can edit all content.
```
You can edit library content after you have uploaded it. This is helpful if the content isn't [tagged](tag_music).
```{contents}
:local:
```
## Edit artist
To edit an artist:
```{tabbed} Desktop
1. Search for the artist in the sidebar or go to the {guilabel}`Artists` page in {guilabel}`My Library` and search there.
2. Select the artist you want to edit. The artist details page opens.
3. Select the {guilabel}`More…` button. The artist options menu opens.
4. Select {guilabel}`✎ Edit`. The {guilabel}`Edit this artist` screen opens.
5. Change the details in any of these fields:
- {guilabel}`Name` – the name of the artist.
- {guilabel}`Description` – a description of the artist. This appears on the artist details page.
- {guilabel}`Cover` – the cover image for the artist. This appears on the artist details page.
- {guilabel}`Tags` – the genre(s) the artist fits in.
6. __Optional__ – enter a {guilabel}`Summary` of your edits.
7. Select {guilabel}`Submit and apply edit` to save your changes.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Use the search bar to search for your artist. You can also select {menuselection}`My Library --> Artists` to open the artist search page.
3. Select the artist you want to edit. The artist details page opens.
4. Select the {guilabel}`More…` button. The artist options menu opens.
5. Select {guilabel}`✎ Edit`. The {guilabel}`Edit this artist` screen opens.
6. Change the details in any of these fields:
- {guilabel}`Name` – the name of the artist.
- {guilabel}`Description` – a description of the artist. This appears on the artist details page.
- {guilabel}`Cover` – the cover image for the artist. This appears on the artist details page.
- {guilabel}`Tags` – the genre(s) the artist fits in.
7. __Optional__ – enter a {guilabel}`Summary` of your edits.
8. Select {guilabel}`Submit and apply edit` to save your changes.
```
That's it! You've edited the artist's details. You can see these details by visiting the artist page.
## Edit album
To edit an album:
```{tabbed} Desktop
1. Search for the album in the sidebar or go to the {guilabel}`Albums` page in {guilabel}`My Library` and search there.
2. Select the album you want to edit. The album details page opens.
3. Select the kebab menu ({fa}`ellipsis-v`) to show the album options.
4. Select {guilabel}`✎ Edit`. The {guilabel}`Edit this album` screen opens.
5. Change the details in any of these fields:
- {guilabel}`Title` – the title of the album.
- {guilabel}`Description` – a description of the album. This appears on the album details page.
- {guilabel}`Release date` – the release date of the album.
- {guilabel}`Cover` – the album cover art.
- {guilabel}`Tags` – the genre(s) associated with the album.
6. __Optional__ – enter a {guilabel}`Summary` of your edits.
7. Select {guilabel}`Submit and apply edit` to save your changes.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Use the search bar to search for your album. You can also select {menuselection}`My Library --> Albums` to open the album search page.
3. Select the album you want to edit. The album details page opens.
4. Select the kebab menu ({fa}`ellipsis-v`) to show the album options.
5. Select {guilabel}`✎ Edit`. The {guilabel}`Edit this album` screen opens.
6. Change the details in any of these fields:
- {guilabel}`Title` – the title of the album.
- {guilabel}`Description` – a description of the album. This appears on the album details page.
- {guilabel}`Release date` – the release date of the album.
- {guilabel}`Cover` – the album cover art.
- {guilabel}`Tags` – the genre(s) associated with the album.
7. __Optional__ – enter a {guilabel}`Summary` of your edits.
8. Select {guilabel}`Submit and apply edit` to save your changes.
```
That's it! You've edited the album's details. You can see these details by visiting the album page.
## Edit track
To edit a track:
```{tabbed} Desktop
1. Search for the track in the sidebar.
2. Select the track you want to edit. The track details page opens.
3. Select the kebab menu ({fa}`ellipsis-v`) to show the track options.
4. Select {guilabel}`✎ Edit`. The {guilabel}`Edit this track` screen opens.
5. Change the details in any of these fields:
- {guilabel}`Title` – the title of the track.
- {guilabel}`Description` – a description of the track. This appears on the track details page.
- {guilabel}`Cover` – the track cover art. This appears on the track details page.
- {guilabel}`Position` – the position of the track in its album.
- {guilabel}`Copyright` – the name of the copyright holder.
- {guilabel}`License` – the license of the track. Funkwhale supports [Creative Commons](https://creativecommons.org) licenses. Leave this blank if you aren't sure.
- {guilabel}`Tags` – the genre(s) associated with the track.
6. __Optional__ – enter a {guilabel}`Summary` of your edits.
7. Select {guilabel}`Submit and apply edit` to save your changes.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Use the search bar to search for your track.
3. Select the track you want to edit. The track details page opens.
4. Select the kebab menu ({fa}`ellipsis-v`) to show the track options.
5. Select {guilabel}`✎ Edit`. The {guilabel}`Edit this track` screen opens.
6. Change the details in any of these fields:
- {guilabel}`Title` – the title of the track.
- {guilabel}`Description` – a description of the track. This appears on the track details page.
- {guilabel}`Cover` – the track cover art. This appears on the track details page.
- {guilabel}`Position` – the position of the track in its album.
- {guilabel}`Copyright` – the name of the copyright holder.
- {guilabel}`License` – the license of the track. Funkwhale supports [Creative Commons](https://creativecommons.org) licenses. Leave this blank if you aren't sure.
- {guilabel}`Tags` – the genre(s) associated with the track.
7. __Optional__ – enter a {guilabel}`Summary` of your edits.
8. Select {guilabel}`Submit and apply edit` to save your changes.
```
That's it! You've edited the track's details. You can see these details by visiting the track details page.

37
docs/user_documentation/libraries/edit_library.md Normal file
View file

@ -0,0 +1,37 @@
# Edit a library
You can update the details of your libraries at any time. To do this:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Library Details` under the library you want to edit.
6. Select the {guilabel}`✎ Edit` button at the top of the screen.
7. Change any of the following:
- {guilabel}`Name`.
- {guilabel}`Description`.
- {guilabel}`Visibility`.
8. Select {guilabel}`Update Library` to save your changes. A toast notification appears at the bottom of the screen to confirm your changes.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Library Details` under the library you want to edit.
6. Select the {guilabel}`✎ Edit` button at the top of the screen.
7. Change any of the following:
- {guilabel}`Name`.
- {guilabel}`Description`.
- {guilabel}`Visibility`.
8. Select {guilabel}`Update Library` to save your changes. A toast notification appears at the bottom of the screen to confirm your changes.
```
That's it! You've updated your library's details.

50
docs/user_documentation/libraries/follow_library.md Normal file
View file

@ -0,0 +1,50 @@
# Follow a library
Follow a library to get access to its content. There are two ways to follow a library:
```{contents}
:local:
```
## Use a sharing link
If you've received a sharing link, you can use this to follow a library. To do this:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Follow remote libraries`. A screen appears showing you the libraries you are following.
4. Paste the sharing link into the {guilabel}`Search a remote library` search bar.
5. Select the {guilabel}`Search` icon or hit {kbd}`⏎ Return` to search for the library. If the library exists, a library card appears.
6. Select {guilabel}`Follow` on the library card. If the library's privacy level is {guilabel}`Nobody except me`, the owner needs to approve the request.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen
3. Select {guilabel}`Get started` under {guilabel}`Follow remote libraries`. A screen appears showing you the libraries you are following.
4. Paste the sharing link into the {guilabel}`Search a remote library` search bar.
5. Select the {guilabel}`Search` icon or hit {kbd}`⏎ Return` to search for the library. If the library exists, a library card appears.
6. Select {guilabel}`Follow` on the library card. If the library's privacy level is {guilabel}`Nobody except me`, the owner needs to approve the request.
```
That's it! The server then scans the content and you can see it on your {term}`pod`.
## Follow from content on your pod
```{note}
You can only follow a library from content pages if its privacy level is not {guilabel}`Nobody except me`.
```
If a user on your {term}`pod` has already followed a library, you can find it by selecting content from that library. To do this:
1. Log in to your pod.
2. Select a track, album, or artist from the library you want to follow.
3. Scroll to the bottom of the page. The library card appears in the {guilabel}`User libraries` section.
4. Select {guilabel}`Follow` on the library card.
You're done! The content will remain on the server even if the other user stops following the library.

45
docs/user_documentation/libraries/index.md Normal file
View file

@ -0,0 +1,45 @@
# Libraries
Libraries enable you to organize audio content you upload to your {term}`pod`. You can set the privacy level on libraries to control who can access them. Choose from the available privacy levels:
- __Everyone, across all instances__ – the library's content is available to everybody who interacts with your pod. This includes users of other pods.
- __Everyone on this instance__ – the library's content is available to all users on your pod. This does not include users of other pods.
- __Nobody except me__ – the library's content is only available to you and people you share the library with.
Use libraries for private collections or freely licensed music you want to share.
```{toctree}
---
caption: Manage your libraries
maxdepth: 1
---
create_library
edit_library
delete_library
```
```{toctree}
---
caption: Manage library content
maxdepth: 1
---
tag_music
upload_content
edit_content
delete_content
```
```{toctree}
---
caption: Share and follow libraries
maxdepth: 1
---
share_library
follow_library
```

51
docs/user_documentation/libraries/share_library.md Normal file
View file

@ -0,0 +1,51 @@
# Share a library
Sharing a library gives another user access to the library's content. When a user follows your library, they'll be able to play and download any content it contains from their {term}`pod`. Share private libraries with friends and family or share public libraries with everyone!
To share a library you own:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Library Details` under the library you want to share.
6. The {guilabel}`Sharing link` appears on the library details page. Select {guilabel}`Copy` to copy the sharing link to your clipboard. A label appears letting you know you've copied the link.
7. Send the link to whomever you want to share the library with.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Library Details` under the library you want to share.
6. The {guilabel}`Sharing link` appears on the library details page. Select {guilabel}`Copy` to copy the sharing link to your clipboard. A label appears letting you know you've copied the link.
7. Send the link to whomever you want to share the library with.
```
If you have set the library's privacy level to {guilabel}`Nobody except me`, you need to approve followers. You receive a notification when a user follows your library. To approve a follow request:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the cog icon ({fa}`cog`) or your avatar to expand the user menu.
3. Select {guilabel}`Notifications`. The notifications screen opens.
4. Notifications show the username of the user who wants to follow the library as well as the library name. Select {guilabel}`Accept` to approve the follow request or {guilabel}`Reject` to reject the request.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the cog icon ({fa}`cog`) or your avatar to open the {guilabel}`Options` menu.
3. Select {guilabel}`Notifications`. The notifications screen opens.
4. Notifications show the username of the user who wants to follow the library as well as the library name. Select {guilabel}`Accept` to approve the follow request or {guilabel}`Reject` to reject the request.
```
That's it! You've shared your library. The invited users can now listen to its content.

71
docs/user_documentation/libraries/tag_music.md Normal file
View file

@ -0,0 +1,71 @@
# Tag your content with Picard
Funkwhale relies on [ID3 tags](https://id3.org/) to sort audio content. ID3 tags tell Funkwhale information about your files. Funkwhale uses this information to display your content in your {term}`pod`.
We recommend using [MusicBrainz Picard](https://picard.musicbrainz.org/) to tag your content. MusicBrainz Picard is free and open source software that connects to [MusicBrainz](https://musicbrainz.org). Funkwhale uses MusicBrainz as its primary data source.
This guide shows you how to tag your content with MusicBrainz Picard.
```{contents}
:local:
```
```{dropdown} Supported tags
| Name | Example value | Description |
|-------------------------------|-------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `Title`* | `Letting you` | The track title. |
| `Artist`* | `Nine Inch Nails` | The artist name. |
| `Album` | `The Slip` | The album title. If none is provided, an `[Unknown Album]` entry is created. |
| `Album artist` | `Trent Reznor` | The album artist name (can be different than the track artist). |
| `Genre` | `Industrial, Metal` | A comma separated list of tags to associate with the track.<br><br>Other supported separators: `;` and `/` |
| `Track number` | `4` | The position of the track in the album/release. |
| `Disc number` | `1` | The disc number (in case of multi-disc albums). |
| `Date` | `2019` | The release date of the track or album. |
| `License` | `CC-BY 3.0: http://creativecommons.org/licenses/cc-by/3.0/` | The license associated with this work. The first URL found is checked against our list of supported licenses. |
| `Copyright` | `CC-BY 3.0: http://creativecommons.org/licenses/cc-by/3.0/` | The license associated with this work. The first URL found is checked against our list of supported licenses. <br><br>Used if no license found in the `License` tag. |
| `Pictures` | | The first embeded picture found is used as the album cover. |
| `MusicBrainz Recording ID` | `99244237-850b-4a93-904d-57305bcadb4e` | The MusicBrainz ID for the recording. |
| `MusicBrainz Album ID` | `bca982fd-ab73-3c9f-ad07-9104a4f53a32` | The MusicBrainz ID for the album |
| `MusicBrainz Artist ID` | `b7ffd2af-418f-4be2-bdd1-22f8b48613da` | The MusicBrainz ID for the artist |
| `MusicBrainz Album Artist ID` | `b7ffd2af-418f-4be2-bdd1-22f8b48613da` | The MusicBrainz ID for the album artist |
```
## Tag content
To tag content using MusicBrainz Picard:
1. Select {guilabel}`Add Files` to add individual files or {guilabel}`Add Folder` to add a directory of files.
2. Select the files or directory you want to tag.
3. Picard shows the files in the left panel. Picard moves files to the right panel as it tags them. If Picard doesn't tag a file automatically, select {guilabel}`Scan`.
4. Check a file's tags by highlighting it and looking at the details in the bottom panel. If Picard has applied the wrong tags, look for [alternative versions](#alternative-versions).
5. Select {guilabel}`Save` or hit {kbd}`ctrl+s` ({kbd}`cmd+s` on macOS) to save the tags to the files.
That's it! You've added ID3 tags to your files. You can now [add these to a library](upload_content.md)
## Alternative versions
Picard will choose tags based on details included in your file. Sometimes it chooses a different version of a release than the one you want. You can choose an alternative version of your content to get the right tags.
### Alternative albums
If Picard has selected a different version of the album you are tagging:
1. Right-click on the album and hover your mouse over {guilabel}`Other versions`. A dropdown list of alternative versions appears.
2. Select the correct release from the list.
3. Select {guilabel}`Save` or hit {kbd}`ctrl+s` ({kbd}`cmd+s` on macOS) to save the tags to the files.
### Alternative tracks
If Picard can't find a release for a track:
1. Right-click on the track and select {guilabel}`Search for Similar Tracks…`. A search screen appears.
2. Search for your track. Use [MusicBrainz's search syntax](https://musicbrainz.org/doc/Indexed_Search_Syntax) for the best results.
3. Select the correct track and click on {guilabel}`Load into Picard`.
4. Select {guilabel}`Save` or hit {kbd}`ctrl+s` ({kbd}`cmd+s` on macOS) to save the tags to the files.
## Add items to MusicBrainz
If Picard can't find your content, you can add it to MusicBrainz yourself. To get started, check out [MusicBrainz's guide](https://musicbrainz.org/doc/How_to_Add_a_Release/).
Once you have added the content to MusicBrainz, Picard can tag your files.

36
docs/user_documentation/libraries/upload_content.md Normal file
View file

@ -0,0 +1,36 @@
# Upload content to a library
```{note}
Access to a library's content is set at a __library level__. You can't change the privacy level of content within the library.
```
Once you have [created a library](create_library.md), you can start uploading content to it. Funkwhale reads information about your content from its metadata. For the best results, make sure to [tag your files well](tag_music.md).
To upload content to a library:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) in the top of the sidebar.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Upload` under the library you want to add content to.
6. Click on the section marked {guilabel}`Click to select files` to open a file picker, or drag and drop your files on to it.
- If you opened the file picker, select the files you want to upload and confirm.
7. The screen shows you the status of each upload. Once the upload queue is empty, your upload is complete.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the upload icon ({fa}`upload`) at the top of the screen.
3. Select {guilabel}`Get started` under {guilabel}`Upload third-party content in a library`.
4. A screen appears showing your upload quota and your libraries.
5. Select {guilabel}`Upload` under the library you want to add content to.
6. Click on the section marked {guilabel}`Click to select files` to open a file picker Select the files you want to upload and confirm.
7. The screen shows you the status of each upload. Once the upload queue is empty, your upload is complete.
```
Congratulations! You added some content to your library. You can now listen to your tracks on your {term}`Funkwhale pod <Pod>`.

76
docs/user_documentation/playlists/add_content.md Normal file
View file

@ -0,0 +1,76 @@
# Add content to a playlist
To build a playlist, you need to add content to it. You can add content in a few different ways:
```{contents}
:local:
```
## Add the currently playing track
If you want to add the currently playing track to a playlist:
```{tabbed} Desktop
1. Select the playlist icon ({fa}`list`) on the player. The {guilabel}`Manage playlists` screen appears.
2. Select {guilabel}`+ Add track` next to the playlist you want to add the track to.
```
```{tabbed} Mobile
1. Select the player at the bottom of the screen to expand it.
2. Select the playlist icon ({fa}`list`) under the track art. The {guilabel}`Manage playlists` screen appears.
3. Select {guilabel}`+ Add track` next to the playlist you want to add the track to.
```
That's it! The currently playing track is now in your playlist.
## Add content from queue
You can add all content that is currently in your [player queue](../queue/index.md). To do this:
```{tabbed} Desktop
1. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
2. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
3. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
4. Select {guilabel}`+ Insert from queue`. Your tracks appear in the playlist. The changes save to the server.
5. Select {guilabel}`Stop editing` to stop editing.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
5. Select {guilabel}`+ Insert from queue`. Your tracks appear in the playlist. The changes save to the server.
6. Select {guilabel}`Stop editing` to stop editing.
```
That's it! You've added the contents from your queue to a playlist.
## Add track from track details page
You can add a track to a playlist from the track details page. To do this:
1. Go to the track details page of the track you want to add.
2. Select the playlist icon ({fa}`list`) at the top of the screen. The {guilabel}`Manage playlists` screen appears.
3. Select {guilabel}`+ Add track` next to the playlist you want to add the track to.
That's it! The track is available in your playlist.
## Add track from track table
You can add tracks from any page with a track table. This includes artist pages, album pages, and the search page. To add tracks from the track table:
1. Find your track in a track table.
2. Select the kebab menu ({fa}`ellipsis-v`) next to the track to open the track options menu.
3. Select {guilabel}`Add to playlist…`. The {guilabel}`Manage playlists` screen appears.
4. Select {guilabel}`+ Add track` next to the playlist you want to add the track to.
Well done! You've added the track to your playlist.

36
docs/user_documentation/playlists/create_playlist.md Normal file
View file

@ -0,0 +1,36 @@
# Create a playlist
Create playlists to share your favorite tracks with other Funkwhale users.
To create a playlist:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Enter a {guilabel}`Playlist name` for your new playlist.
5. Select the {guilabel}`Playlist visibility` for your playlist. Choose from the following options:
- {guilabel}`Everyone, across all instances` – the playlist is available to everybody who interacts with your {term}`pod`. This includes users of other pods.
- {guilabel}`Everyone on this instance` – the playlist is available to all users on your pod. This does not include users of other pods.
- {guilabel}`Nobody except me` – the playlist is only available to you and people you share it with.
6. Select {guilabel}`Create playlist`. A {guilabel}`Playlist created` message appears.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Enter a {guilabel}`Playlist name` for your new playlist.
6. Select the {guilabel}`Playlist visibility` for your playlist. Choose from the following options:
- {guilabel}`Everyone, across all instances` – the playlist is available to everybody who interacts with your pod. This includes users of other pods.
- {guilabel}`Everyone on this instance` – the playlist is available to all users on your pod. This does not include users of other pods.
- {guilabel}`Nobody except me` – the playlist is only available to you and people you share it with.
7. Select {guilabel}`Create playlist`. A {guilabel}`Playlist created` message appears.
```
Congratulations! You've created your playlist. Now you can [add some content to it](add_content.md).

32
docs/user_documentation/playlists/delete_playlist.md Normal file
View file

@ -0,0 +1,32 @@
# Delete a playlist
```{warning}
Deleting a playlist removes the playlist for all users. This action is irreversible.
```
You can delete a playlist if you no longer want it. To do this:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the playlist from the {guilabel}`Available playlists` list. The playlist details screen opens.
5. Select {guilabel}`Delete`. A {guilabel}`Do you want to delete the playlist?` warning appears.
6. Select {guilabel}`Delete playlist`.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Select the playlist from the {guilabel}`Available playlists` list. The playlist details screen opens.
6. Select {guilabel}`Delete`. A {guilabel}`Do you want to delete the playlist?` warning appears.
7. Select {guilabel}`Delete playlist`.
```
That's it! You've deleted your playlist.

32
docs/user_documentation/playlists/edit_playlist.md Normal file
View file

@ -0,0 +1,32 @@
# Edit a playlist
You can edit the details of your playlists at any time. To do this:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
5. Update the following fields:
- {guilabel}`Playlist name`.
- {guilabel}`Playlist visibility`.
6. Select {guilabel}`Update playlist` to save your changes. A message displays {guilabel}`Playlist updated`.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
6. Update the following fields:
- {guilabel}`Playlist name`.
- {guilabel}`Playlist visibility`.
7. Select {guilabel}`Update playlist` to save your changes. A message displays {guilabel}`Playlist updated`.
```
That's it! You've edited your playlist.

28
docs/user_documentation/playlists/index.md Normal file
View file

@ -0,0 +1,28 @@
# Playlists
You can create and share playlists with the {term}`Fediverse`. Add content from all over the network to build playlists you love.
```{toctree}
---
caption: Manage your playlists
maxdepth: 1
---
create_playlist
edit_playlist
listen_playlist
delete_playlist
```
```{toctree}
---
caption: Manage playlist content
maxdepth: 1
---
add_content
reorder_content
remove_content
```

57
docs/user_documentation/playlists/listen_playlist.md Normal file
View file

@ -0,0 +1,57 @@
# Listen to a playlist
```{note}
You can only listen to content in libraries you have access to. For more information, see [Follow a library](../libraries/follow_library).
```
You can listen to your playlists or playlists created by other users of your {term}`pod`.
```{contents}
:local:
```
## Listen to your playlists
To listen to playlists you created:
```{tabbed} Desktop
1. Select {menuselection}`My Library --> Playlists` in the sidebar. The {guilabel}`Browsing playlists` screen opens.
2. Use the filters to search for your playlist.
3. Select the orange play icon ({fa}`play`) on your playlist to start playing the content.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
3. Use the filters to search for your playlist.
4. Select the orange play icon ({fa}`play`) on your playlist to start playing the content.
```
You're done! Your playlist's content appears in your [queue](../queue/index.md).
## Listen to public playlists from your pod
To listen to public playlists other users created:
```{tabbed} Desktop
1. Select {menuselection}`Explore --> Playlists` in the sidebar. The {guilabel}`Browsing playlists` screen opens.
2. Use the filters to search for a playlist.
3. Select the orange play icon ({fa}`play`) on your selected playlist to start playing the content.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
3. Use the filters to search for a playlist.
4. Select the orange play icon ({fa}`play`) on your selected playlist to start playing the content.
```
That's it! The playlist's content appears in your [queue](../queue/index.md).

32
docs/user_documentation/playlists/remove_content.md Normal file
View file

@ -0,0 +1,32 @@
# Remove content from a playlist
```{warning}
Removing content from a playlist removes it for anybody who follows the playlist.
```
You can remove content from a playlist at any time. To do this:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
5. Select the delete icon ({fa}`trash`) next to the content you want to remove. Select {guilabel}`Clear playlist` to remove all content at once.
6. Select {guilabel}`Stop Editing` to finish editing.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
6. Select the delete icon ({fa}`trash`) next to the content you want to remove. Select {guilabel}`Clear playlist` to remove all content at once.
7. Select {guilabel}`Stop Editing` to finish editing.
```
That's it! You've removed the content from your playlist.

29
docs/user_documentation/playlists/reorder_content.md Normal file
View file

@ -0,0 +1,29 @@
# Reorder content in a playlist
You can change the order of the tracks in a playlist. To do this:
```{tabbed} Desktop
1. Log in to your account.
2. Select {guilabel}`Playlists` under the {guilabel}`My Library` section of the sidebar. The {guilabel}`Browsing playlists` screen opens.
3. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
4. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
5. Drag and drop the tracks in the playlist into the order you want. The position number of each track appears on the left side.
6. Select {guilabel}`Stop Editing` to finish editing.
```
```{tabbed} Mobile
1. Log in to your account.
2. Select the hamburger menu ({fa}`bars`) to open the menu bar.
3. Select {menuselection}`My Library --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
4. Select {guilabel}`Manage your playlists`. The {guilabel}`Manage playlists` screen appears.
5. Select the edit icon ({fa}`edit`) next to the playlist you want to edit. The playlist edit screen appears.
6. Drag and drop the tracks in the playlist into the order you want. The position number of each track appears on the left side.
7. Select {guilabel}`Stop Editing` to finish editing.
```
You're done! You've updated the order of the tracks in your playlist.

19
docs/user_documentation/plugins/index.md Normal file
View file

@ -0,0 +1,19 @@
# User plugins
```{note}
Your {term}`pod's <Pod>` admin needs to enable plugins for you to use them. If you can't find the plugins mentioned here, contact your pod admin.
```
Use plugins to extend Funkwhale's features. The Funkwhale collective maintains core plugins to make your listening experience even better. Developers can create extra plugins to add features to a pod.
```{toctree}
---
maxdepth: 1
caption: Core plugins
---
scrobbler_plugin
listenbrainz_plugin
maloja_plugin
```

33
docs/user_documentation/plugins/listenbrainz_plugin.md Normal file
View file

@ -0,0 +1,33 @@
# ListenBrainz plugin
The __ListenBrainz__ plugin enables you to submit ({term}`scrobble<Scrobbling>`) listens to your [ListenBrainz](https://listenbrainz.org) account. Scrobbling listens helps you build up a profile of your music tastes. It also enables you to keep a record of your listens. To set up the __ListenBrainz plugin__:
```{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 down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`ListenBrainz` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter {guilabel}`Your ListenBrainz user token`. You can find this on your ListenBrainz profile.
9. Select {guilabel}`Save`.
```
```{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 down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`ListenBrainz` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter {guilabel}`Your ListenBrainz user token`. You can find this on your ListenBrainz profile.
9. Select {guilabel}`Save`.
```
That's it! You've set up the __ListenBrainz__ plugin. When you listen to tracks, the plugin sends the information to ListenBrainz.

37
docs/user_documentation/plugins/maloja_plugin.md Normal file
View file

@ -0,0 +1,37 @@
# Maloja plugin
The __Maloja__ plugin enables you to submit ({term}`scrobble <Scrobbling>`) listens to your Maloja server. [Maloja](https://github.com/krateng/maloja) is a self-hosted scrobbling service similar to [Last.fm](https://last.fm) and [ListenBrainz](https://listenbrainz.org). Check out [their documentation](https://github.com/krateng/maloja#how-to-install) to set up your own server.
Scrobbling listens helps you build up a profile of your music tastes. It also enables you to keep a record of your listens. To set up the __Maloja plugin__:
```{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 down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`Maloja` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter your {guilabel}`Maloja server URL`. This is the URL you set up for your Maloja server.
9. Enter {guilabel}`Your Maloja API key`. Check out [Maloja's documentation](https://github.com/krateng/maloja#how-to-scrobble) for more information.
10. Select {guilabel}`Save`.
```
```{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 down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`Maloja` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter your {guilabel}`Maloja server URL`. This is the URL you set up for your Maloja server.
9. Enter {guilabel}`Your Maloja API key`. Check out [Maloja's documentation](https://github.com/krateng/maloja#how-to-scrobble) for more information.
10. Select {guilabel}`Save`.
```
That's it! You've set up the __Maloja__ plugin. When you listen to tracks, the plugin sends the information to your Maloja server.

47
docs/user_documentation/plugins/scrobbler_plugin.md Normal file
View file

@ -0,0 +1,47 @@
# Scrobbler plugin
```{note}
If you want to use [Last.fm](https://last.fm) to scrobble your listens, your pod admin needs to set up an API account. Contact your {term}`pod` admin if you have any questions.
```
The __Scrobbler__ plugin enables you to submit ({term}`scrobble<Scrobbling>`) listens to a scrobbler service. Scrobbling listens helps you build up a profile of your music tastes. It also enables you to keep a record of your listens.
```{tip}
Using ListenBrainz or Maloja? Check out the [ListenBrainz](listenbrainz_plugin) and [Maloja](maloja_plugin) plugins!
```
The __Scrobbler__ plugin supports any scrobbling service that uses the Audioscrobbler protocol. To set up the __Scrobbler plugin__:
```{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 down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`Scrobbler` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter the {guilabel}`URL of the scrobbler service`. If you leave this field blank, the plugin defaults to __Last.fm__.
9. Enter {guilabel}`Your scrobbler username`. You can set this up on your scrobbler service.
10. Enter {guilabel}`Your scrobbler password`. You can set this up on your scrobbler service.
11. Select {guilabel}`Save`.
```
```{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 down to the {guilabel}`Plugins` section.
5. Select {guilabel}`Manage plugins`.
6. Find the {guilabel}`Scrobbler` plugin.
7. Toggle the {guilabel}`Enabled` switch.
8. Enter the {guilabel}`URL of the scrobbler service`. If you leave this field blank, the plugin defaults to __Last.fm__.
9. Enter {guilabel}`Your scrobbler username`. You can set this up on your scrobbler service.
10. Enter {guilabel}`Your scrobbler password`. You can set this up on your scrobbler service.
11. Select {guilabel}`Save`.
```
That's it! You've set up the __Scrobbler__ plugin. When you listen to tracks, the plugin sends the information to your scrobbler service.

32
docs/user_documentation/queue/add_album.md Normal file
View file

@ -0,0 +1,32 @@
# Add albums to your queue
Add entire albums to your queue to start listening to them. Choose from the following __Play options__:
- __Play__ – remove all content from the queue and play the selected album.
- __Add to queue__ – add the selected album to the end of the queue.
- __Play next__ – add the selected album to the next position in the queue.
- __Play now__ – play the selected album immediately but do not clear the queue.
You can add albums from the following places:
```{contents}
:local:
```
## From the album details page
To add an album to the queue from the album details page:
1. Go to the album's details page.
2. Select the orange play button ({fa}`play`) to __Play__ the album. Select the dropdown icon ({fa}`caret-down`) to select a different __Play option__.
You're done! You've added the album to your queue.
## From an album card
To add an album from its album card:
1. Find the album card in the interface.
2. Select the orange play button ({fa}`play`) to __Play__ the album. Select the kebab menu ({fa}`ellipsis-v`) to select a different __Play option__.
That's it! You've added the album to your queue.

32
docs/user_documentation/queue/add_artist.md Normal file
View file

@ -0,0 +1,32 @@
# Add artist discographies to your queue
Add an artist's entire discography to your queue to start listening to it. Choose from the following __Play options__:
- __Play__ – remove all content from the queue and play the artist's discography.
- __Add to queue__ – add the selected artist's discography to the end of the queue.
- __Play next__ – add the selected artist's discography to the next position in the queue.
- __Play now__ – play the artist's discography immediately but do not clear the queue.
You can add an artist's discography from the following places:
```{contents}
:local:
```
## From the artist details page
To add an artist's discography to the queue from the artist details page:
1. Go to the artist's details page.
2. Select the orange play button ({fa}`play`) to __Play__ the album. Select the {guilabel}`More…` to select a different __Play option__.
You're done! You've added the artist's discography to your queue.
## From an artist card
To add an artist's discography from their artist card:
1. Find the artist card in the interface.
2. Select the orange play button ({fa}`play`) to __Play__ the album. Select the kebab menu ({fa}`ellipsis-v`) to select a different __Play option__.
That's it! You've added the artist's discography to your queue.

32
docs/user_documentation/queue/add_playlist.md Normal file
View file

@ -0,0 +1,32 @@
# Add playlists to your queue
Add entire playlists to your queue to start listening to them. Choose from the following __Play options__:
- __Play__ – remove all content from the queue and play the selected playlist.
- __Add to queue__ – add the selected playlist to the end of the queue.
- __Play next__ – add the selected playlist to the next position in the queue.
- __Play now__ – play the selected playlist immediately but do not clear the queue.
You can add playlists from the following places:
```{contents}
:local:
```
## From the playlist details page
To add an playlist to the queue from the playlist details page:
1. Go to the playlist's details page.
2. Select {guilabel}`Play all` to __Play__ the playlist. Select the dropdown icon ({fa}`caret-down`) to select a different __Play option__.
You're done! You've added the playlist to your queue.
## From an playlist card
To add an playlist from its playlist card:
1. Find the playlist card in the interface.
2. Select the orange play button ({fa}`play`) to __Play__ the playlist. Select the kebab menu ({fa}`ellipsis-v`) to select a different __Play option__.
That's it! You've added the playlist to your queue.

15
docs/user_documentation/queue/add_series.md Normal file
View file

@ -0,0 +1,15 @@
# Add series to your queue
Add entire series to your queue to start listening to them. Choose from the following __Play options__:
- __Play__ – remove all content from the queue and play the selected series.
- __Add to queue__ – add the selected series to the end of the queue.
- __Play next__ – add the selected series to the next position in the queue.
- __Play now__ – play the selected series immediately but do not clear the queue.
To add a series to the queue from the album details page:
1. Go to the series' details page.
2. Select the orange play button ({fa}`play`) to __Play__ the series. Select the dropdown icon ({fa}`caret-down`) to select a different __Play option__.
You're done! You've added the series to your queue.

15
docs/user_documentation/queue/add_tracks.md Normal file
View file

@ -0,0 +1,15 @@
# Add tracks to your queue
Add tracks to your queue to start listening to them. Choose from the following __Play options__:
- __Play__ – remove all content from the queue and play the selected track.
- __Add to queue__ – add the selected track to the end of the queue.
- __Play next__ – add the selected track to the next position in the queue.
- __Play now__ – play the selected track immediately but do not clear the queue.
To add a track to the queue:
1. Find your track in a track table.
2. Select the orange play button ({fa}`play`) to __Play__ the track. Select the kebab menu ({fa}`ellipsis-v`) to select a different __Play option__.
That's it! You've added the track to your queue.

21
docs/user_documentation/queue/index.md Normal file
View file

@ -0,0 +1,21 @@
# Queue
Use the audio queue to manage audio playback. You can add tracks, albums, series, artist discographies, and playlists to your queue.
Follow the guides in this section to get started.
```{toctree}
---
caption: Manage your queue
maxdepth: 1
---
add_tracks
add_album
add_series
add_artist
add_playlist
rearrange_content
remove_content
```

14
docs/user_documentation/queue/rearrange_content.md Normal file
View file

@ -0,0 +1,14 @@
# Rearrange content in your queue
```{note}
Rearranging content is currently only supported on the desktop.
```
You can change the order of content in your queue at any time. To do this:
1. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the queue.
2. Pick up tracks by selecting the grip lines on the left. Your mouse pointer shows a hand ({fa}`hand-grab-o`).
3. Drop the tracks in their new position in the queue.
4. Select {guilabel}`Close` to close the queue.
That's it! You've rearranged the content in your queue.

52
docs/user_documentation/queue/remove_content.md Normal file
View file

@ -0,0 +1,52 @@
# Remove content from your queue
```{note}
If you remove the currently playing track, the next item in the queue plays. If you remove all items, the queue closes.
```
You can remove content from your queue at any time. You can choose between the following options:
```{contents}
:local:
```
## Remove individual tracks from the queue
To remove individual tracks from the queue:
```{tabbed} Desktop
1. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the queue.
2. Select the delete icon ({fa}`times`) next to the track you want to remove.
```
```{tabbed} Mobile
1. Select the player bar at the bottom of the screen to expand the player.
2. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the queue.
3. Select the delete icon ({fa}`times`) next to the track you want to remove.
```
That's it! You've removed tracks from your queue.
## Remove all content from the queue
To remove all content from your queue at once:
```{tabbed} Desktop
1. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the queue.
2. Select {guilabel}`Clear` to remove all content from the queue.
```
```{tabbed} Mobile
1. Select the player bar at the bottom of the screen to expand the player.
2. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the queue.
3. Select {guilabel}`Clear` to remove all content from the queue.
```
That's it! You've removed all content from your queue.

48
docs/user_documentation/radios/create_radio.md Normal file
View file

@ -0,0 +1,48 @@
# Create a radio
```{note}
If you add content from a __private__ library to a __public__ radio, users can see the tracks but can't play them.
```
Create a new radio to create a dynamic playlist of content based on filters. You can filter tracks by __Artist__ and __Tag__.
To create a new radio:
```{tabbed} Desktop
1. Select {guilabel}`Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Select {guilabel}` Create your own radio` under the {guilabel}`User radios` section. The {guilabel}`Builder` screen opens.
3. Enter a {guilabel}`Radio name`.
4. __Optional__ – enter a {guilabel}`Description` for your radio.
5. To make your radio available to other users on your {term}`pod`, enable the {guilabel}`Display publicly` switch. If you disable this switch, only you can see the radio.
6. Select {guilabel}`Artist` or {guilabel}`Tag` from the {guilabel}`Select a filter` dropdown.
7. Select {guilabel}`Add filter` to add the filter to your radio.
8. Configure your filter:
1. Enable the {guilabel}`Exclude` switch to exclude results from your selection in the radio. Disable this switch to include results from your selection in the radio.
2. Choose your __Artists__ or __Tags__ in the {guilabel}`Config` dropdown menu.
3. The {guilabel}`Candidates` column shows the number of tracks included. Select the {guilabel}`{count} tracks matching filter` option to view some of these tracks.
9. Check the tracks under the {guilabel}`{count} tracks matching combined filters` section.
10. Select {guilabel}`Save` to save your radio.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Radios` or {menuselection}`My Library --> Radios`. The {guilabel}`Browsing radios` screen opens.
3. Select {guilabel}` Create your own radio` under the {guilabel}`User radios` section. The {guilabel}`Builder` screen opens.
4. Enter a {guilabel}`Radio name`.
5. __Optional__ – enter a {guilabel}`Description` for your radio.
6. To make your radio available to other users on your {term}`pod`, enable the {guilabel}`Display publicly` switch. If you disable this switch, only you can see the radio.
7. Select {guilabel}`Artist` or {guilabel}`Tag` from the {guilabel}`Select a filter` dropdown.
8. Select {guilabel}`Add filter` to add the filter to your radio.
9. Configure your filter:
1. Enable the {guilabel}`Exclude` switch to exclude results from your selection in the radio. Disable this switch to include results from your selection in the radio.
2. Choose your __Artists__ or __Tags__ in the {guilabel}`Config` dropdown menu.
3. The {guilabel}`Candidates` column shows the number of tracks included. Select the {guilabel}`{count} tracks matching filter` option to view some of these tracks.
10. Check the tracks under the {guilabel}`{count} tracks matching combined filters` section.
11. Select {guilabel}`Save` to save your radio.
```
You're done! You can now play your radio.

27
docs/user_documentation/radios/delete_radio.md Normal file
View file

@ -0,0 +1,27 @@
# Delete a radio
```{warning}
Users who have access to your radio won't be able to access it when you delete it. This action is irreversible.
```
If you no longer want a radio, you can delete it. To do this:
```{tabbed} Desktop
1. Select {guilabel}`Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Select your radio under the {guilabel}`User radios` section. The radio details screen opens.
3. Select {guilabel}`Delete`. A {guilabel}`Do you want to delete the radio` warning appears.
4. Select {guilabel}`Delete radio`.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Radios` or {menuselection}`My Library --> Radios`. The {guilabel}`Browsing radios` screen opens.2. 3. Select your radio under the {guilabel}`User radios` section. The radio details screen opens.
4. Select {guilabel}`Delete`. A {guilabel}`Do you want to delete the radio` warning appears.
5. Select {guilabel}`Delete radio`.
```
That's it! You've deleted your radio. You can [create a new one](create_radio.md) at any time.

32
docs/user_documentation/radios/edit_radio.md Normal file
View file

@ -0,0 +1,32 @@
# Edit a radio
You can edit a radio at any time to change its details, its filters, or both. To do this:
```{tabbed} Desktop
1. Select {guilabel}`Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Find your radio under the {guilabel}`User radios` section. Select {guilabel}`Edit`. The {guilabel}`Builder` screen opens.
3. Edit any of the following:
- {guilabel}`Radio name`.
- {guilabel}`Description`.
- {guilabel}`Display publicly`.
4. Select {guilabel}`Add filter` to add new filters. Select {guilabel}`Remove` to remove existing filters.
5. Select {guilabel}`Save` to save your radio.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Radios` or {menuselection}`My Library --> Radios`. The {guilabel}`Browsing radios` screen opens.
3. Find your radio under the {guilabel}`User radios` section. Select {guilabel}`Edit`. The {guilabel}`Builder` screen opens.
4. Edit any of the following:
- {guilabel}`Radio name`.
- {guilabel}`Description`.
- {guilabel}`Display publicly`.
5. Select {guilabel}`Add filter` to add new filters. Select {guilabel}`Remove` to remove existing filters.
6. Select {guilabel}`Save` to save your radio.
```
That's it! You've updated your radio's details.

24
docs/user_documentation/radios/index.md Normal file
View file

@ -0,0 +1,24 @@
# Radios
Radios are a great way to discover new music or rediscover old favorites. A radio builds a dynamic playlist of content based on selected criteria. Create genre and artist radios, or tune in to one of Funkwhale's built-in radios.
Funkwhale offers the following radios out of the box:
- __Your content__ – listen to content from [libraries](../libraries/index.md) you own.
- __Favorites__ – listen to tracks from your [favorites](../favorites/index.md) list.
- __Random__ – discover something new by letting Funkwhale choose tracks at random.
- __Recently Added__ – listen to the latest content added to your {term}`pod`.
- __Less listened__ – check out tracks you've not heard, or things you haven't given as much attention.
```{toctree}
---
caption: Manage your radios
maxdepth: 1
---
create_radio
edit_radio
listen_radio
delete_radio
```

78
docs/user_documentation/radios/listen_radio.md Normal file
View file

@ -0,0 +1,78 @@
# Listen to a radio
```{note}
You can only listen to content in libraries you have access to. For more information, see [Follow a library](../libraries/follow_library).
```
You can listen to your radios or public radios created by other users of your {term}`pod`.
```{contents}
:local:
```
## Listen to your radios
To listen to radios you created:
```{tabbed} Desktop
1. Select {menuselection}`My Library --> Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Use the filters in the {guilabel}`User radios` section to search for your radio.
3. Select {guilabel}`Play radio` on your radio to start playing the content.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`My Library --> Radios`. The {guilabel}`Browsing radios` screen opens.
3. Use the filters in the {guilabel}`User radios` section to search for your radio.
4. Select {guilabel}`Play radio` on your radio to start playing the content.
```
You're done! Your radio starts playing.
## Listen to public radios from your pod
To listen to public radios other users created:
```{tabbed} Desktop
1. Select {menuselection}`Explore --> Radios` in the sidebar. The {guilabel}`Browsing radios` screen opens.
2. Use the filters in the {guilabel}`User radios` section to search for a radio.
3. Select {guilabel}`Play radio` on the selected radio to start playing the content.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Radios`. The {guilabel}`Browsing radios` screen opens.
3. Use the filters in the {guilabel}`User radios` section to search for a radio.
4. Select {guilabel}`Play radio` on the selected radio to start playing the content.
```
That's it! The radio starts playing.
## Stop a radio
Radios continue to play until there is no more content matching their criteria. You can stop radios whenever you want. To do this:
```{tabbed} Desktop
1. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the [queue](../queue/index.md).
2. Select {guilabel}`Stop Radio` at the bottom of the queue.
```
```{tabbed} Mobile
1. Select the player bar at the bottom of the screen to expand the player.
2. Select the up arrow ({fa}`caret-up`) on the queue menu to expand the [queue](../queue/index.md).
3. Select {guilabel}`Stop Radio` at the bottom of the queue.
```
That's it! The radio stops playing. The radio's content remains in the queue.

23
docs/user_documentation/reports/index.md Normal file
View file

@ -0,0 +1,23 @@
# Reporting
```{note}
{term}`Pod <Pod>` admins and moderators are responsible for handling reports. Pod admins can choose to allow anonymous (logged out) users to send reports. If you cannot send reports anonymously, contact the pod admin.
```
Funkwhale provides tools for reporting all content and accounts. You can report content for being objectionable or illegal. You can also report stolen content. Check out the guides in this section to see how to send a report.
```{toctree}
---
caption: Submit reports
maxdepth: 1
---
report_account
report_channel
report_library
report_track
report_album
report_artist
report_playlist
```

17
docs/user_documentation/reports/report_account.md Normal file
View file

@ -0,0 +1,17 @@
# Report an account
You can report a user account if the user is breaking the {term}`pod's <Pod>` rules. To do this:
1. Select the user's username to go to their profile page.
2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
3. Select {guilabel}`Report {username}`. A {guilabel}`Do you want to report this object?` menu appears.
4. Select a {guilabel}`Category`. Choose one of the following:
- __Takedown request__ – request removal of copyrighted material.
- __Illegal content__ – report an account that features illegal content.
- __Offensive content__ – report an account that features offensive or abusive content.
- __Other__ – submit details of your report in the {guilabel}`Message` field.
5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
7. Select {guilabel}`Submit report` to send your report to the pod moderators.
That's it! The pod's moderators can now action the report or contact you for clarification.

18
docs/user_documentation/reports/report_album.md Normal file
View file

@ -0,0 +1,18 @@
# Report an album
If an album violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
1. Go to the album details page.
2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
3. Select {guilabel}`Report this album`. A {guilabel}`Do you want to report this object?` menu appears.
4. Select a {guilabel}`Category`. Choose one of the following:
- __Takedown request__ – request removal of copyrighted material.
- __Illegal content__ – report an album that features illegal content.
- __Offensive content__ – report an album that features offensive or abusive content.
- __Invalid metadata__ – report that an album features invalid metadata.
- __Other__ – submit details of your report in the {guilabel}`Message` field.
5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
7. Select {guilabel}`Submit report` to send your report to the pod moderators.
That's it! The pod's moderators can now action the report or contact you for clarification.

18
docs/user_documentation/reports/report_artist.md Normal file
View file

@ -0,0 +1,18 @@
# Report an artist
If an artist's content violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
1. Go to the artist details page.
2. Select {guilabel}`More…` to open the options menu.
3. Select {guilabel}`Report this artist`. A {guilabel}`Do you want to report this object?` menu appears.
4. Select a {guilabel}`Category`. Choose one of the following:
- __Takedown request__ – request removal of copyrighted material.
- __Illegal content__ – report an artist that features illegal content.
- __Offensive content__ – report an artist that features offensive or abusive content.
- __Invalid metadata__ – report that an artist's content features invalid metadata.
- __Other__ – submit details of your report in the {guilabel}`Message` field.
5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
7. Select {guilabel}`Submit report` to send your report to the pod moderators.
That's it! The pod's moderators can now action the report or contact you for clarification.

18
docs/user_documentation/reports/report_channel.md Normal file
View file

@ -0,0 +1,18 @@
# Report a channel
If a channel's content violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
1. Go to the channel's details page.
2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
3. Select {guilabel}`Report this channel`. A {guilabel}`Do you want to report this object?` menu appears.
4. Select a {guilabel}`Category`. Choose one of the following:
- __Takedown request__ – request removal of copyrighted material.
- __Illegal content__ – report a channel that features illegal content.
- __Offensive content__ – report a channel that features offensive or abusive content.
- __Invalid metadata__ – report that a channel's content features invalid metadata.
- __Other__ – submit details of your report in the {guilabel}`Message` field.
5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
7. Select {guilabel}`Submit report` to send your report to the pod moderators.
That's it! The pod's moderators can now action the report or contact you for clarification.

18
docs/user_documentation/reports/report_library.md Normal file
View file

@ -0,0 +1,18 @@
# Report a library
If a channel's content violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
1. Go to the library's details page.
2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
3. Select {guilabel}`Report this library`. A {guilabel}`Do you want to report this object?` menu appears.
4. Select a {guilabel}`Category`. Choose one of the following:
- __Takedown request__ – request removal of copyrighted material.
- __Illegal content__ – report a library that features illegal content.
- __Offensive content__ – report a library that features offensive or abusive content.
- __Invalid metadata__ – report that a library's content features invalid metadata.
- __Other__ – submit details of your report in the {guilabel}`Message` field.
5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
7. Select {guilabel}`Submit report` to send your report to the pod moderators.
That's it! The pod's moderators can now action the report or contact you for clarification.

42
docs/user_documentation/reports/report_playlist.md Normal file
View file

@ -0,0 +1,42 @@
# Report a playlist
If a playlist's content violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
```{tabbed} Desktop
1. Select {menuselection}`Explore --> Playlists` in the sidebar. The {guilabel}`Browsing playlists` screen opens.
2. Use the filters to search for a playlist.
3. Select the three dot menu ({fa}`ellipsis-h`) to open the options menu.
4. Select {guilabel}`Report this playlist`. A {guilabel}`Do you want to report this object?` menu appears.
5. Select a {guilabel}`Category`. Choose one of the following:
- __Takedown request__ – request removal of copyrighted material.
- __Illegal content__ – report a playlist that features illegal content.
- __Offensive content__ – report a playlist that features offensive or abusive content.
- __Invalid metadata__ – report that a playlist's content features invalid metadata.
- __Other__ – submit details of your report in the {guilabel}`Message` field.
6. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
7. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
8. Select {guilabel}`Submit report` to send your report to the pod moderators.
```
```{tabbed} Mobile
1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
2. Select {menuselection}`Explore --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
3. Use the filters to search for a playlist.
4. Select the three dot menu ({fa}`ellipsis-h`) to open the options menu.
5. Select {guilabel}`Report this playlist`. A {guilabel}`Do you want to report this object?` menu appears.
6. Select a {guilabel}`Category`. Choose one of the following:
- __Takedown request__ – request removal of copyrighted material.
- __Illegal content__ – report a playlist that features illegal content.
- __Offensive content__ – report a playlist that features offensive or abusive content.
- __Invalid metadata__ – report that a playlist's content features invalid metadata.
- __Other__ – submit details of your report in the {guilabel}`Message` field.
7. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
8. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
9. Select {guilabel}`Submit report` to send your report to the pod moderators.
```
That's it! The pod's moderators can now action the report or contact you for clarification.

18
docs/user_documentation/reports/report_track.md Normal file
View file

@ -0,0 +1,18 @@
# Report a track
If a track violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
1. Go to the track details page or locate the track in a track table.
2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
3. Select {guilabel}`Report this track`. A {guilabel}`Do you want to report this object?` menu appears.
4. Select a {guilabel}`Category`. Choose one of the following:
- __Takedown request__ – request removal of copyrighted material.
- __Illegal content__ – report a track that features illegal content.
- __Offensive content__ – report a track that features offensive or abusive content.
- __Invalid metadata__ – report that a track features invalid metadata.
- __Other__ – submit details of your report in the {guilabel}`Message` field.
5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
7. Select {guilabel}`Submit report` to send your report to the pod moderators.
That's it! The pod's moderators can now action the report or contact you for clarification.

29
docs/user_documentation/subsonic/disable_subsonic.md Normal file
View 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
View 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
View 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
View 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.