2020-12-04 18:00:31 +01:00
# Funkwhale for YunoHost
2018-05-11 23:43:58 +02:00
2020-12-14 22:04:23 +01:00
[](https://dash.yunohost.org/appci/app/funkwhale)  
2021-03-12 22:26:54 +01:00
[](https://install-app.yunohost.org/?app=funkwhale)
*[Lire ce readme en français.](./README_fr.md)*
2019-04-03 14:35:09 +02:00
2020-06-18 15:30:22 +02:00
> *This package allows you to install Funkwhale quickly and simply on a YunoHost server.
2021-04-24 13:05:22 +02:00
If you don't have YunoHost, please consult [the guide ](https://yunohost.org/#/install ) to learn how to install it.*
2019-04-03 14:35:09 +02:00
## Overview
A modern, convivial and free music server on YunoHost
2018-05-12 13:17:09 +02:00
2020-06-18 15:30:22 +02:00
Installation requires a dedicated domain or subdomain. Installing in a subpath is not supported by the upstream project due to dependency requirements.
2018-06-17 15:54:08 +02:00
2021-04-24 13:05:22 +02:00
**Shipped version:** 1.1.1
2018-06-17 15:54:08 +02:00
2019-04-03 14:35:09 +02:00
## Screenshots
2021-04-24 13:05:22 +02:00
2019-04-03 14:35:09 +02:00
2021-03-12 22:26:54 +01:00
## Demo
* [Official demo ](https://demo.funkwhale.audio )
**Username:** demo **Password:** demo
2018-06-17 15:54:08 +02:00
## Admin
2018-10-20 22:27:28 +02:00
The admin uses the login you provided at installation. The password is the same you use for YunoHost.
2020-12-14 22:04:23 +01:00
The admin interface is accessible at the address: `your.domain.fr/api/admin`
2018-06-20 12:49:40 +02:00
2021-04-24 13:05:22 +02:00
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`
```console
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** .
2018-06-20 12:49:40 +02:00
2019-05-14 22:55:26 +02:00
## Documentation
* Official documentation: https://docs.funkwhale.audio
2019-04-03 14:35:09 +02:00
## YunoHost specific features
2020-12-14 22:04:23 +01:00
* Are LDAP and HTTP auth supported? **Yes**
* Can the app be used by multiple users? **Yes**
2019-04-03 14:35:09 +02:00
#### Supported architectures
2021-04-24 13:05:22 +02:00
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/funkwhale/)
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/funkwhale/)
2019-04-03 14:35:09 +02:00
2018-06-17 15:54:08 +02:00
## Links
2021-04-24 13:05:22 +02:00
* Report a bug: https://github.com/YunoHost-Apps/funkwhale_ynh/issues
2019-05-14 22:55:26 +02:00
* App website: https://docs.funkwhale.audio
* Upstream app repository: https://dev.funkwhale.audio/funkwhale/funkwhale
2018-06-20 12:49:40 +02:00
* YunoHost website: https://yunohost.org/
2019-04-03 14:35:09 +02:00
---
2021-04-24 13:05:22 +02:00
## Developer info
2019-04-03 14:35:09 +02:00
2021-04-24 13:05:22 +02:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing ).
2019-04-03 14:35:09 +02:00
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
```
