mirror of
https://github.com/Radiquum/AniX.git
synced 2025-09-05 05:55:36 +05:00
111 lines
3.3 KiB
Markdown
111 lines
3.3 KiB
Markdown
# AniX - Player Parsers
|
|
|
|
This sub-project allows obtaining direct video file links from sources Sibnet, Kodik, Anilibria (source: libria)
|
|
|
|
It can be used both for the main AniX project and as a standalone service.
|
|
|
|
In the main project, the parsers are used to operate the internal player. If this function is not important to you, you may choose not to deploy this sub-service.
|
|
|
|
License: [MIT](../LICENSE)
|
|
|
|
## Usage
|
|
|
|
In the web browser address bar, enter:
|
|
|
|
`<http|https>://<ip|domain><:port>/?url=<VIDEO_URL>&player=<PLAYER_SOURCE>`
|
|
|
|
where:
|
|
|
|
- http|https - the scheme used to connect to the service
|
|
- ip|domain - IP address or domain where the service is hosted
|
|
- :port - service port, optional
|
|
- VIDEO_URL - the link to the video from the source
|
|
- PLAYER_SOURCE - the source, one of: kodik, sibnet, libria
|
|
|
|
Response:
|
|
|
|
- 500|400: an error occurred, see the `message` field in the response body for details
|
|
- 200: request was successful
|
|
|
|
## Deployment
|
|
|
|
> [!IMPORTANT]
|
|
> Due to the nature of the sources, it is recommended to use a virtual server in Russia, as they may be inaccessible from other countries.
|
|
>
|
|
> Because of this specificity, the parsers cannot be deployed on edge services like Cloudflare Workers or Deno, only on a dedicated server.
|
|
|
|
### Docker
|
|
|
|
Requirements:
|
|
|
|
- [docker](https://docs.docker.com/engine/install/)
|
|
|
|
### Pre-built
|
|
|
|
1. Run the command:
|
|
|
|
`docker run -d --name anix-player -p 7000:7000 radiquum/anix-player-parser:latest`
|
|
|
|
### Manual build
|
|
|
|
Additional Requirements:
|
|
|
|
- [git](https://git-scm.com/)
|
|
|
|
1. Clone the repository `git clone https://github.com/Radiquum/AniX`
|
|
2. Navigate to the repository directory `cd AniX`
|
|
3. Navigate to the parsers directory `cd player-parsers`
|
|
4. Run the command `docker build -t anix-player-parser .`
|
|
5. Once finished, run the command: `docker run -d --restart always --name anix-player -p 7000:7000 anix-player-parser`
|
|
|
|
### docker/Legend
|
|
|
|
- -d - run container in the background
|
|
- --restart always - always restart after server reboot
|
|
- --name - container name
|
|
- -p - container port accessible externally. PORT:7000
|
|
|
|
### docker/After deployment
|
|
|
|
The service will be available at: `http://<YOUR IP><:YOUR PORT>/`
|
|
|
|
### docker/Note
|
|
|
|
To use your own domain and support the HTTPS protocol, you can use Traefik or another reverse-proxy with an SSL certificate.
|
|
|
|
Useful links:
|
|
|
|
- [Docker run to docker compose syntax converter](https://it-tools.tech/docker-run-to-docker-compose-converter)
|
|
- [How to setup Traefik + custom domain + SSL](https://letmegooglethat.com/?q=how+to+setup+traefik+with+custom+domain+and+ssl+certificate+from+lets+encrypt%3F)
|
|
|
|
### pm2
|
|
|
|
Requirements:
|
|
|
|
- [git](https://git-scm.com/)
|
|
- [nodejs 23+ with npm](http://nodejs.org/)
|
|
- [pm2](https://pm2.keymetrics.io/)
|
|
|
|
Instructions:
|
|
|
|
1. Clone the repository `git clone https://github.com/Radiquum/AniX`
|
|
2. Navigate to the repository directory `cd AniX`
|
|
3. Navigate to the parsers directory `cd player-parsers`
|
|
4. Run the command `npm install`
|
|
5. Once finished, run the command `pm2 start index.ts -n anix-player-parser`
|
|
|
|
### pm2/Legend
|
|
|
|
- -n - service name in pm2
|
|
|
|
### pm2/After deployment
|
|
|
|
The service will be available at: `http://<YOUR IP>:7000/`
|
|
|
|
### pm2/Note
|
|
|
|
To enable automatic application start, it is recommended to configure pm2 to start on boot with the command: `pm2 startup`
|
|
|
|
Useful links:
|
|
|
|
- [PM2: smart approach to process management @ Habr](https://habr.com/ru/articles/480670/)
|