2022-01-19 18:49:46 +00:00
# Welcome to Funkwhale's documentation
Funkwhale is a self-hosted audio player and publication platform. It enables users to build libraries of existing content and publish their own.
Funkwhale uses the [ActivityPub protocol ](https://www.w3.org/TR/activitypub/ ) to talk to other apps across the {term}`Fediverse`. Users can share content between {term}`Funkwhale pods < Pod > ` or with other Fediverse software.
```{toctree}
---
maxdepth: 1
hidden: true
caption: User documentation
---
user_documentation/index
user_documentation/accounts/index
user_documentation/channels/index
user_documentation/libraries/index
user_documentation/queue/index
user_documentation/playlists/index
user_documentation/radios/index
user_documentation/favorites/index
user_documentation/reports/index
user_documentation/subsonic/index
user_documentation/plugins/index
user_documentation/info/cli
```
```{toctree}
---
maxdepth: 1
caption: Admin documentation
hidden: true
---
2022-01-22 17:17:03 +00:00
administrator_documentation/index
administrator_documentation/installation_docs/index
2022-07-01 09:02:29 +00:00
administrator_documentation/configuration_docs/index
administrator_documentation/import_docs/index
administrator_documentation/upgrade_docs/index
2022-04-02 13:25:22 +00:00
administrator_documentation/migration_guide/index
2022-07-01 09:02:29 +00:00
administrator_documentation/django/index
administrator_documentation/manage_script/index
administrator_documentation/uninstall_docs/index
administrator_documentation/troubleshooting/index
2022-01-19 18:49:46 +00:00
```
```{toctree}
---
maxdepth: 1
caption: Moderator documentation
hidden: true
---
2022-01-20 09:43:38 +00:00
moderator_documentation/index
moderator_documentation/reports/index
2022-01-21 17:40:26 +00:00
moderator_documentation/internal_users/index
2022-01-22 13:19:36 +00:00
moderator_documentation/content/index
2022-01-20 14:03:00 +00:00
moderator_documentation/domains/index
2022-01-21 17:40:26 +00:00
moderator_documentation/external_users/index
2022-01-20 19:07:21 +00:00
moderator_documentation/allow_listing/index
2022-01-19 18:49:46 +00:00
```
```{toctree}
---
maxdepth: 1
caption: Developer documentation
hidden: true
---
2022-10-09 17:44:08 +00:00
developer_documentation/index
2022-10-20 16:49:32 +00:00
developer_documentation/architecture
2022-10-09 17:44:08 +00:00
developer_documentation/setup/index
developer_documentation/contribute/index
developer_documentation/workflows/index
2022-10-20 16:38:24 +00:00
developer_documentation/api/index
2022-10-24 18:54:34 +00:00
developer_documentation/federation/index
2022-10-20 20:04:38 +00:00
developer_documentation/plugins/index
2022-01-19 18:49:46 +00:00
```
```{toctree}
---
maxdepth: 1
caption: Contributor documentation
hidden: true
---
2022-10-25 16:51:47 +00:00
contributor_documentation/index
contributor_documentation/documentation
2022-10-27 10:05:41 +00:00
contributor_documentation/translation
2022-01-19 18:49:46 +00:00
```
```{toctree}
---
caption: Reference
maxdepth: 1
hidden: true
---
glossary
```
```{toctree}
---
caption: Changes
maxdepth: 1
hidden: true
---
changelog
```
2022-07-23 13:32:35 +00:00
::::{grid} 2
2022-01-19 18:49:46 +00:00
2022-07-23 13:32:35 +00:00
:::{grid-item-card}
:text-align: center
{fa}`user` Users
^^^
2022-01-19 18:49:46 +00:00
Looking to use Funkwhale for your content? Read through our guides to master the app!
+++
2022-07-23 13:32:35 +00:00
```{button-link} user_documentation/index.html
:ref-type: myst
:color: primary
:outline:
:click-parent:
:expand:
Get started
2022-01-19 18:49:46 +00:00
```
2022-07-23 13:32:35 +00:00
:::
:::{grid-item-card}
:text-align: center
2022-01-19 18:49:46 +00:00
{fa}`wrench` Admins
2022-07-23 13:32:35 +00:00
^^^
2022-01-19 18:49:46 +00:00
Want to host your own Funkwhale pod? Our admin documentation guides you through the process.
+++
2022-07-23 13:32:35 +00:00
```{button-link} administrator_documentation/index.html
:ref-type: ref
:color: primary
:outline:
:click-parent:
:expand:
2022-01-19 18:49:46 +00:00
2022-07-23 13:32:35 +00:00
Get started
```
:::
:::{grid-item-card}
:text-align: center
2022-01-19 18:49:46 +00:00
2022-01-20 09:43:38 +00:00
{fa}`shield` Moderators
2022-07-23 13:32:35 +00:00
^^^
2022-01-20 09:43:38 +00:00
Keeping your users safe from harassment and spam or clearing illegal content? Check out our moderator docs.
+++
2022-07-23 13:32:35 +00:00
```{button-link} moderator_documentation/index.html
:ref-type: ref
:color: primary
:outline:
:click-parent:
:expand:
2022-01-20 09:43:38 +00:00
2022-07-23 13:32:35 +00:00
Get started
```
:::
:::{grid-item-card}
:text-align: center
2022-01-20 09:43:38 +00:00
2022-01-19 18:49:46 +00:00
{fa}`code` Developers
2022-07-23 13:32:35 +00:00
^^^
2022-01-19 18:49:46 +00:00
Want to use Funkwhale's API or help with the project? Our developer docs give you what you need to get started.
+++
2022-10-09 17:44:08 +00:00
```{button-link} developer_documentation/index.html
2022-07-23 13:32:35 +00:00
:ref-type: ref
:color: primary
:outline:
:click-parent:
:expand:
2022-01-19 18:49:46 +00:00
2022-07-23 13:32:35 +00:00
Get started
```
:::
::::
::::{grid} 1
:::{grid-item-card}
:text-align: center
2022-01-19 18:49:46 +00:00
{fa}`users` Contributors
2022-07-23 13:32:35 +00:00
^^^
2022-01-19 18:49:46 +00:00
Want to help make Funkwhale even better? Check out these guides for some ideas.
+++
2022-10-25 16:51:47 +00:00
```{button-link} contributor_documentation/index.html
2022-07-23 13:32:35 +00:00
:ref-type: ref
:color: primary
:outline:
:click-parent:
:expand:
Get started
```
2022-01-19 18:49:46 +00:00
2022-07-23 13:32:35 +00:00
:::
::::
