{"id":33384871,"url":"https://github.com/aizhimou/pigeon-pod","last_synced_at":"2026-04-01T19:21:46.494Z","repository":{"id":311414739,"uuid":"1043083438","full_name":"aizhimou/pigeon-pod","owner":"aizhimou","description":"Listen to YouTube. Anywhere.","archived":false,"fork":false,"pushed_at":"2025-11-23T02:01:19.000Z","size":20732,"stargazers_count":588,"open_issues_count":3,"forks_count":53,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-11-23T04:04:13.132Z","etag":null,"topics":["listenbox","mantine-v8","podcast","podsync","react","self-hosted","springboot3","youtube"],"latest_commit_sha":null,"homepage":"https://pigeonpod.cloud","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aizhimou.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-23T05:28:12.000Z","updated_at":"2025-11-23T01:18:46.000Z","dependencies_parsed_at":"2025-08-24T15:40:40.613Z","dependency_job_id":"60bbf34a-381c-47ca-954d-dd3dc72643ef","html_url":"https://github.com/aizhimou/pigeon-pod","commit_stats":null,"previous_names":["aizhimou/pigeon-pod"],"tags_count":26,"template":false,"template_full_name":"aizhimou/sparrow","purl":"pkg:github/aizhimou/pigeon-pod","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aizhimou%2Fpigeon-pod","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aizhimou%2Fpigeon-pod/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aizhimou%2Fpigeon-pod/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aizhimou%2Fpigeon-pod/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aizhimou","download_url":"https://codeload.github.com/aizhimou/pigeon-pod/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aizhimou%2Fpigeon-pod/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":285898425,"owners_count":27250309,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-23T02:00:06.149Z","response_time":135,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["listenbox","mantine-v8","podcast","podsync","react","self-hosted","springboot3","youtube"],"created_at":"2025-11-23T04:04:36.125Z","updated_at":"2026-03-15T16:23:44.102Z","avatar_url":"https://github.com/aizhimou.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\".github/docs-assets/logo-with-brand.png\" alt=\"pigeonpod\" width=\"260\" /\u003e\n  \u003ch2\u003eListen to YouTube \u0026 Bilibili, Anywhere, Anytime.\u003c/h2\u003e\n  \u003ch3\u003eIf self-hosting isn't your thing, take a look at our upcoming online services:\n    \u003ca target=\"_blank\" href=\"https://pigeonpod.cloud/?utm_source=github\u0026utm_medium=repo\u0026utm_campaign=readme\u0026utm_content=cta\"\u003ePigeonPod\u003c/a\u003e\n  \u003c/h3\u003e\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n  [简体中文](README-ZH.md) | [Español](README-ES.md) | [Português](README-PT.md) | [日本語](README-JA.md) | [Deutsch](README-DE.md) | [Français](README-FR.md) | [한국어](README-KO.md)\n\u003c/div\u003e\n\n## Screenshots\n\n![index-dark\u0026light](.github/docs-assets/home-27-11-2025.png)\n\u003cdiv align=\"center\"\u003e\n  \u003cp style=\"color: gray\"\u003eChannel list\u003c/p\u003e\n\u003c/div\u003e\n\n![detail-dark\u0026light](.github/docs-assets/feed-27-11-2025.png)\n\u003cdiv align=\"center\"\u003e\n  \u003cp style=\"color: gray\"\u003eChannel detail\u003c/p\u003e\n\u003c/div\u003e\n\n## Core Features\n\n- **🎯 Smart Subscription \u0026 Preview**: Subscribe to YouTube or Bilibili channels and playlists in seconds.\n- **📻 Secure RSS for Any Client**: Generate protected standard RSS feeds for any podcast app.\n- **🎦 Flexible Audio/Video Output**: Download as audio or video with quality and format control.\n- **🤖 Auto Sync \u0026 History Backfill**: Keep subscriptions updated and backfill older videos on demand.\n- **🍪 Expanded Cookie Support**: Use YouTube and Bilibili cookies for more reliable restricted-content access.\n- **🌍 Proxy-ready Network Access**: Route YouTube API and yt-dlp traffic through custom proxies.\n- **🔗 One-click Episode Sharing**: Share any episode with a public page for direct playback without login.\n- **📦 Fast Batch Downloads**: Search, select, and queue large back catalogs efficiently.\n- **📊 Download Dashboard \u0026 Bulk Actions**: Track task status and retry, cancel, or delete in bulk.\n- **🔔 Failed-download Digests \u0026 Alerts**: Get email or webhook summaries when automatic retries are exhausted.\n- **🔍 Per-feed Filters \u0026 Retention**: Control sync scope with keywords, duration, and episode limits.\n- **⏱ Smarter New Episode Downloads**: Delay auto-downloads to improve fresh-video processing results.\n- **🎛 Customizable Feeds \u0026 Player**: Customize titles and cover art, then play episodes on the web.\n- **🧩 Episode Management \u0026 Control**: Download, retry, cancel, and delete episodes with file cleanup.\n- **🔓 Trusted-environment Auto Login**: Skip manual sign-in when PigeonPod runs behind trusted access controls.\n- **📈 YouTube API Usage Insights**: Monitor quota usage before sync jobs hit the limit.\n- **🔄 OPML Subscription Export**: Export subscriptions for easy migration between podcast clients.\n- **⬆️ In-app yt-dlp Management**: Manage runtimes, switch active versions, and update yt-dlp without leaving the app.\n- **🛠 Advanced yt-dlp Arguments**: Fine-tune downloads with custom yt-dlp arguments.\n- **📚 Podcasting 2.0 Chapters Support**: Generate chapter files for richer player navigation.\n- **🌐 Multilingual Responsive UI**: Use PigeonPod across devices in eight interface languages.\n\n## Deployment\n\n### Using Docker Compose (Recommended)\n\n**Make sure you have Docker and Docker Compose installed on your machine.**\n\n1. Use the docker-compose configuration file, modify environment variables according to your needs\n```yml\nversion: '3.9'\nservices:\n  pigeon-pod:\n    image: 'ghcr.io/aizhimou/pigeon-pod:latest'\n    restart: unless-stopped\n    container_name: pigeon-pod\n    ports:\n      - '8834:8080'\n    environment:\n      - SPRING_DATASOURCE_URL=jdbc:sqlite:/data/pigeon-pod.db # set to your database path\n      # Optional: disable PigeonPod built-in auth when running behind another auth layer\n      # - PIGEON_AUTH_ENABLED=false\n    volumes:\n      - data:/data\n\nvolumes:\n  data:\n```\n\n\u003e [!WARNING]\n\u003e `PIGEON_AUTH_ENABLED` defaults to `true`. Set it to `false` only if another trusted layer already protects the web UI, such as an auth proxy, reverse proxy access control, VPN, or private network.\n\u003e\n\u003e If you disable built-in auth, you must secure PigeonPod by other means. Do not expose an auth-disabled instance directly to the public Internet.\n\n2. Start the service\n```bash\ndocker-compose up -d\n```\n\n3. Access the application\nOpen your browser and visit `http://localhost:8834` with **default username: `root` and default password: `Root@123`**\n\n### Run with JAR\n\n**Make sure you have Java 17+ and yt-dlp installed on your machine.**\n\n1. Download the latest release JAR from [Releases](https://github.com/aizhimou/pigeon-pod/releases)\n\n2. Create data directory in the same directory as the JAR file.\n```bash\nmkdir -p data\n```\n\n3. Run the application\n```bash\njava -jar -Dspring.datasource.url=jdbc:sqlite:/path/to/your/pigeon-pod.db \\  # set to your database path\n           pigeon-pod-x.x.x.jar\n```\n\n4. Access the application\nOpen your browser and visit `http://localhost:8080` with **default username: `root` and default password: `Root@123`**\n\n\n## Storage Configuration\n\n- PigeonPod supports `LOCAL` and `S3` storage modes.\n- You can only enable one mode at a time.\n- S3 mode supports MinIO, Cloudflare R2, AWS S3, and other S3-compatible services.\n- Switching storage mode does not migrate historical media automatically. You must migrate files manually.\n\n### Storage Quick Comparison\n\n| Mode | Pros | Cons |\n| --- | --- | --- |\n| `LOCAL` | Easy setup, no external dependency | Uses local disk, harder to scale |\n| `S3` | Better scalability, suitable for cloud deployment | Requires object storage setup and credentials |\n\n\n## Documentation\n\n- [Wiki Home](https://github.com/aizhimou/PigeonPod/wiki)\n- [Quick Start](https://github.com/aizhimou/PigeonPod/wiki/Quick-Start)\n- [Installation](https://github.com/aizhimou/PigeonPod/wiki/Installation)\n- [Configuration Overview](https://github.com/aizhimou/PigeonPod/wiki/Configuration-Overview)\n- [Troubleshooting](https://github.com/aizhimou/PigeonPod/wiki/Troubleshooting)\n- [Advanced Customization](https://github.com/aizhimou/PigeonPod/wiki/Advanced-Customization)\n\n\n## Tech Stack\n\n### Backend\n- **Java 17** - Core language\n- **Spring Boot 3.5** - Application framework\n- **MyBatis-Plus 3.5** - ORM framework\n- **Sa-Token** - Authentication framework\n- **SQLite** - Lightweight database\n- **Flyway** - Database migration tool\n- **YouTube Data API v3** - YouTube data retrieval\n- **yt-dlp** - Video download tool\n- **Rome** - RSS generation library\n\n### Frontend\n- **Javascript (ES2024)** - Core language\n- **React 19** - Application framework\n- **Vite 7** - Build tool\n- **Mantine 8** - UI component library\n- **i18next** - Internationalization support\n- **Axios** - HTTP client\n\n## Development Guide\n\n### Environment Requirements\n- Java 17+\n- Node.js 22+\n- Maven 3.9+\n- SQLite\n- yt-dlp\n\n### Local Development\n\n1. Clone the project\n```bash\ngit clone https://github.com/aizhimou/PigeonPod.git\ncd PigeonPod\n```\n\n2. Configure database\n```bash\n# Create data directory\nmkdir -p data/audio\n\n# Database file will be created automatically on first startup\n```\n\n3. Configure YouTube API\n   - Create a project in [Google Cloud Console](https://console.cloud.google.com/)\n   - Enable YouTube Data API v3\n   - Create an API key\n   - Configure the API key in user settings\n\n4. Start backend\n```bash\ncd backend\nmvn spring-boot:run\n```\n\n5. Start frontend (new terminal)\n```bash\ncd frontend\nnpm install\nnpm run dev\n```\n\n6. Access the application\n- Frontend dev server: `http://localhost:5173`\n- Backend API: `http://localhost:8080`\n\n### Development Notes\n\n1. Ensure yt-dlp is installed and available in command line\n2. Configure correct YouTube API key\n3. Ensure audio storage directory has sufficient disk space\n4. Regularly clean up old audio files to save space\n\n## Star History\n\n[![Star History Chart](https://api.star-history.com/svg?repos=aizhimou/pigeon-pod\u0026type=Timeline)](https://www.star-history.com/#aizhimou/pigeon-pod\u0026Timeline)\n---\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp\u003eMade with ❤️ for podcast enthusiasts!\u003c/p\u003e\n  \u003cp\u003e⭐ If you like PigeonPod, give us a star on GitHub!\u003c/p\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faizhimou%2Fpigeon-pod","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faizhimou%2Fpigeon-pod","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faizhimou%2Fpigeon-pod/lists"}