kopia lustrzana https://dev.funkwhale.audio/funkwhale/funkwhale
173 wiersze
12 KiB
ReStructuredText
173 wiersze
12 KiB
ReStructuredText
Uploading Content To Funkwhale
|
|
==============================
|
|
|
|
To upload content to any Funkwhale instance, you need:
|
|
|
|
1. :doc:`An account on that instance <create>`
|
|
2. :ref:`Storage space <upload-storage>`
|
|
3. :ref:`A library <upload-library>` or :ref:`channel <upload-channel>`
|
|
4. :ref:`Properly tagged files <upload-tagging>`
|
|
5. :ref:`To upload your files <upload-upload>`
|
|
|
|
.. _upload-storage:
|
|
|
|
Storage space
|
|
-------------
|
|
|
|
Once you have an account on a Funkwhale instance, as a user, you are granted the
|
|
default upload quota (1GB by default). This default quota can be increased,
|
|
reduced or completely removed by your instance admins depending on their policy.
|
|
|
|
Additionally, instance admins can grant you storage space manually. Get in touch with them
|
|
if you'd like some additional storage space.
|
|
|
|
You can view your current quota and usage at any time by visiting ``/content/libraries/`` on your instance,
|
|
or clicking the "Add content" link in the sidebar, then visiting the "Upload audio content" section.
|
|
|
|
.. _upload-channel:
|
|
|
|
Using a Channel
|
|
---------------
|
|
|
|
A channel is a collection of content that is published directly to funkwhale. Channels are always public
|
|
and can be followed from different fediverse software such as Mastodon, Reel2Bits or other Funkwhale
|
|
pods.
|
|
|
|
There are two types of channel:
|
|
|
|
- A podcast channel
|
|
- An artist discography channel
|
|
|
|
See :doc:`channels` for more information on channels.
|
|
|
|
.. _upload-library:
|
|
|
|
Using a library
|
|
---------------
|
|
|
|
In Funkwhale's world, a library is a collection of audio files with an associated visibility level. A library can be:
|
|
|
|
- Public: anyone can follow the library to automatically access its content (including users on other instances)
|
|
- Local: other users from your instance can follow the library to automatically access its content
|
|
- Private: nobody apart from you can access the library content
|
|
|
|
Regardless of visibility settings, you can share the library link to specific users
|
|
and accept their follow request in order to grant then access to its content. Typically, this
|
|
is useful when you have a private library you want to share with friends or family.
|
|
|
|
Before you upload your content, you need to know the content audience and license:
|
|
|
|
- If the content is under an open license (like Creative Commons licenses), it's usually fine to upload it in a public library
|
|
- If you are uploading content purchased from other platforms or stores, you should upload it in a private library
|
|
|
|
.. note::
|
|
|
|
As a rule of thumb, only use public and local libraries for content for which you own the copyright or for content you know you can share with a wider audience.
|
|
|
|
See :doc:`libraries <managing>` for more information on libraries.
|
|
|
|
.. _upload-tagging:
|
|
|
|
Tagging files
|
|
-------------
|
|
|
|
Funkwhale relies on embedded file metadata (also known as tags) to infer the artist,
|
|
album and track associated with a given upload. Most stores and platforms include
|
|
those tags by default, but it's possible the tags are missing or incomplete, in which case
|
|
Funkwhale will not be able to process the upload and display an error.
|
|
|
|
The minimum required tags are:
|
|
|
|
- Title
|
|
- Artist
|
|
- Album
|
|
|
|
However, Funkwhale can understand and use additional tags to enhance user experience and display more information. The full list of supported tags is available below:
|
|
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| Name | Example value | Description |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| ``Title`` (required) | ``Letting you`` | The track title |
|
|
| | | |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| ``Artist`` (required) | ``Nine Inch Nails`` | The artist name |
|
|
| | | |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| ``Album`` | ``The Slip`` | The album title. If none is provided, an [Unknown Album] |
|
|
| | | entry will be 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 |
|
|
| | | 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 | The license associated with this work. The first found URL |
|
|
| | .org/licenses/cc-by/3.0/`` | will be checked against `our list of supported licenses`_ |
|
|
| | | |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| ``Copyright`` | ``CC-BY 3.0: http://creativecommons | The license associated with this work. The first found URL |
|
|
| | .org/licenses/cc-by/3.0/`` | will be checked against `our list of supported licenses`_. |
|
|
| | | Used if no license found in the License tag |
|
|
| | | |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| ``Pictures`` | | The first embeded picture found will be used as the album |
|
|
| | | covers |
|
|
| | | |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| ``MusicBrainz Recording ID`` | ``99244237-850b-4a93-904d-57305bcadb4e`` | The MusicBrainz ID for this recording |
|
|
| | | |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| ``MusicBrainz Album ID`` | ``bca982fd-ab73-3c9f-ad07-9104a4f53a32`` | The MusicBrainz ID for this album |
|
|
| | | |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| ``MusicBrainz Artist ID`` | ``b7ffd2af-418f-4be2-bdd1-22f8b48613da`` | The MusicBrainz ID for this artist |
|
|
| | | |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
| ``MusicBrainz Album Artist ID`` | ``b7ffd2af-418f-4be2-bdd1-22f8b48613da`` | The MusicBrainz ID for this album artist |
|
|
+----------------------------------+--------------------------------------------+---------------------------------------------------------------+
|
|
|
|
.. _our list of supported licenses: https://dev.funkwhale.audio/funkwhale/funkwhale/blob/develop/api/tests/music/licenses.json
|
|
|
|
The easiest way to inspect and edit file tags is with `MusicBrainz Picard <https://picard.musicbrainz.org/>`_, a free
|
|
software, that works on Windows, MacOS and Linux. Picard is able to automatically tag many files,
|
|
and include non-necessary but nice to have information, such as album covers. For a guide on tagging content with Picard,
|
|
see :doc:`tagging`.
|
|
|
|
Common errors during import
|
|
---------------------------
|
|
|
|
.. _invalid_metadata:
|
|
|
|
Invalid metadata
|
|
::::::::::::::::
|
|
|
|
This error occurs when the uploaded file miss some mandatory tags, or when some tags have
|
|
incorrect values (e.g an empty title or artist name).
|
|
|
|
To fix this issue, please retag the file properly as described in :ref:`upload-tagging`
|
|
and reupload it.
|
|
|
|
|
|
.. _unknown_error:
|
|
|
|
Unknown error
|
|
:::::::::::::
|
|
|
|
This error can happen for multiple reasons and likely indicates an issue with the Funkwhale
|
|
server (e.g. misconfiguration) or with Funkwhale itself.
|
|
|
|
If the issue persists when you relaunch the import, get in touch with our instance admin
|
|
or open a support thread on our forum.
|