Go to file
hellekin a7a8a9b13f Improve Docker installation documentation
- Use `useradd` features to simplify user creation:
  - `-U` creates a user group,
  - `-G docker` adds the user to the `docker` group
- Document available versions and their usage
- Use `chmod 0600` before editing the file!
- Use `cat` instead of multiple `echo`es
- Comment all lines in `.env`
- Use `${FUNKWHALE_VERSION}` where applicable instead of `|version|` to
enable copy-pasting more commands
2019-07-09 12:44:02 +02:00
.gitlab Merge branch 'develop' into 'coc' 2019-03-11 15:22:35 +01:00
api Implement tag models 2019-07-08 15:26:14 +02:00
changes Merge branch 'master' into develop 2019-07-05 16:04:39 +02:00
demo
deploy Fix #862: replaced Daphne by Gunicorn/Uvicorn 2019-06-19 10:26:09 +02:00
docker Fixed some issues 2019-04-24 12:56:15 +02:00
docs Improve Docker installation documentation 2019-07-09 12:44:02 +02:00
front Fixed typo in source translation 2019-07-08 09:21:54 +02:00
scripts Add reviewers to the list of contributors 2019-06-28 10:24:31 +02:00
.dockerignore
.editorconfig
.env.dev Add required envvar for dev environment 2019-03-13 10:15:33 +01:00
.gitattributes
.gitignore
.gitlab-ci.yml Fixed broken CI build 2019-06-24 14:04:53 +02:00
CHANGELOG Fixed release date in changelog 2019-06-28 10:59:35 +02:00
CONTRIBUTING.rst Merge branch 'master' into develop 2019-03-21 10:46:28 +01:00
CONTRIBUTORS.txt
LICENSE
README.rst Merge branch 'develop' into 'coc' 2019-03-11 15:22:35 +01:00
TRANSLATORS.rst Added some documentation about translations lifecycle 2019-06-06 13:53:05 +02:00
dev.yml MRF / Dropping of incoming/outgoing messages based on allow-list 2019-06-20 10:27:07 +02: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>`_.

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.