README.rst 1.59 KB
Newer Older
1
2
3
Funkwhale
=============

Agate's avatar
Agate committed
4
5
6
7
.. image:: ./front/src/assets/logo/logo-full-500.png
  :alt: Funkwhale logo
  :target: https://funkwhale.audio

8
9
A self-hosted tribute to Grooveshark.com.

Renon's avatar
Renon committed
10
LICENSE: AGPL3
11

12
13
Getting help
------------
14

Agate's avatar
Agate committed
15
We offer various Matrix.org rooms to discuss about Funkwhale:
16

17
18
- `#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
19
20
21

Please join those rooms if you have any questions!

Agate's avatar
Agate committed
22
23
24
You can also contact `@funkwhale@mastodon.eliotberriot.com <https://mastodon.eliotberriot.com/@funkwhale>`_ on the fediverse.


Agate's avatar
Agate committed
25
26
Contribute
----------
27

Agate's avatar
Agate committed
28
Contribution guidelines as well as development installation instructions
29
are outlined in `CONTRIBUTING <CONTRIBUTING.rst>`_.
30

31
32
33
34
35
36
37
38
39
40
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!


41
42
43
Translate
^^^^^^^^^

44
Translators willing to help can refer to `TRANSLATORS <TRANSLATORS.rst>`_ for instructions.
Agate's avatar
Agate committed
45
46
47
48
49

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.