mirror of
https://github.com/YunoHost-Apps/funkwhale_ynh.git
synced 2024-09-03 18:36:24 +02:00
fa9587f61e
* Update README.md * Test bump to 1.0 * Bump to Yunohost 4 (for Debian upgrade) * Test removal of nonexistent scripts * Correct Typo * Update README.md * Fix linter warnings * Fix linter * Fix linter warnings * Cleaning up * Update README.md * Update to 1.0.1 (#119) * Update to 1.0.1 * Set new permissions * Add French Readme * Readme update * Update README.md * Update README.md * Update README_fr.md * Update README.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Update README_fr.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Update README.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Update README_fr.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Finding an available port * Uprade to 1.1 and fixes Twisted by retrograding it (#129) * Fix linter warning : no need to use $is_public * 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> * Apply Example_ynh (#131) * Testing (#130) * Uprade to 1.1 and fixes Twisted by retrograding it (#129) * Apply example_ynh Fix #15 * Fix services * Fix several merging * Stick to official install process * fix path_transversal * Using option '--log_type systemd' with 'yunohost service add' is not relevant anymore * Try to fix package_check * Fix package_check test * Update check_process * Trying to fix package_check * Update env.prod * remove sleep * Better service name * missing datadir * line 111: upgrade_type: unbound variable * Implement --is_big * Fix stopping service from previous version * Fix upgrade * Fix upgrade * Apply example_ynh * Apply example_ynh * Fix rights * Update api.src * Update env.prod * Update front.src * Update manifest.json * Update README.md * Update README_fr.md * Fix chmod * Fix rights Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> * Update conf/nginx.conf Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> * Update conf/nginx.conf Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> * fix * Fix rights for datadir from previous version * Update upgrade * Fix recursive chmod * Fix import link * Update README_fr.md Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com> Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org> Co-authored-by: Ciarán Ainsworth <cda@rootkey.co.uk> Co-authored-by: Ciarán Ainsworth <ciaranainsworth@posteo.net> Co-authored-by: ericgaspar <junk.eg@free.fr> Co-authored-by: Thomas <51749973+Thovi98@users.noreply.github.com> Co-authored-by: Amos Blanton <lightnin@users.noreply.github.com>
71 lines
2.9 KiB
Markdown
71 lines
2.9 KiB
Markdown
# Funkwhale for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/funkwhale)  
|
|
[](https://install-app.yunohost.org/?app=funkwhale)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Funkwhale quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install 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.1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Demo
|
|
|
|
* [Official demo](https://demo.funkwhale.audio)
|
|
|
|
**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 "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**.
|
|
|
|
## 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 - [](https://ci-apps.yunohost.org/ci/apps/funkwhale/)
|
|
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/funkwhale/)
|
|
|
|
## Links
|
|
|
|
* Report a bug: https://github.com/YunoHost-Apps/funkwhale_ynh/issues
|
|
* App website: https://docs.funkwhale.audio
|
|
* Upstream app repository: https://dev.funkwhale.audio/funkwhale/funkwhale
|
|
* YunoHost website: https://yunohost.org/
|
|
|
|
---
|
|
|
|
## Developer info
|
|
|
|
Please send 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
|
|
```
|