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

yunohost-bot 60b69c77b9 Auto-update README		2022-10-04 18:33:58 +00:00
.github	Create autoupdater	2022-10-04 01:43:27 +02:00
conf	Create autoupdater	2022-10-04 01:43:27 +02:00
doc	Typo	2022-10-04 00:34:30 +02:00
scripts	Fix #151	2022-10-04 00:14:58 +02:00
check_process	Apply example_ynh	2022-10-04 00:13:33 +02:00
LICENSE	Initial commit	2018-04-15 20:36:02 +02:00
manifest.json	Create autoupdater	2022-10-04 01:43:27 +02:00
README.md	Auto-update README	2022-10-04 18:33:58 +00:00
README_fr.md	Auto-update README	2022-10-04 18:33:58 +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

Funkwhale is a community-driven project that lets you listen and share music and audio within a decentralized, open network.

Shipped version: 1.2.8~ynh2 (⚠️ This is the testing branch. The master branch used in the catalog is currently on version 1.2.8~ynh1.)

Demo: https://demo.funkwhale.audio

Screenshots

Disclaimers / important information

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/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