[doc] Funkwhale capitalisation
This commit is contained in:
Reg
parent
294b3935be
commit
c2e599998b
|
|
@ -88,7 +88,7 @@ Default: ``Funkwhale <noreply@yourdomain>``
|
|||
Default: ``None``
|
||||
|
||||
The path on your server where Funwkhale can import files using :ref:`in-place import
|
||||
<in-place-import>`. It must be readable by the webserver and funkwhale
|
||||
<in-place-import>`. It must be readable by the webserver and Funkwhale
|
||||
api and worker processes.
|
||||
|
||||
On docker installations, we recommend you use the default of ``/music``
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ Funkwhale is a web based music server. It is similar in term of goals and featur
|
|||
A social platform
|
||||
------------------
|
||||
|
||||
However, funkwhale is better-suited for small to medium communities and was designed to be not only a music server and player, but also a place to socialize around music and discover new content. While some of these features are not currently implemented, our roadmap includes:
|
||||
However, Funkwhale is better-suited for small to medium communities and was designed to be not only a music server and player, but also a place to socialize around music and discover new content. While some of these features are not currently implemented, our roadmap includes:
|
||||
|
||||
- Radios, to discover the music of a given user, artist, genre...
|
||||
- Playlists
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ Acquire music via federation
|
|||
----------------------------
|
||||
|
||||
Instance libraries are protected by default. To access another instance
|
||||
library, you have to follow it. Each funkwhale instance gets a dedicated
|
||||
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
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@ Importing music
|
|||
From music directory on the server
|
||||
----------------------------------
|
||||
|
||||
You can import music files in funkwhale assuming they are located on the server
|
||||
and readable by the funkwhale application. Your music files should contain at
|
||||
You can import music files in Funkwhale assuming they are located on the server
|
||||
and readable by the Funkwhale application. Your music files should contain at
|
||||
least an ``artist``, ``album`` and ``title`` tags, but we recommend you tag
|
||||
it extensively using a proper tool, such as Beets or Musicbrainz Picard.
|
||||
|
||||
|
|
@ -59,7 +59,7 @@ to import and don't want to double your disk usage.
|
|||
The CLI importer supports an additional ``--in-place`` option that triggers the
|
||||
following behaviour during import:
|
||||
|
||||
1. Imported files are not store in funkwhale anymore
|
||||
1. Imported files are not store in Funkwhale anymore
|
||||
2. Instead, Funkwhale will store the file path and use it to serve the music
|
||||
|
||||
Because those files are not managed by Funkwhale, we offer additional
|
||||
|
|
|
|||
|
|
@ -8,8 +8,8 @@ Debian installation
|
|||
External dependencies
|
||||
---------------------
|
||||
|
||||
The guides will focus on installing funkwhale-specific components and
|
||||
dependencies. However, funkwhale requires a
|
||||
The guides will focus on installing Funkwhale-specific components and
|
||||
dependencies. However, Funkwhale requires a
|
||||
:doc:`few external dependencies <./external_dependencies>` for which
|
||||
documentation is outside of this document scope.
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ default on system. You can install them using:
|
|||
Layout
|
||||
-------
|
||||
|
||||
All funkwhale-related files will be located under ``/srv/funkwhale`` apart
|
||||
All Funkwhale-related files will be located under ``/srv/funkwhale`` apart
|
||||
from database files and a few configuration files. We will also have a
|
||||
dedicated ``funkwhale`` user to launch the processes we need and own those files.
|
||||
|
||||
|
|
@ -57,7 +57,7 @@ Now let's setup our directory layout. Here is how it will look like::
|
|||
├── api # api code of your instance
|
||||
├── data # persistent data, such as music files
|
||||
├── front # frontend files for the web user interface
|
||||
└── virtualenv # python dependencies for funkwhale
|
||||
└── virtualenv # python dependencies for Funkwhale
|
||||
|
||||
Create the aforementionned directories:
|
||||
|
||||
|
|
@ -67,7 +67,7 @@ Create the aforementionned directories:
|
|||
|
||||
The ``virtualenv`` directory is a bit special and will be created separately.
|
||||
|
||||
Download latest funkwhale release
|
||||
Download latest Funkwhale release
|
||||
----------------------------------
|
||||
|
||||
Funkwhale is splitted in two components:
|
||||
|
|
@ -79,7 +79,7 @@ Those components are packaged in subsequent releases, such as 0.1, 0.2, etc.
|
|||
You can browse the :doc:`changelog </changelog>` for a list of available releases
|
||||
and pick the one you want to install, usually the latest one should be okay.
|
||||
|
||||
In this guide, we'll assume you want to install the latest version of funkwhale,
|
||||
In this guide, we'll assume you want to install the latest version of Funkwhale,
|
||||
which is |version|:
|
||||
|
||||
First, we'll download the latest api release.
|
||||
|
|
@ -113,7 +113,7 @@ First, switch to the api directory:
|
|||
|
||||
cd api
|
||||
|
||||
A few OS packages are required in order to run funkwhale. The list is available
|
||||
A few OS packages are required in order to run Funkwhale. The list is available
|
||||
in ``api/requirements.apt`` or by running
|
||||
``./install_os_dependencies.sh list``.
|
||||
|
||||
|
|
@ -178,7 +178,7 @@ Finally, install the python dependencies:
|
|||
Environment file
|
||||
----------------
|
||||
|
||||
You can now start to configure funkwhale. The main way to achieve that is by
|
||||
You can now start to configure Funkwhale. The main way to achieve that is by
|
||||
adding an environment file that will host settings that are relevant to your
|
||||
installation.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
Docker installation
|
||||
====================
|
||||
|
||||
Docker is the easiest way to get a funkwhale instance up and running.
|
||||
Docker is the easiest way to get a Funkwhale instance up and running.
|
||||
|
||||
First, ensure you have `Docker <https://docs.docker.com/engine/installation/>`_ and `docker-compose <https://github.com/docker/compose/releases>`_ installed.
|
||||
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ you should now be able to open a postgresql shell:
|
|||
|
||||
Unless you give a superuser access to the database user, you should also
|
||||
enable some extensions on your database server, as those are required
|
||||
for funkwhale to work properly:
|
||||
for Funkwhale to work properly:
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
|
|
|
|||
|
|
@ -96,7 +96,7 @@ Files for the web frontend are purely static and can simply be downloaded, unzip
|
|||
Reverse proxy
|
||||
--------------
|
||||
|
||||
In order to make funkwhale accessible from outside your server and to play nicely with other applications on your machine, you should configure a reverse proxy.
|
||||
In order to make Funkwhale accessible from outside your server and to play nicely with other applications on your machine, you should configure a reverse proxy.
|
||||
|
||||
Nginx
|
||||
^^^^^
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
Systemd configuration
|
||||
----------------------
|
||||
|
||||
Systemd offers a convenient way to manage your funkwhale instance if you're
|
||||
Systemd offers a convenient way to manage your Funkwhale instance if you're
|
||||
not using docker.
|
||||
|
||||
We'll see how to setup systemd to proprely start a funkwhale instance.
|
||||
We'll see how to setup systemd to proprely start a Funkwhale instance.
|
||||
|
||||
First, download the sample unitfiles:
|
||||
|
||||
|
|
@ -17,9 +17,9 @@ First, download the sample unitfiles:
|
|||
|
||||
This will download three unitfiles:
|
||||
|
||||
- ``funkwhale-server.service`` to launch the funkwhale web server
|
||||
- ``funkwhale-worker.service`` to launch the funkwhale task worker
|
||||
- ``funkwhale-beat.service`` to launch the funkwhale task beat (this is for recurring tasks)
|
||||
- ``funkwhale-server.service`` to launch the Funkwhale web server
|
||||
- ``funkwhale-worker.service`` to launch the Funkwhale task worker
|
||||
- ``funkwhale-beat.service`` to launch the Funkwhale task beat (this is for recurring tasks)
|
||||
- ``funkwhale.target`` to easily stop and start all of the services at once
|
||||
|
||||
You can of course review and edit them to suit your deployment scenario
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
Upgrading your funkwhale instance to a newer version
|
||||
Upgrading your Funkwhale instance to a newer version
|
||||
====================================================
|
||||
|
||||
.. note::
|
||||
|
|
@ -7,7 +7,7 @@ Upgrading your funkwhale instance to a newer version
|
|||
the database and the media files.
|
||||
|
||||
We're commited to make upgrade as easy and straightforward as possible,
|
||||
however, funkwhale is still in development and you'll be safer with a backup.
|
||||
however, Funkwhale is still in development and you'll be safer with a backup.
|
||||
|
||||
|
||||
Reading the release notes
|
||||
|
|
|
|||
Loading…
Reference in New Issue