mirror of
https://github.com/YunoHost-Apps/funkwhale_ynh.git
synced 2024-09-03 18:36:24 +02:00
72 lines
3 KiB
Markdown
72 lines
3 KiB
Markdown
# Funkwhale
|
|
|
|
[](https://dash.yunohost.org/appci/app/funkwhale)
|
|
[](https://install-app.yunohost.org/?app=funkwhale)
|
|
|
|
> *This package allow you to install funkwhale quickly and simply on a YunoHost server.
|
|
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
|
|
|
|
Installation requires a dedicated domain for now. I hope subpath installation will be possible in the future.
|
|
|
|
**Shipped version:** 0.19.0 (this is an Alpha version!)
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Admin
|
|
|
|
The admin uses the login you provided at installation. The password is the same you use for YunoHost.
|
|
|
|
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)
|
|
* [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
|
|
|
|
* end-user configuration required:
|
|
* [x] LDAP integration
|
|
|
|
* to be added:
|
|
* [ ] Store files in HOME, see https://github.com/YunoHost-Apps/funkwhale_ynh/issues/15
|
|
|
|
## YunoHost specific features
|
|
|
|
#### Supported architectures
|
|
|
|
* 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/)
|
|
|
|
## Links
|
|
|
|
* 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/
|
|
* Documentation: https://docs.funkwhale.audio
|
|
* Funkwhale website: https://funkwhale.audio/
|
|
* YunoHost website: https://yunohost.org/
|
|
|
|
---
|
|
|
|
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
|
|
```
|