funkwhale_ynh/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 see here to know how to install and enjoy it.

Overview

A modern, convivial and free music server on YunoHost

Installation requires a dedicated domain or subdomain. Installing in a subpath is not supported by the upstream project due to dependency requirements.

Shipped version: 1.0.1

Screenshots

Demo

• Official demo

Username: demo Password: demo

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

State of this package

• The following have been tested with this package and work fine:

  • install/remove/backup/remove/upgrade with x86_64 and ARM
  • import file with web interface, imports from YouTube, interraction with MusicBrainz
  • Subsonic API
  • Federation tests
  • CLI Import Remember to source $final_path/venv/bin/activate, then source $final_path/load_env before typinh using manage.py.

• to be added:

  • Store files in HOME, see https://github.com/YunoHost-Apps/funkwhale_ynh/issues/15

Documentation

• Official documentation: https://docs.funkwhale.audio

YunoHost specific features

• Are LDAP and HTTP auth supported? Yes
• Can the app be used by multiple users? Yes

Supported architectures

• x86-64 -
• ARMv8-A -

Links

• Report a bug about this package: https://github.com/YunoHost-Apps/funkwhale_ynh
• App website: https://docs.funkwhale.audio
• Upstream app repository: https://dev.funkwhale.audio/funkwhale/funkwhale
• YunoHost website: https://yunohost.org/

---

Developers info

Please do 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