Radiquum/AniX
1
0
Fork 0
mirror of https://github.com/Radiquum/AniX.git synced 2025-09-03 21:15:35 +05:00
Code Issues Projects Releases Packages Activity

chore/docs: fix spelling in DEPLOYMENT

Browse source
This commit is contained in:
Kentai Radiquum 2025-05-31 12:34:23 +05:00
parent 3c5ec6c39f
commit 038122fc2a
Signed by: Radiquum
GPG key ID: 858E8EE696525EED
2 changed files with 41 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

48
DEPLOYMENT.RU.md
View file

@ -7,16 +7,16 @@
- аккаунт GitHub - аккаунт GitHub
- аккаунт Vercel - аккаунт Vercel
1. сделайте форк репозитория 1. Создайте форк репозитория
![fork button](./docs/deploy/fork.png) ![fork button](./docs/deploy/fork.png)
2. Войдите в аккаунт vercel 2. Войдите в аккаунт Vercel
> [!IMPORTANT] > [!IMPORTANT]
>Аккаунт Vercel должен быть связан с аккаунтом Github. > Аккаунт Vercel должен быть связан с аккаунтом GitHub.
> >
>Если у вас нет аккаунта vercel, то создайте его через вход с помощью Github. > Если у вас нет аккаунта Vercel, то создайте его через вход с помощью GitHub.
3. Нажмите кнопку создать новый проект 3. Нажмите кнопку создать новый проект
@ -26,7 +26,7 @@
![vercel import button](./docs/deploy/vercel_import.png) ![vercel import button](./docs/deploy/vercel_import.png)
5. (опционально) добавьте переменные для использования своего плеере: 5. (опционально) добавьте переменные для использования своего плеера:
- NEXT_PUBLIC_KODIK_PARSER_URL - NEXT_PUBLIC_KODIK_PARSER_URL
- NEXT_PUBLIC_ANILIBRIA_PARSER_URL - NEXT_PUBLIC_ANILIBRIA_PARSER_URL
@ -36,9 +36,9 @@
![vercel project settings](./docs/deploy/vercel_project.png) ![vercel project settings](./docs/deploy/vercel_project.png)
6. нажмите кнопку "Deploy" и ожидайте пока не появиться подтверждение 6. нажмите кнопку "Deploy" и ожидайте пока не появится подтверждение
7. нажмите кнопку "Continue to Dashboard" 7. нажмите кнопку "Continue to Dashboard"
8. клиент будет доступен по ссылке такого вида, нажмите на неё что-бы его открыть 8. клиент будет доступен по ссылке такого вида, нажмите на неё чтобы его открыть
![vercel project url](./docs/deploy/vercel_url.png) ![vercel project url](./docs/deploy/vercel_url.png)
## Netlify ## Netlify
@ -48,16 +48,16 @@
- аккаунт GitHub - аккаунт GitHub
- аккаунт Netlify - аккаунт Netlify
1. сделайте форк репозитория 1. Создайте форк репозитория
![fork button](./docs/deploy/fork.png) ![fork button](./docs/deploy/fork.png)
2. Войдите в аккаунт netlify 2. Войдите в аккаунт Netlify
> [!IMPORTANT] > [!IMPORTANT]
>Аккаунт Netlify должен быть связан с аккаунтом Github. > Аккаунт Netlify должен быть связан с аккаунтом GitHub.
> >
>Если у вас нет аккаунта Netlify, то создайте его через вход с помощью Github. > Если у вас нет аккаунта Netlify, то создайте его через вход с помощью GitHub.
3. Нажмите кнопку создать новый проект 3. Нажмите кнопку создать новый проект
@ -75,7 +75,7 @@
![netlify project name](./docs/deploy/netlify_project_name.png) ![netlify project name](./docs/deploy/netlify_project_name.png)
7. (опционально) добавьте переменные для использования своего плеере: 7. (опционально) добавьте переменные для использования своего плеера:
- NEXT_PUBLIC_KODIK_PARSER_URL - NEXT_PUBLIC_KODIK_PARSER_URL
- NEXT_PUBLIC_ANILIBRIA_PARSER_URL - NEXT_PUBLIC_ANILIBRIA_PARSER_URL
@ -87,9 +87,9 @@
2. ![alt text](./docs/deploy/netlify_env_2.png) 2. ![alt text](./docs/deploy/netlify_env_2.png)
8. нажмите кнопку "Deploy" и ожидайте пока не появиться подтверждение 8. нажмите кнопку "Deploy" и ожидайте пока не появится подтверждение
9. клиент будет доступен по ссылке такого вида, нажмите на неё что-бы его открыть 9. клиент будет доступен по ссылке такого вида, нажмите на неё чтобы его открыть
![netlify project url](./docs/deploy/netlify_url.png) ![netlify project url](./docs/deploy/netlify_url.png)
@ -101,7 +101,7 @@
### Пре-билд ### Пре-билд
1. выполните комманду: 1. выполните команду:
`docker run -d --name anix -p 3000:3000 radiquum/anix:latest` `docker run -d --name anix -p 3000:3000 radiquum/anix:latest`
@ -121,9 +121,9 @@
- -d - запустить контейнер в фоне - -d - запустить контейнер в фоне
- --restart always - всегда запускать после перезагрузки сервера - --restart always - всегда запускать после перезагрузки сервера
- --name - название контейнера - --name - название контейнера
- -p - порт контейнера который будет доступен из вне. ПОРТ:3000 - -p - порт контейнера который будет доступен извне. ПОРТ:3000
>[!NOTE] > [!NOTE]
> для переменных которые вы получили, если развёртывали [anix-player-parsers](./player-parsers/README.RU.md), необходимо использовать `-e ПЕРЕМЕННАЯ=ЗНАЧЕНИЕ` до слова anix > для переменных которые вы получили, если развёртывали [anix-player-parsers](./player-parsers/README.RU.md), необходимо использовать `-e ПЕРЕМЕННАЯ=ЗНАЧЕНИЕ` до слова anix
[команда docker run](https://docs.docker.com/reference/cli/docker/container/run/) [команда docker run](https://docs.docker.com/reference/cli/docker/container/run/)
@ -134,12 +134,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)
## pm2 ## pm2
@ -156,11 +156,11 @@
3. Выполните команду `npm install` 3. Выполните команду `npm install`
4. (опционально) скопируйте .env.sample как .env и заполните его переменными которые вы получили, если развёртывали [anix-player-parsers](./player-parsers/README.RU.md) 4. (опционально) скопируйте .env.sample как .env и заполните его переменными которые вы получили, если развёртывали [anix-player-parsers](./player-parsers/README.RU.md)
5. Выполните команду `npm run build` 5. Выполните команду `npm run build`
6. создайте новую директорию 6. создайте новую директорию (далее будем использовать `<имя_новой_директории>` как её имя)
7. переместите в созданную директорию 7. переместите в созданную директорию (`<имя_новой_директории>`)
- директорию `public` в `./новая/public` - директорию `public` в `<имя_новой_директории>/public`
- директорию `.next/static` в `./новая/.next/static` - директорию `.next/static` в `<имя_новой_директории>/.next/static`
- файлы из `.next/standalone` в `./новая` - файлы из `.next/standalone` в `<имя_новой_директории>`
8. Переместитесь в созданную директорию и выполните команду `pm2 start server.js -n anix` 8. Переместитесь в созданную директорию и выполните команду `pm2 start server.js -n anix`
### pm2/Обозначения ### pm2/Обозначения

