YunoHost-Apps/funkwhale_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/funkwhale_ynh.git synced 2024-09-03 18:36:24 +02:00
Code Issues Activity Actions 1
funkwhale_ynh/README.md

65 lines
3.1 KiB
Markdown
Raw Normal View History

Auto-update README
2021-10-23 16:53:03 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
Update README.md
2020-06-10 08:57:49 +02:00
# Funkwhale for YunoHost
Improve readme
2018-05-11 23:43:58 +02:00
Auto-update README
2022-07-13 17:29:01 +02:00
[![Integration level](https://dash.yunohost.org/integration/funkwhale.svg)](https://dash.yunohost.org/appci/app/funkwhale) ![Working status](https://ci-apps.yunohost.org/ci/badges/funkwhale.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/funkwhale.maintain.svg)
Update README.md Co-authored-by: Éric Gaspar <46165813+ericgaspar@users.noreply.github.com>
2020-12-19 19:53:20 +01:00
[![Install Funkwhale with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=funkwhale)
Apply example_ynh
2019-04-03 14:35:09 +02:00
Readme update
2020-12-14 21:41:20 +01:00
*[Lire ce readme en français.](./README_fr.md)*
Auto-update README
2021-10-23 16:53:03 +02:00
> *This package allows you to install Funkwhale quickly and simply on a YunoHost server.
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>
2021-04-16 14:14:27 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
Apply example_ynh
2019-04-03 14:35:09 +02:00
## Overview
Add redis caching
2018-05-12 13:17:09 +02:00
Auto-update README
2021-11-23 07:46:19 +01:00
Funkwhale is a community-driven project that lets you listen and share music and audio within a decentralized, open network.
Remove path from manifest and improve readme
2018-06-17 15:54:08 +02:00
Auto-update README
2022-10-04 01:43:33 +02:00
**Shipped version:** 1.2.8~ynh2 *(:warning: This is the `upgrade` branch. The [`master` branch](https://github.com/YunoHost-Apps/funkwhale_ynh/tree/master) used in the catalog is currently on version 1.2.8\~ynh1.)*
Remove path from manifest and improve readme
2018-06-17 15:54:08 +02:00
Auto-update README
2022-09-14 11:10:20 +02:00
Auto-update README
2021-10-23 16:53:03 +02:00
**Demo:** https://demo.funkwhale.audio
Auto-update README
2022-07-14 14:03:39 +02:00
## Screenshots
![Screenshot of Funkwhale](./doc/screenshots/screenshot1.png)
Auto-update README
2021-10-23 16:53:03 +02:00
## Disclaimers / important information
Readme update
2020-12-14 21:41:20 +01:00
Auto-update README
2022-07-14 14:08:13 +02:00
* Installation requires a dedicated domain or subdomain. Installing in a subpath is not supported by the upstream project due to dependency requirements.
Readme update
2020-12-14 21:41:20 +01:00
Auto-update README
2021-10-23 16:53:03 +02:00
* Admin
Auto-update README
2022-10-04 00:34:36 +02:00
* 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`
Improve current package status https://github.com/YunoHost-Apps/funkwhale_ynh/issues/16
2018-06-20 12:49:40 +02:00
Fix import link
2021-04-21 23:35:59 +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`
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
```console
Fix import link
2021-04-21 23:35:59 +02:00
foo@bar:~$sudo ln -s /your/music/collection /home/yunohost.app/funkwhale/data/music
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
```
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**.
Auto-update README
2021-10-23 16:53:03 +02:00
## Documentation and resources
Update to 1.0.1 (#119) * Update to 1.0.1
2020-12-04 18:09:35 +01:00
Auto-update README
2022-07-13 17:29:01 +02:00
* Official app website: <https://funkwhale.audio/>
* Official user documentation: <https://docs.funkwhale.audio/users/index.html>
* Official admin documentation: <https://docs.funkwhale.audio/admin/index.html>
* Upstream app code repository: <https://dev.funkwhale.audio/funkwhale/funkwhale>
* YunoHost documentation for this app: <https://yunohost.org/app_funkwhale>
* Report a bug: <https://github.com/YunoHost-Apps/funkwhale_ynh/issues>
Apply example_ynh
2019-04-03 14:35:09 +02:00
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>
2021-04-16 14:14:27 +02:00
## Developer info
Apply example_ynh
2019-04-03 14:35:09 +02:00
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>
2021-04-16 14:14:27 +02:00
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing).
Apply example_ynh
2019-04-03 14:35:09 +02:00
To try the testing branch, please proceed like that.
Auto-update README
2022-07-13 17:29:01 +02:00
``` bash
Apply example_ynh
2019-04-03 14:35:09 +02:00
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
```
Auto-update README
2021-10-23 16:53:03 +02:00
Auto-update README
2022-07-13 17:29:01 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Reference in a new issue Copy permalink