2018-06-17 15:54:08 +02:00
# Funkwhale
2018-05-11 23:43:58 +02:00
2019-01-23 21:22:15 +01:00
[](https://dash.yunohost.org/appci/app/funkwhale)
2019-05-14 22:55:26 +02:00
[](https://install-app.yunohost.org/?app=funkwhale)
2019-04-03 14:35:09 +02:00
2019-05-14 22:55:26 +02:00
> *This package allow you to install Funkwhale quickly and simply on a YunoHost server.
2019-04-03 14:35:09 +02:00
If you don't have YunoHost, please see [here ](https://yunohost.org/#/install ) to know how to install and enjoy it.*
## Overview
A modern, convivial and free music server on YunoHost
2018-05-12 13:17:09 +02:00
2018-06-17 15:54:08 +02:00
Installation requires a dedicated domain for now. I hope subpath installation will be possible in the future.
2019-04-03 23:11:25 +02:00
**Shipped version:** 0.18.3 (this is an Alpha version!)
2018-06-17 15:54:08 +02:00
2019-04-03 14:35:09 +02:00
## Screenshots
2019-05-14 22:55:26 +02:00
2019-04-03 14:35:09 +02:00
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.
2018-06-17 15:54:08 +02:00
2018-06-20 12:49:40 +02:00
The admin interface is accessible with the address: your.domain.fr/api/admin
# State of this package
* works fine:
* [x] install/remove/backup/remove/upgrade with x86_64
* [x] import file with web interface, imports from youtube, interraction with MusicBrainz
* [x] [Subsonic API ](https://docs.funkwhale.audio/users/apps.html )
2018-06-23 23:15:04 +02:00
* [x] [Federation ](https://docs.funkwhale.audio/federation.html ) tests
* [x] [CLI Import ](https://docs.funkwhale.audio/importing-music.html#from-music-directory-on-the-server ) Remember to `source $final_path/venv/bin/activate` , then `source $final_path/load_env` before typinh using manage.py.
* [x] ARM support
2018-06-20 12:49:40 +02:00
2018-10-20 21:54:59 +02:00
* end-user configuration required:
* [x] LDAP integration
2018-06-20 12:49:40 +02:00
* to be added:
2018-06-23 23:15:04 +02:00
* [ ] Store files in HOME, see https://github.com/YunoHost-Apps/funkwhale_ynh/issues/15
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
#### Supported architectures
2019-05-14 22:55:26 +02:00
* x86-64b - [](https://ci-apps.yunohost.org/ci/apps/funkwhale/)
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/funkwhale/)
* Jessie x86-64b - [](https://ci-stretch.nohost.me/ci/apps/funkwhale/)
2019-04-03 14:35:09 +02:00
2018-06-17 15:54:08 +02:00
## Links
2018-06-20 12:49:40 +02:00
* Report a bug about this package: https://github.com/YunoHost-Apps/funkwhale_ynh
* Report a bug about Funkwhale itself: https://code.eliotberriot.com/funkwhale/funkwhale/
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
---
Developers info
----------------
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
Please do your pull request to the [testing branch ](https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing ).
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
```
