From a111ffadbf374793719beb727d6965a17b19f5a5 Mon Sep 17 00:00:00 2001 From: Allastor Date: Mon, 29 Apr 2024 07:22:56 +0000 Subject: [PATCH] update README.md to include russian translation Reviewed-on: https://dev.sp-tarkov.com/Cbr/spt-docker/pulls/1 Reviewed-by: Cbr Co-authored-by: Allastor Co-committed-by: Allastor --- README.md | 31 +++++++++++++++---------------- README.ru | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 16 deletions(-) create mode 100644 README.ru diff --git a/README.md b/README.md index 412fc95..8df9bba 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,13 @@ # single-player-tarkov-docker Private Dockerfile to build a docker container for Single-Player-Tarkov -# Dependencies +[README на Русском языке](https://dev.sp-tarkov.com/Allastor/spt-docker/src/branch/main/README.ru) -None +## Requirements -Note: SPT-AKI does not work as a subtree (can be used as a .gitmodule) because of lfs. I've decided to pull in the image (with a builder) instead of forking / adding the submodule to this repo, as it is standarized in Dockerfiles as per 2024-04 +Debian or another Linux distr\ +Docker\ +git [LFS](https://git-lfs.github.com/) # Docker Support @@ -32,22 +34,19 @@ The way SPT is organizing their release is by tags on release branches. 3.8.0 w Note: It can be a good idea to evolve the Dockerfile to include SPT_VERSION for the branch and always use latest tag) ```bash -docker build -t cbr/spt:latest -t cbr/spt:your-tag-version-here +git clone https://dev.sp-tarkov.com/Cbr/spt-docker.git +cd spt-docker +docker buildx build -f Dockerfile -t cbr/spt:latest ./ ``` ---- +# Running - -# Old Documentation - -Some old documentation if moving to local submodule is desired -## Add a submodule for SPT-Aki ```bash -git submodule add https://dev.sp-tarkov.com/SPT-AKI/Server.git SPT-Server +mkdir /opt/spt-aki && mkdir /opt/spt-aki/Server && mkdir /opt/spt-aki/user +docker run --name spt-aki -v /opt/spt-aki/Server:/app/Aki_Data/Server -v /opt/spt-aki/user:/app/user -e SPT_LOG_REQUESTS=false -e SPT_BACKEND_IP='External ip' -p 6969:6969 cbr/spt:latest -d ``` -## Retrieve after adding -```bash -git submodule update --init --recursive -``` -Note: Needs LFS! + +Where "External IP" - this is the IP address you need - your external IP, local host IP address or received in the VPN network. + +--- \ No newline at end of file diff --git a/README.ru b/README.ru new file mode 100644 index 0000000..8e0fc4b --- /dev/null +++ b/README.ru @@ -0,0 +1,51 @@ +# SPT-AKI docker +Частный Dockerfile для создания докер-контейнера SPT-AKI + +## Требования + +Debian или другой Linux дистрибутив\ +Docker\ +git [LFS](https://git-lfs.github.com/) + +# Поддержка Docker + +## Разделы +Добавлено два раздела: +- `/app/Aki_Data/Server` Содержит стандартные для `SPT-Aki.Server` базу данных и конфигурационные файлы. К примеру - `http.json` или `profiles.json` . + Контейнер скопирует стандартные файлы для Aki Server в этот раздел если он пуст (к примеру первый запуск контейнера)\ + +- `/app/user` Содержит стандартные серверные конфигурации (будут созданы при первой авторизации) + - `./profiles` содержит созданные профили игроков + - `./mods` установленные серверные моды находятся здесь + - `./logs` логи сервера появятся здесь + +## Переменные среды +- `SPT_LOG_REQUESTS` при значении false, выключает логирование запросов к SPT-AKI +- `SPT_BACKEND_IP` ручное указание внешнего IP адреса в `http.conf` как `backendIp` параметр + +Не стесняйтесь экспериментировать с различными настройками и конфигурациями. + +# Как собрать + +Обновите ARG `SPT_VERSION` в Dockerfile файле на нужный тег +Вы можете ознакомиться с версиями тегов в репозитории [SPT-AKI/Server](https://dev.sp-tarkov.com/SPT-AKI/Server/src/branch/master) +SPT организует свой выпуск с помощью тегов в ветках выпуска. 3.8.0 не был выпущен как тег `master`, как это было сделано раньше. +Примечание: Было бы замечательно развивать Dockerfile включить SPT_VERSION для ветки и всегда использовать latest тег) + +```bash +git clone https://dev.sp-tarkov.com/Cbr/spt-docker.git +cd spt-docker +docker buildx build -f Dockerfile -t cbr/spt:latest ./ +``` + +# Running + +```bash +mkdir /opt/spt-aki && mkdir /opt/spt-aki/Server && mkdir /opt/spt-aki/user +docker run --name spt-aki -v /opt/spt-aki/Server:/app/Aki_Data/Server -v /opt/spt-aki/user:/app/user -e SPT_LOG_REQUESTS=false -e SPT_BACKEND_IP='External IP' -p 6969:6969 cbr/spt:latest -d +``` + +Где External IP - это нужный вам IP адрес - ваш внешний IP, IP адрес локального хоста или полученный в VPN сети. + +--- +