Go to file
Ciaran Ainsworth e1e6409774 Move things around, start documenting internal users 2022-01-22 13:23:58 +00:00
.gitlab Enable Renovate dependency dashboard 2022-01-20 20:20:04 +01:00
api Fix syntax error 2022-01-19 15:16:03 +01:00
changes
demo
deploy
docker
docs Move things around, start documenting internal users 2022-01-22 13:23:58 +00:00
front Remove npm's package lock file, yarn is the default 2022-01-19 10:33:13 +01:00
scripts
.dockerignore
.editorconfig
.env.dev
.gitattributes
.gitignore
.gitlab-ci.yml Overhaul end user documentation 2022-01-19 18:49:46 +00:00
CHANGELOG
CONTRIBUTING.rst
LICENSE
README.rst
TRANSLATORS.rst
dev.yml
pyproject.toml

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

There are several places to get help or get in touch with other members of the community: https://funkwhale.audio/community/

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.