# PinePods Documentation

> A Forest of Podcasts, Rooted in the Spirit of Self-Hosting

This file contains links to documentation sections following the llmstxt.org standard.

## Table of Contents

- [AI Ad Detection](https://pinepods.online/docs/AI/AdDetection.md): Ad detection (sometimes called "ad removal") uses a language model to find **host-read ads
- [AI Features Overview](https://pinepods.online/docs/AI/Overview.md): Pinepods has an **optional** set of AI features that run in a separate, self-hosted
- [Setting Up the AI Container](https://pinepods.online/docs/AI/Setup.md): The AI features run in the optional **`pinepods-ai`** container. This page covers deploying
- [AI Transcription](https://pinepods.online/docs/AI/Transcription.md): With the [AI container](./Setup.md) running, Pinepods can generate a **timecoded transcript**
- [API Documentation](https://pinepods.online/docs/API/api_intro.md): There's actually 2 platforms that utilize APIs in Pinepods. I will make documents going over the details on both of them.
- [Database API Reference](https://pinepods.online/docs/API/database_queries.md): :::tip This page has moved
- [PinePods Search API Documentation](https://pinepods.online/docs/API/search_api.md): The PinePods Search API is a high-performance Rust-based Actix Web application that provides comprehensive podcast and YouTube channel discovery ca...
- [Container Fundamentals](https://pinepods.online/docs/Developing/Container-Fundamentals.md): PinePods ships as a **single Docker image** that runs several cooperating processes
- [Developing](https://pinepods.online/docs/Developing/Developing.md): First of all, thanks for considering contributing on Pinepods! Pinepods is a Rust project — the frontend uses the Yew framework to build a WASM app...
- [Docs Versioning](https://pinepods.online/docs/Developing/Versioning.md): The documentation site is versioned so that each PinePods release keeps its own
- [Auto-Download](https://pinepods.online/docs/Features/AutoDownload.md): Auto-download keeps the podcasts you care about ready for offline listening
- [Chapters](https://pinepods.online/docs/Features/Chapters.md): Pinepods supports Chapters as defined by the PodcastIndex Namespace. You won't need to do anything special to take advantage of this really helpful...
- [Custom Theme Creator](https://pinepods.online/docs/Features/CustomThemes.md): PinePods ships with many built-in themes, but if none of them is quite right, the
- [Downloads](https://pinepods.online/docs/Features/Downloads.md): Download episodes to keep them for offline listening — on a flight, a commute, or
- [Favorites & Favorite Categories](https://pinepods.online/docs/Features/Favorites.md): Favorites give you a fast way to spotlight the podcasts and categories you reach for
- [Funding](https://pinepods.online/docs/Features/Funding.md): Pinepods supports Funding as defined by the PodcastIndex Namespace. Any podcast supports this tag will show the funding link on the podcast page fo...
- [Local Podcasts & Local Media](https://pinepods.online/docs/Features/LocalPodcasts.md): PinePods can add podcasts from **local files on your server** — audiobooks, archived
- [People](https://pinepods.online/docs/Features/Person.md): Pinepods supports the Person tag as defined by the PodcastIndex Namespace in addition to the PodPeopleDB. Any podcast that either includes the Pers...
- [The Queue](https://pinepods.online/docs/Features/Queue.md): The queue is your up-next list. Add episodes to it from anywhere, reorder them, and
- [Searching](https://pinepods.online/docs/Features/Search.md): Pinepods supports both The Podcast Index as well as iTunes search. Utilizing The Podcast Index is highly recommended as it supports many more moder...
- [Serial Podcasts & Auto-Play](https://pinepods.online/docs/Features/SerialPodcasts.md): Some podcasts are meant to be listened to **in order** — narrative shows, audio dramas,
- [Shared Episode Links](https://pinepods.online/docs/Features/SharedLinks.md): Shared episode links let you generate a **shareable URL for a single episode** so you
- [Listening Statistics](https://pinepods.online/docs/Features/Statistics.md): PinePods keeps track of how you listen and surfaces it on your **User Stats** page — a
- [Transcripts](https://pinepods.online/docs/Features/Transcript.md): Pinepods supports Transcripts as defined by the PodcastIndex Namespace. Any podcast episode that you play that supports this field will automatical...
- [Video Podcasts](https://pinepods.online/docs/Features/Video.md): PinePods plays **video podcasts**, not just audio. When a feed publishes video
- [Pinepods GPodder API Sync Guide](https://pinepods.online/docs/Features/gpodder-sync.md): Pinepods offers powerful podcast synchronization capabilities through the GPodder API, allowing you to keep your podcast subscriptions in sync acro...
- [PinePods Smart Playlist Creation Options](https://pinepods.online/docs/Features/smart-playlists.md): This document explains all the available options when creating smart playlists in PinePods and how each option affects the resulting playlist content.
- [Firewood Episode Beaming Guide](https://pinepods.online/docs/Firewood CLI/Beaming.md): Complete guide to Firewood's remote control and episode beaming functionality - send episodes from any device to your Firewood players across your ...
- [Firewood Setup and Login Guide](https://pinepods.online/docs/Firewood CLI/LoginPinepodsFirewood.md): A comprehensive guide to getting started with PinePods Firewood - your terminal-based podcast client.
- [Firewood User Guide](https://pinepods.online/docs/Firewood CLI/UsingPinepodsFirewood.md): Complete guide to using PinePods Firewood - your feature-rich terminal podcast client.
- [Android Auto](https://pinepods.online/docs/Mobile/AndroidAuto.md): The PinePods Android app supports **Android Auto**, so you can listen to your podcasts
- [CarPlay (iOS)](https://pinepods.online/docs/Mobile/CarPlay.md): The PinePods iOS app supports **Apple CarPlay**, so you can browse and control your
- [Offline Action Queue (Mobile)](https://pinepods.online/docs/Mobile/OfflineQueue.md): The mobile apps keep working when your connection drops. Actions you take while
- [Setting Up the Pinepods Mobile App](https://pinepods.online/docs/Mobile/SettingUpMobileApp.md): The Pinepods mobile app provides full access to your podcast library on iOS and Android devices, offering seamless synchronization with your Pinepo...
- [PostgreSQL Collation Version Mismatch Fix](https://pinepods.online/docs/Troubleshooting/CollationVersionMismatchFix.md): After upgrading PinePods, you may see constant warnings in your PostgreSQL logs like:
- [PostgreSQL 18 Docker Container Issue](https://pinepods.online/docs/Troubleshooting/PostgreSQL-18-Docker-Issue.md): A critical issue affects PostgreSQL version 18 Docker containers that prevents them from starting properly when using standard volume mount configu...
- [Upgrading PostgreSQL (e.g. 17 → 18)](https://pinepods.online/docs/Troubleshooting/PostgresMajorUpgrade.md): When you change your `db` container image to a newer PostgreSQL major version (for
- [Getting Started](https://pinepods.online/docs/intro.md): PinePods is a Rust based podcast management system that manages podcasts with multi-user support and relies on a central database with clients to c...
- [Adjusting User Settings](https://pinepods.online/docs/tutorial-basics/AdjustingUserSettings.md): The User Settings section allows administrators to manage user accounts within their Pinepods instance. This comprehensive interface provides tools...
- [Server Backup and Restore](https://pinepods.online/docs/tutorial-basics/Backup-Restore.md): Pinepods provides comprehensive server-level backup and restore functionality that allows administrators to create full database backups and restor...
- [Start Page Settings](https://pinepods.online/docs/tutorial-basics/ChangingLoginPage.md): The Start Page Settings feature allows users to customize which page they land on immediately after logging into Pinepods. This personalization opt...
- [Custom Feed Addition](https://pinepods.online/docs/tutorial-basics/CustomFeeds.md): The Custom Feed feature in Pinepods allows users to manually add podcast feeds that may not be available in standard podcast directories like The P...
- [OPML Import and Export](https://pinepods.online/docs/tutorial-basics/Importing-Exporting.md): Pinepods provides comprehensive OPML (Outline Processor Markup Language) import and export functionality, allowing users to transfer their podcast ...
- [Playback Settings](https://pinepods.online/docs/tutorial-basics/PlaybackSettings.md): The Playback Settings section allows users to customize their podcast listening experience by configuring default playback behavior and automatic e...
- [Multi-Factor Authentication (MFA) Setup](https://pinepods.online/docs/tutorial-basics/SettingUpMFA.md): Pinepods provides robust Multi-Factor Authentication using Time-based One-Time Passwords (TOTP) to add an extra layer of security to user accounts....
- [Theme Options](https://pinepods.online/docs/tutorial-basics/Theming.md): Pinepods offers a comprehensive theme system that allows users to customize the visual appearance of their podcast listening experience. With over ...
- [User Self-Service Settings](https://pinepods.online/docs/tutorial-basics/UserSelfService.md): The User Self-Service Settings feature in Pinepods allows administrators to enable user self-registration, empowering new users to create their own...
- [API Key Management](https://pinepods.online/docs/tutorial-basics/adding-an-api-key.md): Pinepods provides comprehensive API key management functionality that allows users to create, view, and manage API keys for external integrations a...
- [Browsing Podcasts in Pinepods](https://pinepods.online/docs/tutorial-basics/browsing-podcasts.md): Pinepods provides a comprehensive interface for browsing and managing your podcast content across multiple organized views. Each page is designed t...
- [Using Clients in Pinepods](https://pinepods.online/docs/tutorial-basics/clients.md): [![Discord](https://img.shields.io/badge/discord-join%20chat-5B5EA6)](https://discord.gg/bKzHRa4GNc)
- [PinePods Environment Variables Guide](https://pinepods.online/docs/tutorial-basics/environment-variables.md): Complete reference for all PinePods configuration options
- [Searching and Adding Podcasts](https://pinepods.online/docs/tutorial-basics/searching-and-adding.md): Pinepods provides powerful podcast discovery tools that allow you to search across multiple podcast directories and add new shows to your subscript...
- [The Settings Page](https://pinepods.online/docs/tutorial-basics/settings.md): The Settings page in Pinepods is your central hub for customizing the application to fit your preferences and managing various aspects of your podc...
- [Sign into Pinepods](https://pinepods.online/docs/tutorial-basics/sign-in-homescreen.md): Pinepods provides a comprehensive sign-in experience that includes user authentication, customizable landing pages, and seamless integration with y...
- [OIDC Setup](https://pinepods.online/docs/tutorial-extras/OIDC-setup.md): You can now setup OIDC logins in Pinepods to use either your own self-hosted OIDC provider or one of the other large cloud hosted providers such as...
- [Password Reset System](https://pinepods.online/docs/tutorial-extras/PasswordResets.md): Pinepods provides a comprehensive password reset system that allows users to securely reset their passwords when they cannot access their accounts....
- [RSS Feed Integration](https://pinepods.online/docs/tutorial-extras/RSSFeeds.md): Pinepods provides comprehensive RSS feed integration that allows you to access your podcast subscriptions from any RSS-compatible podcast applicati...
- [Setting Up Notifications](https://pinepods.online/docs/tutorial-extras/SettingUpNotifications.md): Pinepods provides comprehensive push notification support to keep you informed about new podcast episodes, system updates, and other important even...
- [PinePods Podcast Synchronization Guide](https://pinepods.online/docs/tutorial-extras/gpodder-sync.md): PinePods 0.7.8 introduced a completely rebuilt podcast synchronization system, offering multiple ways to keep your podcast subscriptions and listen...
- [PodPeopleDB Integration](https://pinepods.online/docs/tutorial-extras/podpeopledb.md): Pinepods integrates with the PodPeopleDB in order to expand host tracking between podcasts. This is a community project that listeners of the given...
- [Welcome](https://pinepods.online/blog/2023-08-06-welcome/welcome.md): Welcome to the Pinepods official documentation site! Feel free to browse around and check out the docs. Make sure you join the Pinepods [discord](h...
- [A Note About iOS Development and Open Source](https://pinepods.online/blog/2024-12-08/ios-progress.md): I wanted to take a moment to address questions about an iOS version of the Pinepods client. I have gotten them plenty of times before. The short an...
- [PodPeopleDB: Building the IMDB of Podcasting](https://pinepods.online/blog/2024-12-08/podpeople-db.md): In the ever-expanding universe of podcasting, there's been a crucial piece missing from the puzzle: Standardization. While this can cause some chal...