mirror of https://github.com/YunoHost-Apps/funkwhale_ynh.git synced 2024-09-03 18:36:24 +02:00

A modern, convivial and free music server on YunoHost

Find a file

Alexandre Aubin f760d2da62 Merge pull request #153 from pierluigi/master Fix datadir issue		2021-11-21 19:30:27 +01:00
.github	[autopatch] Update issue and PR templates	2021-05-13 17:47:01 +02:00
conf	Update api.src	2021-09-25 16:31:46 +02:00
doc	Fix disclaimer/description encoding making autoreadme crash	2021-10-23 16:52:46 +02:00
scripts	No need to redeclare datadir	2021-08-21 06:28:31 +00:00
check_process	Apply last example_ynh	2021-08-04 23:53:34 +02:00
LICENSE	Initial commit	2018-04-15 20:36:02 +02:00
manifest.json	Apply last example_ynh	2021-08-04 23:53:34 +02:00
README.md	Auto-update README	2021-10-23 14:53:03 +00:00
README_fr.md	Auto-update README	2021-10-23 14:53:03 +00:00

README.md

Funkwhale for YunoHost

Lire ce readme en français.

This package allows you to install Funkwhale quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Modern, convivial and free music server

Shipped version: 1.1.4~ynh1

Demo: https://demo.funkwhale.audio

Screenshots

Disclaimers / important information

Any known limitations, constrains or stuff not working, such as (but not limited to):
- Installation requires a dedicated domain or subdomain. Installing in a subpath is not supported by the upstream project due to dependency requirements.
Admin

The admin uses the login you provided at installation. The password is the same you use for YunoHost. The admin interface is accessible at the address: your.domain.fr/api/admin

To add a collection of music files to a library in your YunoHost installation of Funkwhale, create a symlink to your collection titled "music" in /home/yunohost.app/funkwhale/data

foo@bar:~$sudo ln -s /your/music/collection /home/yunohost.app/funkwhale/data/music

The files can then be added to your library from the uploading tab in a music library under the heading Import music from your server.

Documentation and resources

Official app website: https://funkwhale.audio/
Official user documentation: https://docs.funkwhale.audio/users/index.html
Official admin documentation: https://docs.funkwhale.audio/admin/index.html
Upstream app code repository: https://dev.funkwhale.audio/funkwhale
YunoHost documentation for this app: https://yunohost.org/app_funkwhale
Report a bug: https://github.com/YunoHost-Apps/funkwhale_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug
or
sudo yunohost app upgrade funkwhale -u https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps