funkwhale_ynh/README.md

<!--
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.
-->

# Funkwhale for YunoHost

[![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)

[![Install Funkwhale with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=funkwhale)

*[Read this README in other languages.](./ALL_README.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

Funkwhale is a community-driven project that lets you listen and share music and audio within a decentralized, open network. 

**Shipped version:** 1.4.0~ynh1

**Demo:** <https://demo.funkwhale.audio>

## Screenshots

![Screenshot of Funkwhale](./doc/screenshots/screenshot1.png)

## Documentation and resources

- 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 Store: <https://apps.yunohost.org/app/funkwhale>
- Report a bug: <https://github.com/YunoHost-Apps/funkwhale_ynh/issues>

## 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:

```bash
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
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Auto-update README 2021-10-23 16:53:03 +02:00			`<!--`
Auto-update README 2024-03-29 07:03:48 +01:00			`N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>`
Auto-update README 2021-10-23 16:53:03 +02:00			`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 2023-01-25 03:40:23 +01: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)`
Auto-update README 2023-02-23 23:39:19 +01:00
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
Auto-update READMEs 2024-04-01 06:01:26 +02:00			`[Read this README in other languages.](./ALL_README.md)`
Readme update 2020-12-14 21:41:20 +01:00
Auto-update README 2024-03-29 07:03:48 +01:00			`> 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.`
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 2023-12-13 14:03:05 +01:00			`Shipped version: 1.4.0~ynh1`
Auto-update README 2022-09-14 11:10:20 +02:00
Auto-update README 2024-03-29 07:03:48 +01: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			`## 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 2024-03-29 07:03:48 +01: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 Store: <https://apps.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
Auto-update README 2024-03-29 07:03:48 +01: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
Auto-update README 2024-03-29 07:03:48 +01:00			To try the `testing` branch, please proceed like that:
Auto-update README 2022-07-13 17:29:01 +02:00
Auto-update README 2024-03-29 07:03:48 +01: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>`