Welcome to GNU MediaGoblin’s documentation!

GNU MediaGoblin is a platform for sharing photos, video and other media in an environment that respects our freedom and independence.

This is a Free Software project. It is built by contributors for all to use and enjoy. If you’re interested in contributing, see the wiki which has pages that talk about the ways someone can contribute.

Part 1: Site Administrator’s Guide

This guide covers installing, configuring, deploying and running a GNU MediaGoblin website. It is written for site administrators.

• Foreword
• About GNU MediaGoblin
• Deploying MediaGoblin
• MediaGoblin in Docker
• Further Considerations for Production Deployments
• Configuring MediaGoblin
• Upgrading MediaGoblin
• Troubleshooting
• Media Types
• How to Get Help with MediaGoblin
• MediaGoblin in Docker
• Release Notes
• Theming MediaGoblin
• Plugins
• Command-line and batch uploading

Part 2: Core plugin documentation

• basic_auth plugin
• flatpagesfile plugin
• LDAP plugin
• OpenID plugin
• raven plugin
• sampleplugin
• Subtitles plugin
• Trim whitespace plugin

Part 3: Plugin Writer’s Guide

This guide covers writing new GNU MediaGoblin plugins.

• Foreword
• Quick Start
• Database models for plugins
• Plugin API
• Writing unit tests for plugins
• Documentation on Built-in Hooks
• Media Type hooks
• Authentication Hooks

Part 4: Developer’s Zone

This chapter contains various information for developers.

• Contributing
• Codebase Documentation
• Storage
• Release Checklist
• Original Design Decisions
• Migrations

Part 5: Pump API

This chapter covers MediaGoblin’s Pump API support. (A work in progress; full federation is not supported at the moment, but media uploading works! You can use something like PyPump to write MediaGoblin applications.)

• API Authentication
• Activities
• Objects

Indices and tables

• Search Page

• Index

This guide was built on Aug 30, 2024.