Team server

Командна робота в ShardBrowser через власний тім-сервер

Тім-сервер дає змогу кільком людям працювати зі спільними профілями ShardBrowser. Сервер ви запускаєте самі, наприклад на VPS: профілі команди зберігаються на ньому, а лаунчери учасників підключаються до сервера за інвайтом. Адміністратор сам вирішує, які папки й дії доступні кожному учаснику.

Що знадобиться

  • ShardBrowser версії 2.1.2 або новішої на комп'ютерах усіх учасників.
  • Сервер, до якого учасники можуть підключитися через мережу, наприклад VPS на Ubuntu з доступом по SSH під root або користувачем із sudo.
  • Відкритий вхідний порт 8787 (TCP) на сервері.

Створення команди в ShardBrowser

У лівому нижньому куті натисніть на перемикач робочого простору Personal і виберіть Create a team....

Меню робочого простору - «Create a team...»
Меню робочого простору - «Create a team...»

Відкриється вікно Create a team. У полі Team name вкажіть назву команди. Сервер читає її лише під час першого запуску, пізніше команду можна перейменувати на її сторінці.

Вікно Create a team - вкажіть назву команди
Вікно Create a team - вкажіть назву команди

Не закривайте це вікно: команда для запуску сервера й поля для підключення знадобляться далі.


Встановлення Docker і тім-сервера на VPS

Підключіться до сервера по SSH і встановіть Docker офіційним скриптом:

curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh

Скрипт сам додасть репозиторій Docker, встановить пакети й запустить службу. Наприкінці він виведе версії клієнта й сервера Docker Engine.

Встановлення Docker скриптом get-docker.sh
Встановлення Docker скриптом get-docker.sh

Якщо наприкінці з'явилося повідомлення про rootless-режим і доступ до Docker API, це звичайна довідка від інсталятора. Для тім-сервера нічого додатково налаштовувати не потрібно.

Довідка інсталятора Docker наприкінці встановлення
Довідка інсталятора Docker наприкінці встановлення

Поверніться до ShardBrowser. На вкладці Docker вікна Create a team уже готова команда запуску сервера з назвою вашої команди. Скопіюйте її кнопкою праворуч від поля.

Скопіюйте команду запуску на вкладці Docker
Скопіюйте команду запуску на вкладці Docker

SHARDBROWSER_TEAM_BIND за замовчуванням дорівнює 127.0.0.1:8787, і тоді до сервера можна підключитися лише з цієї ж машини. Щоб підключалися інші учасники, залиште в команді 0.0.0.0:8787.

SHARDBROWSER_TEAM_DATA_DIR - папка з даними команди та її ключем. Робіть резервну копію всієї папки повністю.

На сервері увімкніть автозапуск Docker, перевірте встановлення й виконайте скопійовану команду:

sudo systemctl enable docker
sudo systemctl start docker
sudo usermod -aG docker $USER
docker --version
docker compose version
docker run -d --name shardbrowser-team --restart unless-stopped -p 8787:8787 -v shardbrowser-team:/data -e SHARDBROWSER_TEAM_NAME='ShardX team' -e SHARDBROWSER_TEAM_BIND=0.0.0.0:8787 -e SHARDBROWSER_TEAM_DATA_DIR=/data ghcr.io/proxyshard/shardbrowser-team-server:latest

Замість ShardX team у команді буде назва, яку ви вказали. Docker завантажить образ shardbrowser-team-server і запустить контейнер shardbrowser-team. Завдяки --restart unless-stopped сервер сам підніметься після перезавантаження VPS.

Запуск контейнера тім-сервера
Запуск контейнера тім-сервера

Під час першого запуску сервер один раз виводить у лог токен адміністратора. Перегляньте його командою:

docker logs shardbrowser-team

Скопіюйте значення admin token. У лозі також є invite (посилання з тим самим токеном, замість 0.0.0.0 підставте адресу сервера) і public key, за яким лаунчери перевіряють сервер.

Токен адміністратора в лозі контейнера
Токен адміністратора в лозі контейнера

Токен адміністратора показується лише під час першого запуску й дає повний доступ до команди. Збережіть його в надійному місці й нікому не передавайте. Якщо токен втрачено, команда shardbrowser-team-server --print-invite виведе новий.


