funkwhale Logo
1.2.5

User documentation

  • Get started
  • Your account
  • Channels
  • Libraries
  • Queue
  • Playlists
  • Radios
  • Favorites
  • Reporting
  • Subsonic access
  • User plugins
  • Funkwhale CLI

Admin documentation

  • Get started
  • Install Funkwhale on your server
  • Docker migration guide

Moderator documentation

  • Get started
  • Handle reports
  • Moderate your pod’s users
  • Moderate content on your pod
  • Moderate external domains
  • Moderate external users
  • Allow-listing

Developer documentation

  • Contribute to Funkwhale development
  • Developer documentation
    • Architecture
    • Funkwhale API
    • API Authentication
    • Funkwhale plugins
    • Funkwhale Federation
    • Subsonic API

Contributor documentation

  • Contribute to Funkwhale’s Documentation
  • Translating Funkwhale

Reference

  • Glossary of terms

Changes

  • Changelog
funkwhale
  • »
  • Developer documentation
  • Edit on GitLab

Warning

This documentation only applies for the development version of Funkwhale! Visit the docs for the latest release.

Developer documentation

This documentation is targeted primarily at developers who want to understand how Funkwhale works and how to build apps that integrate with Funkwhale’s ecosystem.

  • Architecture
    • The user
    • The web interface
    • Third-party apps
    • The reverse proxy
    • The API server
    • The database
    • The cache/message queue
    • The worker
    • The scheduler
  • Funkwhale API
  • API Authentication
    • OAuth
  • Funkwhale plugins
    • Installing a plugin
    • Types of plugins
    • Hooks and filters
    • Writing a plugin
    • Hooks reference
    • Filters reference
  • Funkwhale Federation
    • Technologies and standards
    • Philosophy
    • Internal logic
    • Service actor
    • Supported activities
    • Supported objects
    • Audio fetching on restricted libraries
    • Properties
    • attributedTo
  • Subsonic API
    • Supported endpoints
    • Additional properties
    • Testing a Subsonic app
Previous Next

© Copyright 2022, The Funkwhale Collective.

Built with Sphinx using a theme provided by Read the Docs.
Other Versions develop
Versions
develop
stable