Administrator Documentation

This documentation is targeted at administrators of instances. This typically refers to the person(s) responsible for running the server and managing the software on a technical level.

Setup Guides

• Installation
  • Requirements
  • Project architecture
  • Hardware requirements
  • Software requirements
  • Available installation methods
  • Running Funkwhale on the develop branch
  • Serving only the frontend
  • Reverse proxy configuration
• Instance configuration
  • Environment variables
  • Instance settings
  • Configuration reference
  • User permissions
  • Front-end settings
• Importing music from the server
  • In-place import
  • Metadata updates
  • React to filesystem events with --watch
  • Pruning dangling metadata with --prune
  • Album covers
  • Getting demo tracks
• Using external storages to store Funkwhale content
  • S3 and S3-compatible servers
• Optimizing your Funkwhale instance
  • Reduce workers concurrency
  • Switch from prefork to solo pool
• Backup your Funkwhale instance
  • Docker setup
  • Non-docker setup
• Migrating to a New Server
  • Requirements
  • Non-Docker
  • Docker
• Uninstall Funkwhale
• LDAP configuration
  • Dependencies
  • Environment variables

Administration

• Using the Django Administration Backend
  • Accessing the Django Backend
  • Deleting Items
  • Removing a Followed Library
  • Adding Missing Album Art
• Management commands
  • User management
  • Pruning library
  • Remove obsolete files from database
  • Adding tags from tracks
• Changing Your Instance URL
  • On Docker Installations
  • On Non-Docker Installations
• Upgrading your Funkwhale instance to a newer version
  • Reading the release notes
  • Insights about new versions
  • Docker setup
  • Non-docker setup
• Message Rewrite Facility (MRF)
  • Architecture
  • Disclaimer
  • Writing your first MRF policy
  • Testing a MRF policy

Troubleshooting

• Troubleshooting
  • Diagnose problems
  • Backend issues
  • File import issues
  • Federation issues
  • Other problems
  • Report an issue or get help
  • Improving this documentation
• Debugging Funkwhale
  • Frontend Logs
  • Backend Logs
  • Profiling
  • Memory Tracing