diff --git a/DEPLOYMENT.RU.md b/DEPLOYMENT.RU.md index 076a2f5..d7114be 100644 --- a/DEPLOYMENT.RU.md +++ b/DEPLOYMENT.RU.md @@ -7,16 +7,16 @@ - аккаунт GitHub - аккаунт Vercel -1. сделайте форк репозитория +1. Создайте форк репозитория ![fork button](./docs/deploy/fork.png) -2. Войдите в аккаунт vercel +2. Войдите в аккаунт Vercel > [!IMPORTANT] - >Аккаунт Vercel должен быть связан с аккаунтом Github. + > Аккаунт Vercel должен быть связан с аккаунтом GitHub. > - >Если у вас нет аккаунта vercel, то создайте его через вход с помощью Github. + > Если у вас нет аккаунта Vercel, то создайте его через вход с помощью GitHub. 3. Нажмите кнопку создать новый проект @@ -26,7 +26,7 @@ ![vercel import button](./docs/deploy/vercel_import.png) -5. (опционально) добавьте переменные для использования своего плеере: +5. (опционально) добавьте переменные для использования своего плеера: - NEXT_PUBLIC_KODIK_PARSER_URL - NEXT_PUBLIC_ANILIBRIA_PARSER_URL @@ -36,9 +36,9 @@ ![vercel project settings](./docs/deploy/vercel_project.png) -6. нажмите кнопку "Deploy" и ожидайте пока не появиться подтверждение +6. нажмите кнопку "Deploy" и ожидайте пока не появится подтверждение 7. нажмите кнопку "Continue to Dashboard" -8. клиент будет доступен по ссылке такого вида, нажмите на неё что-бы его открыть +8. клиент будет доступен по ссылке такого вида, нажмите на неё чтобы его открыть ![vercel project url](./docs/deploy/vercel_url.png) ## Netlify @@ -48,16 +48,16 @@ - аккаунт GitHub - аккаунт Netlify -1. сделайте форк репозитория +1. Создайте форк репозитория ![fork button](./docs/deploy/fork.png) -2. Войдите в аккаунт netlify +2. Войдите в аккаунт Netlify > [!IMPORTANT] - >Аккаунт Netlify должен быть связан с аккаунтом Github. + > Аккаунт Netlify должен быть связан с аккаунтом GitHub. > - >Если у вас нет аккаунта Netlify, то создайте его через вход с помощью Github. + > Если у вас нет аккаунта Netlify, то создайте его через вход с помощью GitHub. 3. Нажмите кнопку создать новый проект @@ -75,7 +75,7 @@ ![netlify project name](./docs/deploy/netlify_project_name.png) -7. (опционально) добавьте переменные для использования своего плеере: +7. (опционально) добавьте переменные для использования своего плеера: - NEXT_PUBLIC_KODIK_PARSER_URL - NEXT_PUBLIC_ANILIBRIA_PARSER_URL @@ -87,9 +87,9 @@ 2. ![alt text](./docs/deploy/netlify_env_2.png) -8. нажмите кнопку "Deploy" и ожидайте пока не появиться подтверждение +8. нажмите кнопку "Deploy" и ожидайте пока не появится подтверждение -9. клиент будет доступен по ссылке такого вида, нажмите на неё что-бы его открыть +9. клиент будет доступен по ссылке такого вида, нажмите на неё чтобы его открыть ![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` @@ -121,9 +121,9 @@ - -d - запустить контейнер в фоне - --restart always - всегда запускать после перезагрузки сервера - --name - название контейнера -- -p - порт контейнера который будет доступен из вне. ПОРТ:3000 +- -p - порт контейнера который будет доступен извне. ПОРТ:3000 ->[!NOTE] +> [!NOTE] > для переменных которые вы получили, если развёртывали [anix-player-parsers](./player-parsers/README.RU.md), необходимо использовать `-e ПЕРЕМЕННАЯ=ЗНАЧЕНИЕ` до слова anix [команда docker run](https://docs.docker.com/reference/cli/docker/container/run/) @@ -134,12 +134,12 @@ ### 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) -- [Как настроить 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 @@ -156,11 +156,11 @@ 3. Выполните команду `npm install` 4. (опционально) скопируйте .env.sample как .env и заполните его переменными которые вы получили, если развёртывали [anix-player-parsers](./player-parsers/README.RU.md) 5. Выполните команду `npm run build` -6. создайте новую директорию -7. переместите в созданную директорию - - директорию `public` в `./новая/public` - - директорию `.next/static` в `./новая/.next/static` - - файлы из `.next/standalone` в `./новая` +6. создайте новую директорию (далее будем использовать `<имя_новой_директории>` как её имя) +7. переместите в созданную директорию (`<имя_новой_директории>`) + - директорию `public` в `<имя_новой_директории>/public` + - директорию `.next/static` в `<имя_новой_директории>/.next/static` + - файлы из `.next/standalone` в `<имя_новой_директории>` 8. Переместитесь в созданную директорию и выполните команду `pm2 start server.js -n anix` ### pm2/Обозначения diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md index bbc8a74..46f5a97 100644 --- a/DEPLOYMENT.md +++ b/DEPLOYMENT.md @@ -14,9 +14,9 @@ Requirements: 2. Log in to your Vercel account > [!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 @@ -36,9 +36,9 @@ Requirements: ![vercel project settings](./docs/deploy/vercel_project.png) -6. Click the "Deploy" button and wait until you see a confirmation -7. Click the "Continue to Dashboard" button -8. The client will be available at a link of this form, click it to open +6. Click the "Deploy" button and wait until you see a confirmation +7. Click the "Continue to Dashboard" button +8. The client will be available at a link of this form, click it to open ![vercel project url](./docs/deploy/vercel_url.png) ## Netlify @@ -55,9 +55,9 @@ Requirements: 2. Log in to your Netlify account > [!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 @@ -118,12 +118,12 @@ Additional Requirements: ### docker/Flags -- -d - run container in background +- -d - run container in the background - --restart always - always restart after server reboot - --name - container name - -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 [docker run command](https://docs.docker.com/reference/cli/docker/container/run/) @@ -134,12 +134,12 @@ The service will be available at: `http://<:YOUR PORT>/` ### 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: - [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 @@ -156,12 +156,12 @@ Instructions: 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) 5. Run the command `npm run build` -6. Create a new directory -7. Move into the new directory: - - move `public` directory to `./new/public` - - move `.next/static` directory to `./new/.next/static` - - move files from `.next/standalone` to `./new` -8. Move into the created directory and run the command `pm2 start server.js -n anix` +6. Create a new directory (next we will be refer to its name as ``) +7. Move the following files into the new directory (``): + - move `public` directory to `/public` + - move `.next/static` directory to `/.next/static` + - move files from `.next/standalone` to `` +8. Move into the created directory () and run the command `pm2 start server.js -n anix` ### pm2/Flags