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

Clarify custom paths needed to import collections of music files in Readme. (#134 )

* Update readme to indicate custom import path 

Yunohost installations of Funkwhale use a different path for file imports than those indicated in the Funkwhale documentation.. (/var/www/Funkwhale/import). We should therefore indicate to the admin user what that path is, and steps necessary to use it.   Addresses #132.

* Fix bash highlighting.

* Update README.md

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>

2021-04-15 14:30:36 +02:00

3.5 KiB

Raw Blame History

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

To add a collection of music files to a library in your YunoHost installation of Funkwhale, create a symlink to your collection titled "import" in /var/www/funkwhale

foo@bar:~$sudo ln -s /your/music/collection /var/www/funkwhale/import

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.

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 -

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

3.5 KiB Raw Blame History