chore/docs/player-parsers: fix spelling in README

This commit is contained in:
Kentai Radiquum 2025-05-31 12:39:10 +05:00
parent 038122fc2a
commit be01230d0a
Signed by: Radiquum
GPG key ID: 858E8EE696525EED
2 changed files with 16 additions and 18 deletions

View file

@ -1,10 +1,10 @@
# AniX - Player Parsers # AniX - Player Parsers
Данный под-проект позволяет получить прямые ссылки на видеофайлы с источников Sibnet, Kodik, Libria Данный под-проект позволяет получить прямые ссылки на видеофайлы с источников Sibnet, Kodik, Anilibria (источник: libria)
Он может использоваться как для основного проекта AniX, так и как отдельный сервис. Он может использоваться как для основного проекта AniX, так и как отдельный сервис.
В основном проекте, парсеры используются для работы своего плеере, если вам не важна данная функция, вы можете не развёртывать данный суб-сервис. В основном проекте, парсеры используются для работы своего плеера, если вам не важна данная функция, вы можете не развёртывать данный суб-сервис.
Лицензия: [MIT](../LICENSE) Лицензия: [MIT](../LICENSE)
@ -22,7 +22,7 @@
- VIDEO_URL - ссылка на видео от источника - VIDEO_URL - ссылка на видео от источника
- PLAYER_SOURCE - источник, один из: kodik, sibnet, libria - PLAYER_SOURCE - источник, один из: kodik, sibnet, libria
>[!NOTE] > [!NOTE]
> Если используется источник libria, ссылка должна быть ссылкой на API anilibria, а не на плеер > Если используется источник libria, ссылка должна быть ссылкой на API anilibria, а не на плеер
Ответ: Ответ:
@ -32,9 +32,10 @@
## Развёртывание ## Развёртывание
> [!IMPORTANT]
> В связи с спецификой источников, рекомендуется использовать виртуальный сервер в россии, т.к. они могут быть недоступны из других стран. > В связи с спецификой источников, рекомендуется использовать виртуальный сервер в россии, т.к. они могут быть недоступны из других стран.
> >
> Из-за данной специфики, парсеры невозможно развернуть на edge сервисах, таких как CloudFlare Workers или Deno, а только на отдельном сервере. > Из-за данной специфики, парсеры невозможно развернуть на edge сервисах, таких как Cloudflare Workers или Deno, а только на отдельном сервере.
### Docker ### Docker
@ -44,7 +45,7 @@
### Пре-билд ### Пре-билд
1. выполните комманду: 1. выполните команду:
`docker run -d --name anix-player -p 7000:7000 radiquum/anix-player-parser:latest` `docker run -d --name anix-player -p 7000:7000 radiquum/anix-player-parser:latest`
@ -65,7 +66,7 @@
- -d - запустить контейнер в фоне - -d - запустить контейнер в фоне
- --restart always - всегда запускать после перезагрузки сервера - --restart always - всегда запускать после перезагрузки сервера
- --name - название контейнера - --name - название контейнера
- -p - порт контейнера который будет доступен из вне. ПОРТ:7000 - -p - порт контейнера который будет доступен извне. ПОРТ:7000
### docker/После развёртывания ### docker/После развёртывания
@ -73,14 +74,12 @@
### docker/Примечание ### docker/Примечание
Для использования своего домена и поддержки протокола https, вы можете использовать traefik или другой reverse-proxy, с сертификатом SSL. Для использования своего домена и поддержки протокола HTTPS, вы можете использовать Traefik или другой reverse-proxy, с сертификатом SSL.
Полезные ссылки: Полезные ссылки:
- [Конвертер из команды docker run в синтакс для docker compose](https://it-tools.tech/docker-run-to-docker-compose-converter) - [Конвертер из команды docker run в синтакс для docker compose](https://it-tools.tech/docker-run-to-docker-compose-converter)
- [Как настроить traefik + свой домен + SSL](https://letmegooglethat.com/?q=how+to+setup+traefik+with+custom+domain+and+ssl+certificate+from+lets+encrypt%3F) - [Как настроить Traefik + свой домен + SSL](https://letmegooglethat.com/?q=how+to+setup+traefik+with+custom+domain+and+ssl+certificate+from+lets+encrypt%3F)
</details>
### pm2 ### pm2
@ -96,7 +95,7 @@
2. Переместитесь в директорию репозитория `cd AniX` 2. Переместитесь в директорию репозитория `cd AniX`
3. Переместитесь в директорию парсеров `cd player-parsers` 3. Переместитесь в директорию парсеров `cd player-parsers`
4. Выполните команду `npm install` 4. Выполните команду `npm install`
5. После окончания, Выполните команду `pm2 start index.ts -n anix-player-parser` 5. После окончания и выполните команду `pm2 start index.ts -n anix-player-parser`
### pm2/Обозначения ### pm2/Обозначения

View file

@ -32,9 +32,10 @@ Response:
## Deployment ## 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. > 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. > Because of this specificity, the parsers cannot be deployed on edge services like Cloudflare Workers or Deno, only on a dedicated server.
### Docker ### Docker
@ -62,7 +63,7 @@ Additional Requirements:
### docker/Legend ### docker/Legend
- -d - run the container in background - -d - run container in the background
- --restart always - always restart after server reboot - --restart always - always restart after server reboot
- --name - container name - --name - container name
- -p - container port accessible externally. PORT:7000 - -p - container port accessible externally. PORT:7000
@ -73,14 +74,12 @@ The service will be available at: `http://<YOUR IP><:YOUR PORT>/`
### docker/Note ### docker/Note
To use your own domain and support the https protocol, you can use traefik or another reverse-proxy with an SSL certificate. To use your own domain and support the HTTPS protocol, you can use Traefik or another reverse-proxy with an SSL certificate.
Useful links: Useful links:
- [Docker run to docker compose syntax converter](https://it-tools.tech/docker-run-to-docker-compose-converter) - [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) - [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)
</details>
### pm2 ### pm2
@ -96,7 +95,7 @@ Instructions:
2. Navigate to the repository directory `cd AniX` 2. Navigate to the repository directory `cd AniX`
3. Navigate to the parsers directory `cd player-parsers` 3. Navigate to the parsers directory `cd player-parsers`
4. Run the command `npm install` 4. Run the command `npm install`
5. Once finished, Run the command `pm2 start index.ts -n anix-player-parser` 5. Once finished, run the command `pm2 start index.ts -n anix-player-parser`
### pm2/Legend ### pm2/Legend