funkwhale/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.
Initial commit that merge both the front end and the API in the same repository 2017-06-23 21:00:42 +00:00			`Funkwhale`
			`=============`

Readme tweaks / logo 2018-05-05 17:16:10 +00:00			`.. image:: ./front/src/assets/logo/logo-full-500.png`
			`:alt: Funkwhale logo`
			`:target: https://funkwhale.audio`

Initial commit that merge both the front end and the API in the same repository 2017-06-23 21:00:42 +00:00			`A self-hosted tribute to Grooveshark.com.`

fix license on README 2018-06-12 07:58:48 +00:00			`LICENSE: AGPL3`
Initial commit that merge both the front end and the API in the same repository 2017-06-23 21:00:42 +00:00
Fixed #123: up-to-date and complete development and contribution instructions in README.rst 2018-03-16 19:10:27 +00:00			`Getting help`
			`------------`
Initial commit that merge both the front end and the API in the same repository 2017-06-23 21:00:42 +00:00
Readme tweaks / logo 2018-05-05 17:16:10 +00:00			`We offer various Matrix.org rooms to discuss about Funkwhale:`
Initial commit that merge both the front end and the API in the same repository 2017-06-23 21:00:42 +00:00
Replace riot.im links with matrix.to links 2018-06-30 10:13:58 +00:00			- `#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
Fixed #123: up-to-date and complete development and contribution instructions in README.rst 2018-03-16 19:10:27 +00:00
			`Please join those rooms if you have any questions!`

Readme tweaks / logo 2018-05-05 17:16:10 +00:00			You can also contact `@funkwhale@mastodon.eliotberriot.com <https://mastodon.eliotberriot.com/@funkwhale>`_ on the fediverse.


Added contribution documentation 2018-04-28 16:39:58 +00:00			`Contribute`
			`----------`
Fixed #123: up-to-date and complete development and contribution instructions in README.rst 2018-03-16 19:10:27 +00:00
Added contribution documentation 2018-04-28 16:39:58 +00:00			`Contribution guidelines as well as development installation instructions`
Rename CONTRIBUTING to CONTRIBUTING.rst for Gitlab formatting preview. Rename occurences of the file through the documentation. Signed-off-by: Thomas Citharel <tcit@tcit.fr> 2018-07-29 08:11:20 +00:00			are outlined in `CONTRIBUTING <CONTRIBUTING.rst>`_.
See #161: added initial translating guidelines 2018-06-30 10:39:21 +00:00
Fix #313: document how to report security issues and vulnerabilities 2020-08-04 09:14:52 +00:00			`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!`


See #161: added initial translating guidelines 2018-06-30 10:39:21 +00:00			`Translate`
			`^^^^^^^^^`

Rename TRANSLATORS to TRANSLATORS.rst for Gitlab formatting preview 2019-03-07 18:32:07 +00:00			Translators willing to help can refer to `TRANSLATORS <TRANSLATORS.rst>`_ for instructions.
Merge branch 'develop' into 'coc' # Conflicts: # README.rst 2019-03-11 14:22:35 +00:00
			`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.