Viren070/AIOStreams
1
0
Fork 0
mirror of https://github.com/Viren070/AIOStreams.git synced 2025-12-01 23:14:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: simplify README.md to focus on features

Browse Source 
migrating to Wiki
This commit is contained in:
Viren070
2025-04-30 16:49:06 +01:00
parent c57157614e
commit 2eeb207329
1 changed files with 50 additions and 388 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+50 -388
View File
@@ -1,426 +1,88 @@
<p align="center"><img src="https://raw.githubusercontent.com/Viren070/AIOStreams/refs/heads/main/packages/frontend/public/assets/logo.png" /></p>
<h1 align="center" id="title">AIOStreams</h1>
## Table of Contents
- [Description](#description)
- [FAQ](#faq)
- [How does it work?](#how-does-it-work)
- [Usage](#usage)
- [Public Instace](#public-instance)
- [Cloudflare Workers](#cloudflare-workers)
- [ElfHosted](#elfhosted-paid)
- [Heroku](#heroku-paid)
- [Docker](#docker)
- [From Source](#from-source)
- [Configuring](#configuring)
- [Environment Variables](#environment-variables)
- [Cloudflare Workers](#cloudflare-workers-1)
- [Local](#local)
- [Development](#development)
- [Credits](#credits)
## Description
Combines streams from other addons into one and provides much greater customisation:
AIOStreams consoloidates multiple Stremio addons and debrid services into a single, easily configurable addon. It allows highly customisable filtering, sorting, and formatting of results and supports proxying all your streams through [MediaFlow Proxy](https://github.com/mhdzumair/mediaflow-proxy) for improved compatibility and IP restriction bypassing.
- Change the format of the resutls
- Filter all results by resolution, quality, visual tags, audio tags, encodes.
- Remove duplicate results, and prioritise specific services for a given file.
- Sort all results by quality, resolution, size, cached, visual tags, audio tags, encodes, seeders, service, language
- Prioritise or exclude specific languages
- Specify a minimum and/or maximum size
- Limiting to a specific number of results per resolution
- Proxy your streams with MediaFlow
## Key Features & Capabilities
You simply configure your options, add any API keys for any services you use, then enable whichever addons you want, and install.
- **Unified Addon Interface:** Aggregate results from various addons into a single, streamlined list.
- **Wide Addon Support:** Configure and integrate results from various addons. Even an addon that is not officially supported can be added by providing its URL as a custom addon.
- **Easy Configuration:** You can simply enable the services and addons you use, and AIOStreams will handle the rest.
- **Advanced Filtering:**
- Filter results by resolution, quality, visual tags (e.g., HDR, DV), audio tags (e.g., Atmos, DTS), and video encodes.
- Filter by keywords present in the stream title.
- Specify minimum and maximum file sizes individually for episodes and movies.
- Prioritise and/or exclude specific languages.
- **Sophisticated Sorting:** Sort aggregated results by quality, resolution, size, cached status, visual tags, audio tags, encodes, seeders (for torrents), service provider, language, or personal.
- **Duplicate Removal:** Intelligently removes duplicate results and prioritises specific services and addons for the same file based on your configuration.
- **Result Limiting:** Limit the number of results shown per resolution.
- **Customisable Result Formatting:**
- Choose from predefined formats (e.g., `gdrive`, `minimalistic-gdrive`, `torrentio`, `torbox`).
- Utilise a **Custom Formatter** system to define exactly how stream information is displayed. See the [Custom Formatter Wiki page](https://github.com/Viren070/AIOStreams/wiki/Custom-Formatter) for details.
- View the formatters in the live preview at the configuration page.
- **MediaFlow Proxy Integration:** Proxy your streams through MediaFlow to allow for:
- **IP Restriction Bypass**: Bypass simultaneous IP restrictions on some services
- **Improved Compatibility**: Using MediaFlow Proxy improves compatibility with some apps and external players (like Infuse)
The addon will scrape all results from all addons, apply your configuration, and give the results back to you in one go.
## Supported Addons
> [!NOTE]
> Do not install other addons that you have enabled through this addon. You will only cause unnecessary requests to the addon.
> I also do not recommend installing/enabling too many addons as they all scrape mostly the same sources.
## FAQ
### How does it work?
The addon has parsers for specific addons and can extract the relevant information.
It goes through each addon you selected and obtains the results with all the parsed information.
Once it has all the parsed information for each result, it can apply your configured sorting and filtering options.
### Why was this addon created?
I wanted to have a single addon that could scrape all the sources I wanted and apply my own custom filters and sorting options.
Many addons lack the ability to finely tune how you want your results to be sorted and filtered.
Being able to change the format of every result was also a big factor in creating this addon.
I preferred the format of my GDrive addon and wanted to use that format for all my results.
This makes it easier to parse the results and explain to less tech-savvy people how to pick the best result.
It also means you only have to install one addon instead of configuring multiple addons.
Furthermore, being able to apply a global filter and sort to all results means that you can get the best results from all sources displayed first,
rather than having to check each addon individually.
### What are the currently supported addons?
It currently supports:
AIOStreams can parse and integrate results from the following addons:
- Torrentio
- MediaFusion
- Comet
- Torbox Addon
- Debridio
- Jackettio
- Jackettio / Stremio-Jackett
- Peerflix
- DMM Cast
- Orion Stremio Addon
- Easynews
- Easynews+
- Easynews++
- [Stremio GDrive](https://github.com/Viren070/stremio-gdrive-addon)
- Custom: You can input an addon URL and name and it will parse as much information as it can.
- Stremthru Store
- **Custom Addons:** Input any addon URL, and AIOStreams will attempt to parse its results.
> [!NOTE]
> The URL can either be a URL to the manifest.json or the url without the manifest.json
> e.g. `https://torrentio.strem.fun/` or `https://torrentio.strem.fun/manifest.json`
> Avoid installing the addons directly in Stremio if you have enabled them within AIOStreams to prevent redundant requests. Enabling too many addons simultaneously is also generally not recommended as they often scrape overlapping sources.
### What are the supported formatters?
## Getting Started
The addon can display your results in different formats. The formats available are:
To use AIOStreams, you need to host it yourself or use a hosted instance. Once running, access the `/configure` endpoint to set up your preferences, add API keys, select the addons you want to integrate, and install the configured AIOStreams addon into your Stremio application.
- gdrive:
Uses the format from this [Stremio GDrive](https://github.com/Viren070/stremio-gdrive-addon) addon
For detailed instructions on **Deployment**, **Configuration**, and **Development**, please refer to the project [**Wiki**](https://github.com/Viren070/AIOStreams/wiki):
![image](https://github.com/user-attachments/assets/9d9c74ab-afde-41f9-ba94-eaf8904b580b)
- **[Deployment Guide](https://github.com/Viren070/AIOStreams/wiki/Deployment)** (Covers Docker, Cloudflare Workers, ElfHosted, Heroku, From Source, etc.)
- **[Configuration Guide](https://github.com/Viren070/AIOStreams/wiki/Configuration)** (Explains configuration options and Environment Variables)
- **[Development Guide](https://github.com/Viren070/AIOStreams/wiki/Development)** (Instructions for contributing or running in development mode)
- minimalistic-gdrive
A modified version of the `gdrive` format where the filename is not shown. Emojis are used for languages, and seeders are not shown for cached results.
## FAQ
- torrentio:
Uses the format from the Torrentio addon.
- **How does it work?** AIOStreams fetches results from each enabled addon, parses the stream information, applies your configured filtering and sorting rules, formats the results, and presents them as a single Stremio addon.
- **Why was this created?** To provide a centralised way to manage multiple addons and debrid services with fine-grained control over filtering, sorting, and result presentation, which many individual addons lack.
- **What is Stremio?** If you're new to Stremio, check out my [Stremio guide](https://guides.viren070.me/stremio).
![image](https://github.com/user-attachments/assets/343dccb4-13c5-4b57-998a-82b763e9ebf9)
## Support the Project
- torbox:
Uses the format from the Torbox stremio addon.
AIOStreams is a free and open-source project maintained by me and its contributors. If you find it useful, you can support its development in the following ways:
![image](https://github.com/user-attachments/assets/21f90ee2-e81d-4a56-9e64-8937fb7ab2bc)
- **Star the Repository**: Starring the repository helps others discover the project and shows your appreciation.
- **Star on Community Addon Sites**: If you use AIOStreams as an addon, consider starring it on community addon directories to help spread the word.
- **Contributions Welcome**: Issues, pull requests, and ideas for improvement are always appreciated.
- **Donations**: You can support the project financially by donating on [Ko-fi](https://ko-fi.com/) or becoming a [GitHub Sponsor](https://github.com/sponsors/Viren070).
### What is Stremio or How do I use this addon?
Read my [Stremio guide](https://guides.viren070.me/stremio).
## Usage
### Public Instance
> [!IMPORTANT]
> Torrentio is disabled on the public instance! However, most users don't need Torrentio and MediaFusion also provides streams from Torrentio, so try the public instance first, you may not need to self-host.
[ElfHosted](https://elfhosted.com/) have been kind enough to host a [community instance of AIOStreams](https://aiostreams.elfhosted.com/configure).
This community instance does have a ratelimit in place, but it is unlikely you will reach it. It also avoids the ratelimits of ElfHosted addons like Comet and MediaFusion as AIOStreams' requests to these addons are routed internally.
However, other non-ElfHosted addons may rate limit the community instance.
### Cloudflare Workers
This addon can be deployed as a [Cloudflare Worker](https://workers.cloudflare.com/).
> [!NOTE]
> Cloudflare Workers cannot make requests to other Cloudflare Workers from the same account. If you have deployed the Stremio GDrive addon already on a Cloudflare account, the AIOStreams worker on the same account will not be able to fetch streams from your Stremio GDrive worker.
> [!WARNING]
> A Cloudflare Worker may get blocked by Torrentio. You may also encounter a build error, in which case you will have to edit the code slightly and lose the functionality of the `ADDON_PROXY` environment variable
There are 2 methods to do this. Method 2 requires you to have Git and Node.js installed, method 1 does not, and only requires a web browser and a Cloudflare account.
**Method 1**
1. Fork my GitHub repository.
2. Head to the [Cloudflare Dashboard](https://dash.cloudflare.com/sign-up/workers-and-pages), signing up for an account if needed.
3. Click the `Create` button and call your worker `aiostreams`
4. Click `Continue to project` after it's done creating
5. Go to the `Settings` tab.
6. Scroll down to the `Build` section, and click `Connect` on the Git repository option.
- Choose your GitHub account, and the repository you created earlier when forking my repository
- Leave the branch as main
- Build command:
```bash
npm install | npm run build
```
- Deploy command:
```bash
npm run deploy:cloudflare-worker
```
7. Click `Connect`
8. Trigger a redeployment by editing the README file at your fork (you can just add a letter and click commit changes)
9. You can find the URL for your cloudflare worker by clicking `View version` at the `Deployments` tab under the `Active deployments` section
If you get an error about the `node:sqlite` module, follow [these instructions](https://github.com/Viren070/AIOStreams/issues/32#issuecomment-2602643959), editing the code at your forked GitHub repository.
**Method 2**
1. Sign up for a [Cloudflare Account](https://dash.cloudflare.com/sign-up/workers-and-pages)
2. Install Node.js (I would recommend using package managers e.g. fnm on Windows)
3. Install Git
4. Run the following commands:
```bash
git clone https://github.com/Viren070/AIOStreams.git
cd AIOStreams
npm i
npm run build
npm run deploy:cloudflare-worker
```
If you get an error about the `node:sqlite` module, follow [these instructions](https://github.com/Viren070/AIOStreams/issues/32#issuecomment-2602643959)
#### Updating
**Method 1**
Go to your forked GitHub repository and click sync fork. This should trigger a deployment, if not follow the same steps above to redeploy.
**Method 2**
To update the addon, you can simply run the following commands to pull the latest changes, build the project, and deploy the worker.
This will update the worker with the latest changes, which may not be stable. In case, you get the build error about `node:sqlite` again, follow the instructions linked above again.
```
git pull --rebase
npm run build
npm run deploy:cloudflare-worker
```
### ElfHosted (paid)
> [!NOTE]
> Use the link below to support me, 33% of your AIOStreams subscription will go to me ❤️
AIOStreams is available as a [paid product on ElfHosted](https://store.elfhosted.com/product/aiostreams/elf/viren070/). This offers you a no-hassle experience where you can expect things to "just work".
### Heroku (paid)
> [!TIP]
> Heroku have a [student offer](https://www.heroku.com/github-students/) which gives you $13 worth of credit each month to spend for 24 months.
To deploy AIOStreams on [Heroku](https://heroku.com/), you can fork this repository, and create a new app on the [Heroku Dashboard](https://dashboard.heroku.com/), using `GitHub` as the deployment method in the `Deploy` tab, and choosing the `Node.js` buildpack in the `Settings` tab.
### Docker
[Docker](https://docs.docker.com/get-docker/) is a quick and convenient way to run this. Official images are available at the [ghcr.io](https://github.com/Viren070/AIOStreams/pkgs/container/aiostreams) and [docker.io](https://hub.docker.com/r/viren070/aiostreams) registries
Rather than running this on a personal device, you can follow these instructions to run it on a server or VPS.
You can use a free VPS from Oracle for this, or some cheap ones found on [LowEndBox](https://lowendbox.com/).
#### Docker Compose
1. Download the `compose.yaml` and `.env.sample` files:
```bash
curl -O https://raw.githubusercontent.com/Viren070/AIOStreams/main/compose.yaml
curl -O https://raw.githubusercontent.com/Viren070/AIOStreams/main/.env.sample -o .env
```
2. Edit the `.env` file to your liking.
3. Run the following command:
```bash
docker compose up -d
```
#### Traefik
For an easy way to get HTTPS (which is required to install Stremio addons outside of localhost), you can use Traefik as a reverse proxy.
**Requirements**:
- A domain/subdomain with a CNAME/A record pointing to the public IP of the server
- A server with ports 443 open
> [!TIP]
> You can use free domains from DuckDNS and Afraid
1. Use the `compose.traefik.yaml` file instead of the `compose.yaml` file.
```bash
curl -O https://raw.githubusercontent.com/Viren070/AIOStreams/main/compose.traefik.yaml -o compose.yaml
```
If you haven't already downloaded the `.env` file, do so now:
```bash
curl -O https://raw.githubusercontent.com/Viren070/AIOStreams/main/.env.sample -o .env
```
2. Ensure that the 'TRAEFIK CONFIGURATION' section in the `.env` file is filled in.
3. Then run the following command:
```bash
docker compose up -d
```
#### Compose with other addons
If you have other self-hosted addons, you'd like AIOStreams to use, fill them in in the `.env` file.
If you are looking for a more complete `compose.yaml` with more addons, you can use my template [here](https://github.com/Viren070/stremio-addons-docker-compose-template).
#### Docker CLI
You can use the prebuilt images using one of the following commands:
**GitHub Container Registry**:
```
docker run -p 8080:3000 ghcr.io/viren070/aiostreams:latest
```
**Docker Hub**:
```
docker run -p 8080:3000 viren070/aiostreams:latest
```
If you would like to pass one of the [environment variables](CONFIGURING.md), you can provide the -e flag, e.g. to provide a SECRET_KEY (recommended, see [CONFIGURING.md](CONFIGURING.md) for how to generate a secret key.):
```
docker run -p 8080:3000 -e SECRET_KEY=... viren070/aiostreams:latest
```
If you don't want to use a prebuilt image, or want to build from a commit that isn't tagged with a version yet, you can build the image yourself using the following commands:
```
git clone https://github.com/Viren070/aiostreams.git
cd aiostreams
docker build -t aiostreams .
docker run -p 8080:3000 aiostreams
```
### Other
This addon can be deployed using some free solutions, but these should not be considered permanent solutions and can stop working at any point.
- [Hugging Face](https://huggingface.co)
- [Koyeb](https://koyeb.com/)
- [Render](https://render.com)
### From source
You need Node.js and git installed. Node v22 and npm v10.9 were used in the development of this project. I can not guarantee earlier versions will work.
1. Clone the project and set it as the current directory
```
git clone https://github.com/Viren070/AIOStreams.git
```
```
cd aiostreams
```
2. Install project dependencies
```
npm i
```
3. Build project
```
npm run build
```
4. Run project
```
npm run start:addon
```
5. Go to `http://localhost:3000/configure`
You can change the `PORT` environment variable to change the port that the addon will listen on.
## Configuring
If you would like an explanation on the configuration options at the /configure page, have a look at this [guide for aiostreams](https://guides.viren070.me/stremio/addons/aiostreams) that I made.
Outside of the configuration page, the behaviour of this addon can also be changed with environment variables.
Most users don't need to set any environment variables. However, if you do, the SECRET_KEY is the one you might want to configure. This key enables encrypted manifest URLs, which help protect your API keys.
With encryption, someone who has your manifest URL can't directly see your API keys. However, they can still install the addon using the encrypted URL. Once installed, they can view API keys within other addons' URLs that are contained within AIOStreams' responses, as most addons don’t encrypt their manifest URLs.
### Environment Variables
Please see [CONFIGURING](CONFIGURING.md) and the [sample .env file](.env.sample) for a list of environment variables that can be set.
Below, you can find how to set environment variables for the different methods of deployment.
### Cloudflare Workers
Unfortunately, it is not currently possible to set environment variables for this addon on a Cloudflare Worker. You will have to modify the code directly. You can look in `packages/utils/src/settings.ts` to change the default values.
### Local
You can set environment variables using a .env file in the root of the project.
```
ADDON_NAME=AIOStreams
ADDON_ID=aiostreams.viren070.com
PORT=3000
SECRET_KEY=your_secret_key
COMET_URL=https://comet.elfhosted.com/
...
```
## Development
1. Clone the project and set it as the current directory
```
git clone https://github.com/Viren070/AIOStreams.git
```
```
cd aiostreams
```
2. Install project dependencies
```
npm i
```
Now, you can run various aspects of the project in development.
> [!NOTE]
> Most of these commands require that you build the project beforehand. Changes in other packages do not reflect immediately as it needs to be compiled into JavaScript first.
> Run `npm run build` to build the project.
To start the addon in development mode, run the following command:
```
npm run start:addon:dev
```
To run the cloudflare worker in development mode, run the following command
```
npm run start:cloudflare-worker:dev
```
To run the frontend of the project, run the following command
```
npm run start:frontend:dev
```
### Deploying
To deploy your cloudflare worker, run the following command:
```
npm run deploy:cloudflare-worker
```
Your support, whether through a star, contribution, or donation, helps keep the project alive and growing. ❤️
## Disclaimer
AIOStreams and its developer do not host, store, or distribute any content that is found using this addon. All content is sourced from publicly available addons. AIOStreams does not endorse or promote piracy in any form. It is the user's responsibility to ensure that their use of this addon is in compliance with their local laws and regulations.
AIOStreams and its developer do not host, store, or distribute any content. All content is sourced from the configured upstream addons. AIOStreams does not endorse or promote access to copyrighted content without authorisation. Users are responsible for ensuring they comply with all applicable laws and terms of service for the addons and content sources they use.
## Credits
- Thanks to [sleeyax/stremio-easynews-addon](https://github.com/Sleeyax/stremio-easynews-addon) for the repository structure and dockerfile.
- Thanks to all addon devs for creating the upstream addons that AIOStreams scrapes.
- [MediaFlow](https://github.com/Mhdzumair/mediaflow-proxy) for MediaFlow Proxy which is used in this addon to proxy your streams
- Issue templates were stolen from [5rahim/seanime](https://github.com/5rahim/seanime) (You should really try out this app)
- Thanks to [sleeyax/stremio-easynews-addon](https://github.com/Sleeyax/stremio-easynews-addon) for the repository structure and Dockerfile..
- Thanks to all the developers of the upstream addons that AIOStreams integrates.
- [MediaFlow](https://github.com/Mhdzumair/mediaflow-proxy) for the MediaFlow Proxy integration used in this addon.
- Issue templates adapted from [5rahim/seanime](https://github.com/5rahim/seanime).
- Custom formatter system inspired by and adapted from [diced/zipline](https://github.com/diced/zipline).