CONTRIBUTING.md

+# Contribute to Funkwhale
+
+We welcome contributions from across the community. Whether you are a designer, a translator, a technical writer, or a developer, we look forward to working with you to improve the Funkwhale project!
+
+## Contribute to Funkwhale development
+
+The Funkwhale software is the core of the community project. While we have a core team working on it, we are always excited to see new features, bugfixes, and refactorings from our community.
+
+Funkwhale's backend is written in [Python](https://www.python.org/) using [Django](https://www.djangoproject.com) and [Django REST framework](https://www.django-rest-framework.org/). Our web app is written in [Vue.js](https://vuejs.org/) and [Typescript](https://typescriptlang.org).
+
+Whether you're an experienced developer or you're just learning, check out our [developer guide](https://docs.funkwhale.audio/developer/index.html) to get started.
+
+## Document Funkwhale
+
+Funkwhale is a large project with a lot of moving parts. To help users and developers alike, we need to keep our documentation up-to-date and readable. If you have a knack for explaining technical concepts or you've noticed a gap, check out our [documentation guide](https://docs.funkwhale.audio/documentation/index.html) to see how to get involved.
+
+## Translate Funkwhale
+
+All Funkwhale content is written in American English, but our community speaks languages from all over the world. If you'd like to see Funkwhale in your language, check out the [translation guide](https://docs.funkwhale.audio/translators.html) to see how you can help out.
+
+## Other contributions
+
+We'll update this file and our documentation with more information and workflows as we expand our search for contributors. If you have some suggestions or want to see how else you can get involved, come join us on [our forum](https://forum.funkwhale.audio). We'd love to hear your ideas!

CONTRIBUTING.rst

-Contribute to Funkwhale development
-===================================
-
-First of all, thank you for your interest in the project! We really
-appreciate the fact that you're about to take some time to read this
-and hack on the project.
-
-This document will guide you through common operations such as:
-
-- Setup your development environment
-- Working on your first issue
-- Writing unit tests to validate your work
-- Submit your work
-
-A quick path to contribute on the front-end
--------------------------------------------
-
-The next sections of this document include a full installation guide to help
-you setup a local, development version of Funkwhale. If you only want to fix small things
-on the front-end, and don't want to manage a full development environment, there is anoter way.
-
-As the front-end can work with any Funkwhale server, you can work with the front-end only,
-and make it talk with an existing instance (like the demo one, or you own instance, if you have one).
-
-If even that is too much for you, you can also make your changes without any development environment,
-and open a merge request. We will be able to review your work easily by spawning automatically a
-live version of your changes, thanks to Gitlab Review apps.
-
-Setup front-end only development environment
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-1. Clone the repository::
-
-    git clone ssh://git@dev.funkwhale.audio/funkwhale/funkwhale.git
-    cd funkwhale
-    cd front
-
-2. Install `nodejs <https://nodejs.org/en/download/package-manager/>`_ and `yarn <https://yarnpkg.com/lang/en/docs/install/#debian-stable>`_
-
-3. Install the dependencies::
-
-    yarn install
-
-4. Launch the development server::
-
-    # this will serve the front-end on http://localhost:8000
-    VUE_PORT=8000 yarn serve
-
-5. Make the front-end talk with an existing server (like https://demo.funkwhale.audio),
-   by clicking on the corresponding link in the footer
-
-6. Start hacking!
-
-Setup your development environment
-----------------------------------
-
-If you want to fix a bug or implement a feature, you'll need
-to run a local, development copy of funkwhale.
-
-We provide a docker based development environment, which should
-be both easy to setup and work similarly regardless of your
-development machine setup.
-
-Instructions for bare-metal setup will come in the future (Merge requests
-are welcome).
-
-Installing docker and docker-compose
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This is already cover in the relevant documentations:
-
-- https://docs.docker.com/install/
-- https://docs.docker.com/compose/install/
-
-Cloning the project
-^^^^^^^^^^^^^^^^^^^
-
-Visit https://dev.funkwhale.audio/funkwhale/funkwhale and clone the repository using SSH or HTTPS. Exemple using SSH::
-
-    git clone ssh://git@dev.funkwhale.audio:2222/funkwhale/funkwhale.git
-    cd funkwhale
-
-
-A note about branches
-^^^^^^^^^^^^^^^^^^^^^
-
-Next release development occurs on the "develop" branch, and releases are made on the "master" branch. Therefore, when submitting Merge Requests, ensure you are merging on the develop branch.
-
-
-Working with docker
-^^^^^^^^^^^^^^^^^^^
-
-In developpement, we use the docker-compose file named ``dev.yml``, and this is why all our docker-compose commands will look like this::
-
-    docker-compose -f dev.yml logs
-
-If you do not want to add the ``-f dev.yml`` snippet everytime, you can run this command before starting your work::
-
-    export COMPOSE_FILE=dev.yml
-
-
-Creating your env file
-^^^^^^^^^^^^^^^^^^^^^^
-
-We provide a working .env.dev configuration file that is suitable for
-development. However, to enable customization on your machine, you should
-also create a .env file that will hold your personal environment
-variables (those will not be commited to the project).
-
-Create it like this::
-
-    touch .env
-
-
-Create docker network
-^^^^^^^^^^^^^^^^^^^^^
-
-Create the federation network::
-
-    docker network create federation
-
-
-Building the containers
-^^^^^^^^^^^^^^^^^^^^^^^
-
-On your initial clone, or if there have been some changes in the
-app dependencies, you will have to rebuild your containers. This is done
-via the following command::
-
-    docker-compose -f dev.yml build
-
-
-Database management
-^^^^^^^^^^^^^^^^^^^
-
-To setup funkwhale's database schema, run this::
-
-    docker-compose -f dev.yml run --rm api python manage.py migrate
-
-This will create all the tables needed for the API to run proprely.
-You will also need to run this whenever changes are made on the database
-schema.
-
-It is safe to run this command multiple times, so you can run it whenever
-you fetch develop.
-
-
-Development data
-^^^^^^^^^^^^^^^^
-
-You'll need at least an admin user and some artists/tracks/albums to work
-locally.
-
-Create an admin user with the following command::
-
-    docker-compose -f dev.yml run --rm api python manage.py createsuperuser
-
-Injecting fake data is done by running the fllowing script::
-
-    artists=25
-    command="from funkwhale_api.music import fake_data; fake_data.create_data($artists)"
-    echo $command | docker-compose -f dev.yml run --rm api python manage.py shell -i python
-
-The previous command will create 25 artists with random albums, tracks
-and metadata.
-
-
-Launch all services
-^^^^^^^^^^^^^^^^^^^
-
-Then you can run everything with::
-
-    docker-compose -f dev.yml up front api nginx celeryworker
-
-This will launch all services, and output the logs in your current terminal window.
-If you prefer to launch them in the background instead, use the ``-d`` flag, and access the logs when you need it via ``docker-compose -f dev.yml logs --tail=50 --follow``.
-
-Once everything is up, you can access the various funkwhale's components:
-
-- The Vue webapp, on http://localhost:8080
-- The API, on http://localhost:8080/api/v1/
-- The django admin, on http://localhost:8080/api/admin/
-
-Stopping everything
-^^^^^^^^^^^^^^^^^^^
-
-Once you're down with your work, you can stop running containers, if any, with::
-
-    docker-compose -f dev.yml stop
-
-
-Removing everything
-^^^^^^^^^^^^^^^^^^^
-
-If you want to wipe your development environment completely (e.g. if you want to start over from scratch), just run::
-
-    docker-compose -f dev.yml down -v
-
-This will wipe your containers and data, so please be careful before running it.
-
-You can keep your data by removing the ``-v`` flag.
-
-
-Working with federation locally
--------------------------------
-
-This is not needed unless you need to work on federation-related features.
-
-To achieve that, you'll need:
-
-1. to update your dns resolver to resolve all your .dev hostnames locally
-2. a reverse proxy (such as traefik) to catch those .dev requests and
-   and with https certificate
-3. two instances (or more) running locally, following the regular dev setup
-
-Resolve .dev names locally
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-If you use dnsmasq, this is as simple as doing::
-
-    echo "address=/test/172.17.0.1" | sudo tee /etc/dnsmasq.d/test.conf
-    sudo systemctl restart dnsmasq
-
-If you use NetworkManager with dnsmasq integration, use this instead::
-
-    echo "address=/test/172.17.0.1" | sudo tee /etc/NetworkManager/dnsmasq.d/test.conf
-    sudo systemctl restart NetworkManager
-
-Add wildcard certificate to the trusted certificates
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Simply copy bundled certificates::
-
-    sudo cp docker/ssl/test.crt /usr/local/share/ca-certificates/
-    sudo update-ca-certificates
-
-This certificate is a wildcard for ``*.funkwhale.test``
-
-Run a reverse proxy for your instances
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-
-Launch everything
-^^^^^^^^^^^^^^^^^
-
-Launch the traefik proxy::
-
-    docker-compose -f docker/traefik.yml up -d
-
-Then, in separate terminals, you can setup as many different instances as you
-need::
-
-    export COMPOSE_PROJECT_NAME=node2
-    export VUE_PORT=1234  # this has to be unique for each instance
-    docker-compose -f dev.yml run --rm api python manage.py migrate
-    docker-compose -f dev.yml run --rm api python manage.py createsuperuser
-    docker-compose -f dev.yml up nginx api front nginx api celeryworker
-
-Note that by default, if you don't export the COMPOSE_PROJECT_NAME,
-we will default to node1 as the name of your instance.
-
-Assuming your project name is ``node1``, your server will be reachable
-at ``https://node1.funkwhale.test/``. Not that you'll have to trust
-the SSL Certificate as it's self signed.
-
-When working on federation with traefik, ensure you have this in your ``env``::
-
-    # This will ensure we don't bind any port on the host, and thus enable
-    # multiple instances of funkwhale to be spawned concurrently.
-    VUE_PORT_BINDING=
-    # This disable certificate verification
-    EXTERNAL_REQUESTS_VERIFY_SSL=false
-    # this ensure you don't have incorrect urls pointing to http resources
-    FUNKWHALE_PROTOCOL=https
-
-
-Typical workflow for a contribution
------------------------------------
-
-0. Fork the project if you did not already or if you do not have access to the main repository
-1. Checkout the development branch and pull most recent changes: ``git checkout develop && git pull``
-2. If working on an issue, assign yourself to the issue. Otherwise, consider open an issue before starting to work on something, especially for new features.
-3. Create a dedicated branch for your work ``42-awesome-fix``. It is good practice to prefix your branch name with the ID of the issue you are solving.
-4. Work on your stuff
-5. Commit small, atomic changes to make it easier to review your contribution
-6. Add a changelog fragment to summarize your changes: ``echo "Implemented awesome stuff (#42)" > changes/changelog.d/42.feature``
-7. Push your branch
-8. Create your merge request
-9. Take a step back and enjoy, we're really grateful you did all of this and took the time to contribute!
-
-Changelog management
---------------------
-
-To ensure we have extensive and well-structured changelog, any significant
-work such as closing an issue must include a changelog fragment. Small changes
-may include a changelog fragment as well but this is not mandatory. If you're not
-sure about what to do, do not panic, open your merge request normally and we'll
-figure everything during the review ;)
-
-Changelog fragments are text files that can contain one or multiple lines
-that describe the changes occuring in a bunch of commits. Those files reside
-in ``changes/changelog.d``.
-
-Content
-^^^^^^^
-
-A typical fragment looks like that:
-
-    Fixed broken audio player on Chrome 42 for ogg files (#567)
-
-If the work fixes one or more issues, the issue number should be included at the
-end of the fragment (``(#567)`` is the issue number in the previous example).
-
-If your work is not related to a specific issue, use the merge request
-identifier instead, like this:
-
-    Fixed a typo in landing page copy (!342)
-
-Naming
-^^^^^^
-
-Fragment files should respect the following naming pattern: ``changes/changelog.d/<name>.<category>``.
-Name can be anything describing your work, or simply the identifier of the issue number you are fixing.
-Category can be one of:
-
-- ``feature``: for new features
-- ``enhancement``: for enhancements on existing features
-- ``bugfix``: for bugfixes
-- ``doc``: for documentation
-- ``i18n``: for internationalization-related work
-- ``misc``: for anything else
-
-Shortcuts
-^^^^^^^^^
-
-Here is a shortcut you can use/adapt to easily create new fragments from command-line:
-
-.. code-block:: bash
-
-    issue="42"
-    content="Fixed an overflowing issue on small resolutions (#$issue)"
-    category="bugfix"
-    echo $content > changes/changelog.d/$issue.$category
-
-You can of course create fragments by hand in your text editor, or from Gitlab's
-interface as well.
-
-Internationalization
---------------------
-
-We're using https://github.com/Polyconseil/vue-gettext to manage i18n in the project.
-When working on the front-end, any end-user string should be translated
-using either ``<translate>yourstring</translate>`` or ``$gettext('yourstring')``
-function.
-
-Extraction is done by calling ``yarn run i18n-extract``, which
-will pull all the strings from source files and put them in a PO file.
-
-Contributing to the API
------------------------
-
-Project structure
-^^^^^^^^^^^^^^^^^
-
-.. code-block:: shell
-
-    tree api -L 2 -d
-    api
-    ├── config          # configuration directory (settings, urls, wsgi server)
-    │   └── settings    # Django settings files
-    ├── funkwhale_api   # project directory, all funkwhale logic is here
-    ├── requirements    # python requirements files
-    └── tests           # test files, matches the structure of the funkwhale_api directory
-
-.. note::
-
-    Unless trivial, API contributions must include unittests to ensure
-    your fix or feature is working as expected and won't break in the future
-
-Running tests
-^^^^^^^^^^^^^
-
-To run the pytest test suite, use the following command::
-
-    docker-compose -f dev.yml run --rm api pytest
-
-This is regular pytest, so you can use any arguments/options that pytest usually accept::
-
-    # get some help
-    docker-compose -f dev.yml run --rm api pytest -h
-    # Stop on first failure
-    docker-compose -f dev.yml run --rm api pytest -x
-    # Run a specific test file
-    docker-compose -f dev.yml run --rm api pytest tests/test_acoustid.py
-
-Writing tests
-^^^^^^^^^^^^^
-
-Although teaching you how to write unit tests is outside of the scope of this
-document, you'll find below a collection of tips, snippets and resources
-you can use if you want to learn on that subject.
-
-Useful links:
-
-- `A quick introduction to unit test writing with pytest <https://semaphoreci.com/community/tutorials/testing-python-applications-with-pytest>`_
-- `A complete guide to Test-Driven Development (although not using Pytest) <https://www.obeythetestinggoat.com/>`_
-- `pytest <https://docs.pytest.org/en/latest/>`_: documentation of our testing engine and runner
-- `pytest-mock <https://pypi.org/project/pytest-mock/>`_: project page of our mocking engine
-- `factory-boy <http://factoryboy.readthedocs.io/>`_: documentation of factory-boy, which we use to easily generate fake objects and data
-
-Recommendations:
-
-- Test files must target a module and mimic ``funkwhale_api`` directory structure: if you're writing tests for ``funkwhale_api/myapp/views.py``, you should put thoses tests in ``tests/myapp/test_views.py``
-- Tests should be small and test one thing. If you need to test multiple things, write multiple tests.
-
-We provide a lot of utils and fixtures to make the process of writing tests as
-painless as possible. You'll find some usage examples below.
-
-Use factories to create arbitrary objects:
-
-.. code-block:: python
-
-    # funkwhale_api/myapp/users.py
-
-    def downgrade_user(user):
-        """
-        A simple function that remove superuser status from users
-        and return True if user was actually downgraded
-        """
-        downgraded = user.is_superuser
-        user.is_superuser = False
-        user.save()
-        return downgraded
-
-    # tests/myapp/test_users.py
-    from funkwhale_api.myapp import users
-
-    def test_downgrade_superuser(factories):
-        user = factories['users.User'](is_superuser=True)
-        downgraded = users.downgrade_user(user)
-
-        assert downgraded is True
-        assert user.is_superuser is False
-
-    def test_downgrade_normal_user_does_nothing(factories):
-        user = factories['users.User'](is_superuser=False)
-        downgraded = something.downgrade_user(user)
-
-        assert downgraded is False
-        assert user.is_superuser is False
-
-.. note::
-
-    We offer factories for almost if not all models. Factories are located
-    in a ``factories.py`` file inside each app.
-
-Mocking: mocking is the process of faking some logic in our code. This is
-useful when testing components that depend on each other:
-
-.. code-block:: python
-
-    # funkwhale_api/myapp/notifications.py
-
-    def notify(email, message):
-        """
-        A function that sends an email to the given recipient
-        with the given message
-        """
-
-        # our email sending logic here
-        # ...
-
-    # funkwhale_api/myapp/users.py
-    from . import notifications
-
-    def downgrade_user(user):
-        """
-        A simple function that remove superuser status from users
-        and return True if user was actually downgraded
-        """
-        downgraded = user.is_superuser
-        user.is_superuser = False
-        user.save()
-        if downgraded:
-            notifications.notify(user.email, 'You have been downgraded!')
-        return downgraded
-
-    # tests/myapp/test_users.py
-    def test_downgrade_superuser_sends_email(factories, mocker):
-        """
-        Your downgrade logic is already tested, however, we want to ensure
-        an email is sent when user is downgraded, but we don't have any email
-        server available in our testing environment. Thus, we need to mock
-        the email sending process.
-        """
-        mocked_notify = mocker.patch('funkwhale_api.myapp.notifications.notify')
-        user = factories['users.User'](is_superuser=True)
-        users.downgrade_user(user)
-
-        # here, we ensure our notify function was called with proper arguments
-        mocked_notify.assert_called_once_with(user.email, 'You have been downgraded')
-
-
-    def test_downgrade_not_superuser_skips_email(factories, mocker):
-        mocked_notify = mocker.patch('funkwhale_api.myapp.notifications.notify')
-        user = factories['users.User'](is_superuser=True)
-        users.downgrade_user(user)
-
-        # here, we ensure no email was sent
-        mocked_notify.assert_not_called()
-
-Views: you can find some readable views tests in file: ``api/tests/users/test_views.py``
-
-.. note::
-
-    A complete list of available-fixtures is available by running
-    ``docker-compose -f dev.yml run --rm api pytest --fixtures``
-
-
-Contributing to the front-end
------------------------------
-
-Running tests
-^^^^^^^^^^^^^
-
-To run the front-end test suite, use the following command::
-
-    docker-compose -f dev.yml run --rm front yarn test:unit
-
-We also support a "watch and test" mode were we continually relaunch
-tests when changes are recorded on the file system::
-
-    docker-compose -f dev.yml run --rm front yarn test:unit -w
-
-The latter is especially useful when you are debugging failing tests.
-
-.. note::
-
-    The front-end test suite coverage is still pretty low

CONTRIBUTORS.txt

-Eliot Berriot

Makefile

+SHELL := bash
+CPU_CORES := $(shell N=$$(nproc); echo $$(( $$N > 4 ? 4 : $$N )))
+
+BAKE_FILES = \
+	docker-bake.json \
+	docker-bake.api.json \
+	docker-bake.front.json
+
+docker-bake.%.json:
+	./scripts/build_metadata.py --format bake --bake-target $* --bake-image docker.io/funkwhale/$* > $@
+
+docker-metadata: $(BAKE_FILES)
+
+docker-build: docker-metadata
+	docker buildx bake $(foreach FILE,$(BAKE_FILES), --file $(FILE)) --print $(BUILD_ARGS)
+	docker buildx bake $(foreach FILE,$(BAKE_FILES), --file $(FILE)) 		 $(BUILD_ARGS)
+
+build-metadata:
+	./scripts/build_metadata.py --format env | tee build_metadata.env
+
+BUILD_DIR = dist
+package:
+	rm -Rf $(BUILD_DIR)
+	mkdir -p $(BUILD_DIR)
+	tar --create --gunzip --file='$(BUILD_DIR)/funkwhale-api.tar.gz' \
+		--owner='root' \
+		--group='root' \
+		--exclude-vcs \
+		api/config \
+		api/funkwhale_api \
+		api/install_os_dependencies.sh \
+		api/manage.py \
+		api/poetry.lock \
+		api/pyproject.toml \
+		api/Readme.md
+
+	cd '$(BUILD_DIR)' && \
+	tar --extract --gunzip --file='funkwhale-api.tar.gz' && \
+	zip -q 'funkwhale-api.zip' -r api && \
+	rm -Rf api
+
+	tar --create --gunzip --file='$(BUILD_DIR)/funkwhale-front.tar.gz' \
+		--owner='root' \
+		--group='root' \
+		--exclude-vcs \
+		--transform='s/^front\/dist/front/' \
+		front/dist
+
+	cd '$(BUILD_DIR)' && \
+	tar --extract --gunzip --file='funkwhale-front.tar.gz' && \
+	zip -q 'funkwhale-front.zip' -r front && \
+	rm -Rf front
+
+	# cd '$(BUILD_DIR)' && \
+	# cp ../front/tauri/target/release/bundle/appimage/funkwhale_*.AppImage FunkwhaleDesktop.AppImage
+
+	cd '$(BUILD_DIR)' && sha256sum * > SHA256SUMS

README.md

+# Funkwhale
+
+[![The Funkwhale logo](./front/src/assets/logo/logo-full-500.png)](https://funkwhale.audio)
+
+Funkwhale is a platform for uploading, sharing, and publishing audio content across the federated web. Curate your music library, listen to podcasts, or create your own content and share it with the world.
+
+## Contribute
+
+Want to help make Funkwhale even better? We welcome contributions from across the community. Whether you are a designer, a translator, a technical writer, or a developer, we look forward to seeing your work!
+
+You can find contribution information in our [documentation hub](https://docs.funkwhale.audio).
+
+- [Developer guides](https://docs.funkwhale.audio/developer/index.html)
+- [Contributor guides](https://docs.funkwhale.audio/contributing.html)
+
+## Get help
+
+Got a question or need help? Head over to our [forum](https://forum.funkwhale.audio/t/support) and open up a discussion.
+
+## Report a security issue
+
+If you find a security issue or vulnerability, please report it on our [GitLab instance](https://dev.funkwhale.audio/funkwhale/funkwhale/-/issues). When you open your issue, select the **This issue is confidential and should only be visible to team members with at least Reporter access** option. This ensures developers can verify and patch the issue before disclosing it.
+
+## Code of conduct
+
+The Funkwhale collective adheres to a [code of conduct](https://funkwhale.audio/code-of-conduct) in all our community spaces. Please familiarize yourself with this code and follow it when participating in discussions in our spaces.

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>`_ for instructions.

TRANSLATORS.rst

-Translating Funkwhale
-=====================
-
-Thank you for reading this! If you want to help translate Funkwhale,
-you found the proper place :)
-
-Translation is done via our own Weblate instance at https://translate.funkwhale.audio/projects/funkwhale/front/.
-
-You can signup/login using your Gitlab account (from https://dev.funkwhale.audio).
-
-Translation workflow
---------------------
-
-Once you're logged-in on the Weblate instance, you can suggest translations. Your suggestions will then be reviewer
-by the project maintainer or other translators to ensure consistency.
-
-Guidelines
-----------
-
-Respecting those guidelines is mandatory if you want your translation to be included:
-
-- Use gender-neutral language and wording
-
-Requesting a new language
--------------------------
-
-If you'd like to see a new language in Funkwhale, please open an issue here:
-https://dev.funkwhale.audio/funkwhale/funkwhale/issues

api/.coveragerc

-[run]
-include = funkwhale_api/*
-omit = *migrations*, *tests*
-plugins =
-    django_coverage_plugin

api/.dockerignore

-### OSX ###
-.DS_Store
-.AppleDouble
-.LSOverride
-
-### SublimeText ###
-# cache files for sublime text
-*.tmlanguage.cache
-*.tmPreferences.cache
-*.stTheme.cache
-
-# workspace files are user-specific
-*.sublime-workspace
-
-# project files should be checked into the repository, unless a significant
-# proportion of contributors will probably not be using SublimeText
-# *.sublime-project
-
-# sftp configuration file
-sftp-config.json
-
-# Basics
+# Exclude everything and allow only the necessary files
+*
+!/docker/
+!/config/
+!/funkwhale_api/
+!/manage.py
+!/poetry.lock
+!/pyproject.toml
+
+# Python
 *.py[cod]
 __pycache__
-
-# Logs
-*.log
-pip-log.txt
-
-# Unit test / coverage reports
-.coverage
-.tox
-nosetests.xml
-htmlcov
-
-# Translations
-*.mo
-*.pot
-
-# Pycharm
-.idea
-
-# Vim
-
-*~
-*.swp
-*.swo
-
-# npm
-front/node_modules/
-
-# Compass
-.sass-cache
-
-# virtual environments
-.env
-
-# User-uploaded media
-funkwhale_api/media/
-
-# Hitch directory
-tests/.hitch
-
-# MailHog binary
-mailhog
-
-*.sqlite3
-music
-media

api/.pylintrc

-[MASTER]
-load-plugins=pylint_common, pylint_django, pylint_celery 
-
-[FORMAT]
-max-line-length=120
-
-[MESSAGES CONTROL]
-disable=missing-docstring,invalid-name
-
-[DESIGN]
-max-parents=13
\ No newline at end of file

api/Dockerfile

-FROM python:3.6
-
-ENV PYTHONUNBUFFERED 1
-
-# Requirements have to be pulled and installed here, otherwise caching won't work
-RUN echo 'deb http://httpredir.debian.org/debian/ jessie-backports main' > /etc/apt/sources.list.d/ffmpeg.list
-COPY ./requirements.apt /requirements.apt
-RUN apt-get update; \
-    grep "^[^#;]" requirements.apt | \
-    grep -Fv "python3-dev" | \
-    xargs apt-get install -y --no-install-recommends; \
-    rm -rf /usr/share/doc/* /usr/share/locale/*
-RUN curl -L https://github.com/acoustid/chromaprint/releases/download/v1.4.2/chromaprint-fpcalc-1.4.2-linux-x86_64.tar.gz | tar -xz -C /usr/local/bin --strip 1
-COPY ./requirements/base.txt /requirements/base.txt
-RUN pip install -r /requirements/base.txt
-COPY ./requirements/production.txt /requirements/production.txt
-RUN pip install -r /requirements/production.txt
-
-COPY . /app
-
-# Since youtube-dl code is updated fairly often, we split it here
-RUN pip install --upgrade youtube-dl
-
-WORKDIR /app
-
-ENTRYPOINT ["./compose/django/entrypoint.sh"]
-CMD ["./compose/django/daphne.sh"]

api/Dockerfile

+Dockerfile.alpine
\ No newline at end of file

api/Dockerfile.alpine

+FROM alpine:3.21 AS requirements
+
+RUN set -eux; \
+  apk add --no-cache \
+  poetry \
+  py3-cryptography \
+  py3-pip \
+  python3
+
+COPY pyproject.toml poetry.lock /
+RUN set -eux; \
+  poetry export --without-hashes --extras typesense > requirements.txt; \
+  poetry export --without-hashes --with dev > dev-requirements.txt;
+
+FROM alpine:3.21 AS builder
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+ARG PIP_NO_CACHE_DIR=1
+ENV CARGO_NET_GIT_FETCH_WITH_CLI=true
+
+RUN set -eux; \
+  apk add --no-cache \
+  cargo \
+  curl \
+  gcc \
+  g++ \
+  git \
+  jpeg-dev \
+  libffi-dev \
+  libldap \
+  libxml2-dev \
+  libxslt-dev \
+  make \
+  musl-dev \
+  openldap-dev \
+  openssl-dev \
+  postgresql-dev \
+  zlib-dev \
+  py3-cryptography \
+  py3-lxml \
+  py3-pillow \
+  py3-psycopg2 \
+  py3-watchfiles \
+  python3-dev \
+  gfortran \
+  libgfortran \
+  openblas-dev \
+  py3-scipy \
+  py3-scikit-learn;
+
+# Create virtual env
+RUN python3 -m venv --system-site-packages /venv
+ENV PATH="/venv/bin:$PATH"
+
+COPY --from=requirements /requirements.txt /requirements.txt
+COPY --from=requirements /dev-requirements.txt /dev-requirements.txt
+
+RUN --mount=type=cache,target=~/.cache/pip; \
+  set -eux; \
+  pip3 install --upgrade pip;
+
+
+RUN --mount=type=cache,target=~/.cache/pip; \
+  set -eux; \
+  pip3 install setuptools wheel;
+
+RUN --mount=type=cache,target=~/.cache/pip; \
+  set -eux; \
+  # Currently we are unable to relieably build rust-based packages on armv7. This
+  # is why we need to use the packages shipped by Alpine Linux.
+  # Since poetry does not allow in-place dependency pinning, we need
+  # to install the deps using pip.
+  grep -Ev 'cryptography|lxml|pillow|psycopg2|watchfiles|scipy|scikit-learn' /requirements.txt \
+  | pip3 install -r /dev/stdin \
+  cryptography \
+  lxml \
+  pillow \
+  psycopg2 \
+  watchfiles \
+  scipy \
+  scikit-learn;
+
+ARG install_dev_deps=0
+RUN --mount=type=cache,target=~/.cache/pip; \
+  set -eux; \
+  if [ "$install_dev_deps" = "1" ] ; then \
+    grep -Ev 'cryptography|lxml|pillow|psycopg2|watchfiles' /dev-requirements.txt \
+    | pip3 install -r /dev/stdin \
+    cryptography \
+    lxml \
+    pillow \
+    psycopg2 \
+    watchfiles; \
+  fi
+
+FROM alpine:3.21 AS production
+
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+ARG PIP_NO_CACHE_DIR=1
+
+RUN set -eux; \
+  apk add --no-cache \
+  bash \
+  ffmpeg \
+  gettext \
+  jpeg-dev \
+  libldap \
+  libmagic \
+  libpq \
+  libxml2 \
+  libxslt \
+  py3-cryptography \
+  py3-lxml \
+  py3-pillow \
+  py3-psycopg2 \
+  py3-watchfiles \
+  py3-scipy \
+  py3-scikit-learn \
+  python3 \
+  tzdata
+
+COPY --from=builder /venv /venv
+ENV PATH="/venv/bin:$PATH"
+
+COPY . /app
+WORKDIR /app
+
+RUN apk add --no-cache gfortran
+RUN --mount=type=cache,target=~/.cache/pip; \
+  set -eux; \
+  pip3 install --no-deps --editable .
+
+ENV IS_DOCKER_SETUP=true
+
+CMD ["./docker/server.sh"]

api/Dockerfile.debian

+FROM python:3.13-slim AS builder
+
+ARG POETRY_VERSION=1.8
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+ENV VIRTUAL_ENV=/venv
+ENV PATH="/venv/bin:$PATH"
+
+ENV POETRY_HOME=/opt/poetry
+ENV POETRY_NO_INTERACTION=1
+ENV POETRY_VIRTUALENVS_IN_PROJECT=1
+ENV POETRY_VIRTUALENVS_CREATE=1
+ENV PYTHONDONTWRITEBYTECODE=1
+ENV PYTHONUNBUFFERED=1
+# Tell Poetry where to place its cache and virtual environment
+ENV POETRY_CACHE_DIR=/opt/.cache
+
+RUN pip install "poetry==${POETRY_VERSION}"
+
+RUN --mount=type=cache,target=/var/lib/apt/lists \
+      apt update; \
+      apt install -y \
+        build-essential \
+        python3-dev \
+        libldap-dev \
+        libsasl2-dev \
+        slapd \
+        ldap-utils \
+        tox \
+        lcov \
+        valgrind
+
+WORKDIR /app
+
+COPY pyproject.toml .
+
+RUN python3 -m venv --system-site-packages ${VIRTUAL_ENV} && . ${VIRTUAL_ENV}/bin/activate
+RUN --mount=type=cache,target=/opt/.cache \
+      poetry install --no-root --extras typesense
+
+FROM python:3.13-slim AS runtime
+
+ARG POETRY_VERSION=1.8
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+ENV VIRTUAL_ENV=/venv
+ENV PATH="/venv/bin:$PATH"
+
+RUN --mount=type=cache,target=/var/lib/apt/lists \
+      apt update; \
+      apt install -y \
+        ffmpeg \
+        gettext \
+        libjpeg-dev \
+        libldap-2.5-0 \
+        libmagic1 \
+        libpq5 \
+        libxml2 \
+        libxslt1.1
+RUN pip install "poetry==${POETRY_VERSION}"
+
+COPY --from=builder ${VIRTUAL_ENV} ${VIRTUAL_ENV}
+
+WORKDIR /app
+
+COPY . /app
+RUN poetry install --extras typesense
+
+CMD ["./docker/server.sh"]

api/Makefile

+SHELL := bash
+CPU_CORES := $(shell N=$$(nproc); echo $$(( $$N > 4 ? 4 : $$N )))
+
+.PHONY: install lint
+
+install:
+	poetry install --all-extras
+
+lint:
+	poetry run pylint \
+		--jobs=$(CPU_CORES) \
+		--output-format=colorized \
+		--recursive=true \
+		--disable=C,R,W,I \
+		config funkwhale_api tests

api/Readme.md

+# Funkwhale API
+
+This is the Funkwhale API. Check out our [API explorer](https://docs.funkwhale.audio/swagger/) for interactive documentation.
+
+## OAuth Authentication
+
+Funkwhale uses the OAuth [authorization grant flow](https://tools.ietf.org/html/rfc6749#section-4.1) for external apps. This flow is a secure way to authenticate apps that requires a user's explicit consent to perform actions. You can use our demo server at <https://demo.funkwhale.audio> for testing purposes.
+
+To authenticate with the Funkwhale API:
+
+1. Create an application by sending a `POST` request to `api/v1/oauth/apps`. Include your scopes and redirect URI (use `urn:ietf:wg:oauth:2.0:oob`
+   to get an authorization code you can copy)
+2. Send an [authorization request](https://www.rfc-editor.org/rfc/rfc6749#section-4.1.2) to the `/authorize` endpoint to receive an authorization code
+3. [Request an access token](https://www.rfc-editor.org/rfc/rfc6749#section-4.1.3) from `/api/v1/oauth/token`
+4. Use your access token to authenticate your calls with the following format: `Authorization: Bearer <token>`
+5. Refresh your access token by sending a refresh request to `/api/v1/oauth/token`
+
+For more detailed instructions, see [our API authentication documentation](https://docs.funkwhale.audio/developers/authentication.html).
+
+## Application token authentication
+
+If you have an account on your target pod, you can create an application at `/settings/applications/new`. Once you authorize the application you can retrieve an access token. Use your access token to authenticate your calls with the following format: `Authorization: Bearer <token>`
+
+## Rate limiting
+
+Funkwhale supports rate-limiting as of version 0.2.0. Pod admins can choose to rate limit specific endpoints to prevent abuse and improve the stability of the service. If the server drops a request due to rate-limiting, it returns a `429` status code.
+
+Each API call returns HTTP headers to pass the following information:
+
+- What was the scope of the request (`X-RateLimit-Scope`)
+- What is the rate-limit associated with the request scope (`X-RateLimit-Limit`)
+- How many more requests in the scope can be made within the rate-limit timeframe (`X-RateLimit-Remaining`)
+- How much time does the client need to wait to send another request (`Retry-After`)
+
+For more information, check our [rate limit documentation](https://docs.funkwhale.audio/developer/api/rate-limit.html)
+
+## Resources
+
+For more information about API usage, refer to [our API documentation](https://docs.funkwhale.audio/api.html).

api/compose/django/daphne.sh

-#!/bin/bash -eux
-python /app/manage.py collectstatic --noinput
-/usr/local/bin/daphne -b 0.0.0.0 -p 5000 config.asgi:application --proxy-headers

api/compose/django/dev-entrypoint.sh

-#!/bin/bash
-set -e
-exec "$@"

api/compose/django/entrypoint.sh

-#!/bin/bash
-set -e
-# This entrypoint is used to play nicely with the current cookiecutter configuration.
-# Since docker-compose relies heavily on environment variables itself for configuration, we'd have to define multiple
-# environment variables just to support cookiecutter out of the box. That makes no sense, so this little entrypoint
-# does all this for us.
-export CACHE_URL=${CACHE_URL:="redis://redis:6379/0"}
-
-if [ -z "$DATABASE_URL" ]; then
-  # the official postgres image uses 'postgres' as default user if not set explictly.
-  if [ -z "$POSTGRES_ENV_POSTGRES_USER" ]; then
-    export POSTGRES_ENV_POSTGRES_USER=postgres
-  fi
-  export DATABASE_URL=postgres://$POSTGRES_ENV_POSTGRES_USER:$POSTGRES_ENV_POSTGRES_PASSWORD@postgres:5432/$POSTGRES_ENV_POSTGRES_USER
-fi
-
-if [ -z "$CELERY_BROKER_URL" ]; then
-  export CELERY_BROKER_URL=$CACHE_URL
-fi
-
-# we copy the frontend files, if any so we can serve them from the outside
-if [ -d "frontend" ]; then
-  mkdir -p /frontend
-  cp -r frontend/* /frontend/
-fi
-exec "$@"

api/config/asgi.py

 import os
 
-import django
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.production")
+os.environ.setdefault("ASGI_THREADS", "5")
+
+import django  # noqa
 
 django.setup()
 
 from .routing import application  # noqa
-
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.production")