Свой сервер

Ядро на вашей машине

Ядро хранит хосты, ключи и сессии и держит соединения. Настольное приложение поднимает его внутри себя, но если серверов много или нужен доступ с телефона — разверните ядро отдельно.

Не хотите разворачивать своё

cloud

Подключитесь к официальному серверу

Открыт для проверки: вставьте ссылку ниже в Настройки → «Свой сервер» (или в профиль «Свой backend») — приложение само заведёт первого человека и запросит код подтверждения.

https://sputnik.madzhuga.com/?secret=0dab6989fa4b861b5e9e6892

Установка

Docker Compose — единственный способ на сегодня

# в каталоге с Dockerfile и docker-compose.yml проекта
echo "SHLUZ_SECRET=$(openssl rand -hex 12)" > .env
docker compose up -d --build
docker compose exec sputnik shluz-server user add ИМЯ

Слово из SHLUZ_SECRET годится на регистрацию с нового устройства один раз — дальше обычный вход. Если переменная пустая или не задана, регистрация закрыта, и людей заводит только хозяин сервера командой user add.

Переменные окружения

key

SHLUZ_SECRET

слово для регистрации с новых устройств; пусто — регистрация закрыта

dns

SHLUZ_ADDR

что слушать внутри контейнера, по умолчанию 0.0.0.0:8733

folder

SHLUZ_DATA

каталог с базой и мастер-ключом

description

SHLUZ_LOG

подробность журнала

Сервер не поднимает TLS сам. Если нужен HTTPS — поставьте перед ним свой обратный прокси (nginx, Caddy) и настройте сертификат там.

Первый вход и приглашения

looks_one

Получите слово для регистрации

Команда shluz-server secret ниже выводит слово, которое подходит на одну регистрацию нового человека.

looks_two

Соберите ссылку и отправьте её

Ссылка вида http://адрес:порт/?secret=СЛОВО — вставьте в неё свой адрес и порт сервера.

looks_3

Вставьте ссылку в приложении

Настройки → «Свой сервер» → поле «Адрес или ссылка-приглашение». Дальше клиент сам проведёт регистрацию, вход и, если он включён, запросит код подтверждения.

docker compose exec sputnik shluz-server secret
# слово для ссылки-приглашения; добавьте к своему адресу и порту:
# http://ваш-адрес:8733/?secret=СЛОВО

# кто уже заведён
docker compose exec sputnik shluz-server user list

Что важно знать

key

Ключи лежат на сервере с ядром

Хост берёт ключ по пути на той машине, где работает ядро. Если вы перенесли ядро на сервер, ключи должны быть там же, а не на ноутбуке.

lan

Туннели держит ядро

Правила проброса работают, пока работает сервер, — закрытое приложение их не роняет. Слушающий порт открывается на машине с ядром.

shield

Доступ наружу

Ядро — точка входа во всю вашу инфраструктуру. Держите его за TLS, ограничьте доступ по IP или спрячьте за VPN.

backup

Резервная копия

Всё состояние в каталоге /data. Скопировали каталог — перенесли ядро на другую машину.

warningНе выставляйте ядро в открытый интернет без нужды

Тот, кто получит доступ к ядру, получит доступ ко всем вашим серверам сразу. Если работаете один — оставьте локальное ядро в настольном приложении, этого достаточно.