34
DEPLOYMENT.md
View file

@ -14,9 +14,9 @@ Requirements:
2. Log in to your Vercel account 2. Log in to your Vercel account
> [!IMPORTANT] > [!IMPORTANT]
>Your Vercel account must be linked with your GitHub account. > Your Vercel account must be linked with your GitHub account.
> >
>If you don't have a Vercel account, create one by signing in with GitHub. > If you don't have a Vercel account, create one by signing in with GitHub.
3. Click the button to create a new project 3. Click the button to create a new project
@ -36,9 +36,9 @@ Requirements:
![vercel project settings](./docs/deploy/vercel_project.png) ![vercel project settings](./docs/deploy/vercel_project.png)
6. Click the "Deploy" button and wait until you see a confirmation 6. Click the "Deploy" button and wait until you see a confirmation
7. Click the "Continue to Dashboard" button 7. Click the "Continue to Dashboard" button
8. The client will be available at a link of this form, click it to open 8. The client will be available at a link of this form, click it to open
![vercel project url](./docs/deploy/vercel_url.png) ![vercel project url](./docs/deploy/vercel_url.png)
## Netlify ## Netlify
@ -55,9 +55,9 @@ Requirements:
2. Log in to your Netlify account 2. Log in to your Netlify account
> [!IMPORTANT] > [!IMPORTANT]
>Your Netlify account must be linked with your GitHub account. > Your Netlify account must be linked with your GitHub account.
> >
>If you don't have a Netlify account, create one by signing in with GitHub. > If you don't have a Netlify account, create one by signing in with GitHub.
3. Click the button to create a new project 3. Click the button to create a new project
@ -118,12 +118,12 @@ Additional Requirements:
### docker/Flags ### docker/Flags
- -d - run 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 to be exposed externally. PORT:3000 - -p - container port to be exposed externally. PORT:3000
>[!NOTE] > [!NOTE]
> For variables you received if you deployed [anix-player-parsers](./player-parsers/README.md), you need to use `-e VARIABLE=VALUE` before the word anix > For variables you received if you deployed [anix-player-parsers](./player-parsers/README.md), you need to use `-e VARIABLE=VALUE` before the word anix
[docker run command](https://docs.docker.com/reference/cli/docker/container/run/) [docker run command](https://docs.docker.com/reference/cli/docker/container/run/)
@ -134,12 +134,12 @@ The service will be available at: `http://<YOUR IP><:YOUR PORT>/`
### docker/Note ### docker/Note
To use your own domain and support HTTPS protocol, you can use traefik or another reverse proxy with SSL certificate. To use your own domain and support HTTPS protocol, you can use Traefik or another reverse proxy with SSL certificate.
Useful links: Useful links:
- [Converter from docker run command to docker compose syntax](https://it-tools.tech/docker-run-to-docker-compose-converter) - [Converter from docker run command to docker compose syntax](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)
## pm2 ## pm2
@ -156,12 +156,12 @@ Instructions:
3. Run the command `npm install` 3. Run the command `npm install`
4. (optional) copy `.env.sample` as `.env` and fill it with variables you received if you deployed [anix-player-parsers](./player-parsers/README.md) 4. (optional) copy `.env.sample` as `.env` and fill it with variables you received if you deployed [anix-player-parsers](./player-parsers/README.md)
5. Run the command `npm run build` 5. Run the command `npm run build`
6. Create a new directory 6. Create a new directory (next we will be refer to its name as `<new_dir>`)
7. Move into the new directory: 7. Move the following files into the new directory (`<new_dir>`):
- move `public` directory to `./new/public` - move `public` directory to `<new_dir>/public`
- move `.next/static` directory to `./new/.next/static` - move `.next/static` directory to `<new_dir>/.next/static`
- move files from `.next/standalone` to `./new` - move files from `.next/standalone` to `<new_dir>`
8. Move into the created directory and run the command `pm2 start server.js -n anix` 8. Move into the created directory (<new_dir>) and run the command `pm2 start server.js -n anix`
### pm2/Flags ### pm2/Flags