Go to file
heyarne 7daeb46903 Improve Donation Notification 2021-01-21 05:53:18 +01:00
.gitlab Merge branch 'develop' into 'coc' 2019-03-11 15:22:35 +01:00
api Merge branch '1323-fix-faker' into 'develop' 2021-01-12 10:12:04 +01:00
changes Merge branch '1323-fix-faker' into 'develop' 2021-01-12 10:12:04 +01:00
demo Resolve "Remove the unused `federation__music_needs_approval` settings" 2019-12-26 15:54:42 +01:00
deploy Fix #1086: Added safeguard to ensure local uploads are never purged from cache 2020-05-07 13:58:25 +02:00
docker See #170: RSS feeds for channels 2020-01-31 09:11:39 +01:00
docs Podcast search capabilities 2020-12-04 09:33:17 +01:00
front Improve Donation Notification 2021-01-21 05:53:18 +01:00
scripts Added script to check if a given version is the latest 2019-08-19 13:38:28 +02:00
.dockerignore
.editorconfig
.env.dev Add required envvar for dev environment 2019-03-13 10:15:33 +01:00
.gitattributes
.gitignore Load translations separately to reduce bandwidth usage 2018-12-19 21:45:12 +01:00
.gitlab-ci.yml Pinned black version in gitlab.ci 2020-08-26 17:33:14 +02:00
CHANGELOG Added missing contributors for 1.0.1 release 2020-10-31 13:02:38 +01:00
CONTRIBUTING.rst docs(contributing.rst): fix parameter value in example test code 2021-01-09 16:29:41 +01:00
CONTRIBUTORS.txt
LICENSE
README.rst Fix #313: document how to report security issues and vulnerabilities 2020-08-04 11:14:52 +02:00
TRANSLATORS.rst Added some documentation about translations lifecycle 2019-06-10 09:51:30 +02:00
dev.yml Update swagger docs to allow relative URLs 2020-12-03 00:55:02 +01:00
pyproject.toml Unified black conf 2019-03-15 12:11:05 +01:00

README.rst

Funkwhale
=============

.. image:: ./front/src/assets/logo/logo-full-500.png
  :alt: Funkwhale logo
  :target: https://funkwhale.audio

A self-hosted tribute to Grooveshark.com.

LICENSE: AGPL3

Getting help
------------

We offer various Matrix.org rooms to discuss about Funkwhale:

- `#funkwhale:matrix.org <https://matrix.to/#/#funkwhale:matrix.org>`_ for general questions about funkwhale
- `#funkwhale-dev:matrix.org <https://matrix.to/#/#funkwhale-dev:matrix.org>`_ for development-focused discussion

Please join those rooms if you have any questions!

You can also contact `@funkwhale@mastodon.eliotberriot.com <https://mastodon.eliotberriot.com/@funkwhale>`_ on the fediverse.


Contribute
----------

Contribution guidelines as well as development installation instructions
are outlined in `CONTRIBUTING <CONTRIBUTING.rst>`_.

Security issues and vulnerabilities
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you found a vulnerability in Funkwhale, please report it on our Gitlab instance at `https://dev.funkwhale.audio/funkwhale/funkwhale/-/issues`_, ensuring
you have checked the ``This issue is confidential and should only be visible to team members with at least Reporter access.
`` box. 

This will ensure only maintainers and developpers have access to the vulnerability. Thank you for your help!


Translate
^^^^^^^^^

Translators willing to help can refer to `TRANSLATORS <TRANSLATORS.rst>`_ for instructions.

Code of Conduct
---------------

`Our Code of Conduct <https://funkwhale.audio/code-of-conduct/>`_ applies to all the community spaces, including our GitLab instance. Please, take a moment to read it.