MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More federation documentation

This commit is contained in:
Eliot Berriot 2018-04-17 21:26:49 +02:00
parent a37183f57e
commit 6efbb4fb35
No known key found for this signature in database
GPG Key ID: DD6965E2476E5C27
1 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/federation.rst
View File

@ -7,11 +7,26 @@ and share its own library with an instance C.
We support various levels of controls for federation-related features. We support various levels of controls for federation-related features.
Managing federation
-------------------
Federation management is only available to instance admins and users
who have the proper permissions. You can disable federation completely
at the instance level by setting the FEDERATION_ENABLED environment variable
to False.
On the front end, assuming you have the proper permission, you will see
a "Federation" link in the sidebar.
Acquire music via federation Acquire music via federation
---------------------------- ----------------------------
Instance libraries are protected by default. To access another instance Instance libraries are protected by default. To access another instance
library, you have to follow it. This follow request will be sent to library, you have to follow it. Each funkwhale instance gets a dedicated
ActivityPub Actor you can follow via the username "library@yourinstance.domain".
When submitted, a follow request will be sent to
the other instance which can accept or deny it. Once your follow request the other instance which can accept or deny it. Once your follow request
is accepted, you can start browsing the other instance library is accepted, you can start browsing the other instance library
and import music from it. and import music from it.
@ -36,5 +51,7 @@ Federation is enabled by default, but requires manually approving
each other instance asking for access to library. This is by design, each other instance asking for access to library. This is by design,
to ensure your library is not shared publicly without your consent. to ensure your library is not shared publicly without your consent.
However, we offer a configuration option to alter this behaviour and However, if you're confident about federating publicly without manual approval,
disable the manual approval part. you can set the FEDERATION_MUSIC_NEEDS_APPROVAL environment variable to false.
Follow requests will be accepted automatically and followers
given access to your library without manual intervention.