Skip to content

Latest commit

 

History

History
127 lines (84 loc) · 12.1 KB

ReadMe.md

File metadata and controls

127 lines (84 loc) · 12.1 KB
Raw

🍿 ListSync - Bridge Your Watchlist & Media Server 🎬

ListSync Logo GitHub last commit GitHub issues GitHub stars GitHub release Docker Python Website LinkedIn

📜 Table of Contents

  1. Compatibility
  2. Getting Started
  3. Obtaining List IDs
  4. How it Works
  5. Troubleshooting
  6. Roadmap
  7. Notes
  8. Contributing
  9. License

🎬 Demo

Bot In Action

🚀 Getting Started

Installation Method Command
Docker docker pull ghcr.io/woahai321/list-sync:main && docker run -it --rm -v "$(pwd)/data:/usr/src/app/data" -e TERM=xterm-256color ghcr.io/woahai321/list-sync:main
Python git clone https://github.com/Woahai321/list-sync.git && cd list-sync && pip install -r requirements.txt && python add.py
Poetry git clone https://github.com/Woahai321/list-sync.git && cd list-sync && poetry install && poetry run python add.py

For detailed installation instructions, please refer to our Installation Guide.

📊 Compatibility

Application Status Notes
SeerrBridge ✅ Supported Fully compatible
Overseerr ✅ Supported Full functionality with Overseerr
Jellyseerr ✅ Supported Full functionality with Jellyseerr
Radarr ✅ Supported Started with supporting movies
Sonarr ✅ Supported Now also supports TV shows

Supported List Services

Service Status Notes
IMDB ✅ Supported Currently supported
Trakt ✅ Supported Currently supported

🔍 Obtaining List IDs

IMDB List ID

To obtain an IMDB list ID:

  1. Navigate to your IMDB list.
  2. Look at the URL. It should be in the format: https://www.imdb.com/list/ls012345678/
  3. The list ID is the ls number. In this example, it would be ls012345678.

Trakt List ID

To obtain a Trakt list ID:

  1. Go to your Trakt list.
  2. Look for the blue "Share" button, located in the list.
  3. trakt-help
  4. Hover over it, it should say "Copy Link".
  5. The copied link will be in the format: https://trakt.tv/lists/12345678
  6. The list ID is the number at the end. In this example, it would be 12345678.

Adding Multiple List IDs

When inputting list IDs, you can add multiple IDs by separating them with commas.

📋 Notes

  • Security Best Practices: Please read scripts you find online before running them.
  • API Credentials: Always keep your API credentials secure.
  • Rate Limiting: Be mindful of Overseerr's rate limiting policies during imports.
  • Permissions: Only import and manage media you have the rights to handle.

💰 Donations

If you find ListSync useful and would like to support its development, consider making a donation:

  • BTC (Bitcoin): bc1qxjpfszwvy3ty33weu6tjkr394uq30jwkysp4x0
  • ETH (Ethereum): 0xAF3ADE79B7304784049D200ea50352D1C717d7f2

Thank you for your support!

🔎 How it Works

For detailed information on how ListSync works, please refer to our How it Works document.

🛠 Troubleshooting

If you encounter any issues while using ListSync, please check our Troubleshooting Guide for solutions to common problems.

🛤️ Roadmap

To see our plans for future development and features, visit our Roadmap.

🤝 Contributing

We welcome contributions! For guidelines on how to contribute, please see our Contributing Guide.

📄 License

This project is licensed under the MIT License. Review the LICENSE file for more details.

🛡️ Legal Disclaimer

For important legal information about using ListSync, please refer to our Legal Disclaimer.

Star History

Star History Chart