Підключення до команди як адміністратор

У вікні Create a team, у блоці Join as the team's admin, заповніть поля:

  • Server address - IP-адреса сервера й порт, наприклад 203.0.113.5:8787 або http://203.0.113.5:8787. Домен і сертифікат не потрібні: лаунчер сам шифрує з'єднання.
  • Admin token - токен із логу контейнера.

Натисніть Join as admin.

Вкажіть адресу сервера й токен адміністратора
Вкажіть адресу сервера й токен адміністратора

Відкриється сторінка команди. У перемикачі ліворуч унизу тепер вибрана ваша команда. Профілі, створені в цьому режимі, зберігаються на тім-сервері. Блок Getting the team going підказує порядок дій: створити папки, створити профілі, додати учасників і видати їм права.

Сторінка нової команди
Сторінка нової команди

Додавання учасника

Натисніть + Add member.

Кнопка Add member
Кнопка Add member

Вкажіть ім'я учасника й натисніть Add member.

Ім'я нового учасника
Ім'я нового учасника

З'явиться інвайт для учасника. Скопіюйте його й надішліть учаснику: він вставить його у вікні Join a team. Інвайт показується лише один раз, новий можна створити через New invite... у меню учасника.

Поки в учасника немає прав, команда для нього порожня. Натисніть Set rights..., щоб одразу видати доступ.

Інвайт для учасника й кнопка Set rights
Інвайт для учасника й кнопка Set rights

Права учасника

У вікні Rights права задаються в таблиці. Натисніть на клітинку (або клавішу Space), щоб перемкнути її: не задано, дозволено (галочка) або заборонено (хрестик). Якщо правила перетинаються, діє найвужче.

ПравоЩо дозволяє
SeeБачити профілі
StartЗапускати профілі
EditЗмінювати профілі
CreateСтворювати профілі
DeleteВидаляти профілі
CookiesПрацювати з cookies профілів
Take outВиносити профілі з команди

Для швидкого налаштування рядка Whole team є готові набори: None, See only, Start, Edit і All but take out. Права також можна задати окремо для кожної папки команди. Натисніть Save rights.

Права учасника на всю команду
Права учасника на всю команду

Право без See не працює: учасник не зможе запустити або змінити профіль, якого не бачить.

Видані права відображаються в колонці Access. У меню учасника (⋮) можна змінити права (Rights...), тимчасово вимкнути учасника (Switch off), створити новий інвайт (New invite...) або видалити учасника з команди (Remove...).

Меню учасника
Меню учасника

Папки й профілі команди

Папки команди створюються кнопкою + New folder на сторінці команди й з'являються в бічному меню, як звичайні папки. Новий профіль потрапляє в папку, вказану в його полі Folder.

Перемикач робочого простору ліворуч унизу показує, де ви зараз працюєте: у Personal (локальні профілі) або в команді, поруч із якою вказано адресу її сервера. З цього меню адміністратор відкриває сторінку команди (Manage team), а також може підключитися до іншої команди, створити нову або вийти з поточної (Leave this team...).

Папки команди й меню Manage team
Папки команди й меню Manage team

Підключення учасника до команди

Учасник відкриває ShardBrowser, натискає на перемикач Personal і вибирає Join a team....

Меню робочого простору - «Join a team...»
Меню робочого простору - «Join a team...»

У вікні Join a team потрібно вставити інвайт, отриманий від адміністратора, у поле Invite or server address. Адреса сервера й Access token заповняться самі. Потім натисніть Join.

Вставте інвайт у вікні Join a team
Вставте інвайт у вікні Join a team

Після підключення в меню перемикача в учасника з'являється пункт Your access. Він показує, які права видав адміністратор. Змінити їх може лише адміністратор.

Права учасника в розділі Your access
Права учасника в розділі Your access

У розділі All profiles учасник бачить профілі команди з доступних йому папок і працює з ними в межах виданих прав. Щоб повернутися до локальних профілів, виберіть Personal у перемикачі.

Профілі команди в учасника
Профілі команди в учасника

Оновлено

На цій сторінці