Перейти до вмісту

Ви переглядаєте попередню версію сайту документаціїВміст тут призначений для тестування й може відрізнятися від актуальної документації.

Перейти до актуальної документації

Огляд самостійного розгортання

Запустіть власний екземпляр — і кожна таємниця, обліковий запис і рядок журналу залишаться на інфраструктурі, яку контролюєте ви. Ви вирішуєте, як автентифікуються облікові записи, чи доступний екземпляр із публічного інтернету взагалі та яке брендування має інтерфейс.

Режим визначає, що ще має працювати, тож визначтеся з ним до встановлення.

simple — типовий режим, із яким постачається застосунок; йому потрібне лише сховище даних Valkey/Redis. full додає SQL-базу даних для облікових записів, яка за замовчуванням є SQLite за адресою sqlite://data/auth.db; PostgreSQL — підтримуваний варіант, а не вимога. У контейнері цьому файлу потрібен змонтований том, щоб пережити перезапуск.

Simple чи Full описує, що відкриває кожен режим, де має розміщуватися ця база даних і наскільки складно змінити режим пізніше.

Поспішаєте і вже маєте запущений Valkey або Redis? Варіант з однією командою docker run у статті Встановлення з Docker запускає екземпляр на порту 3000 зі згенерованим значенням SECRET. Усе інше на цій сторінці так само застосовується після запуску.

Оновлюєте наявне встановлення? Посібники з оновлення містять перелік доступних посібників, починаючи з найновіших. Почніть із першого посібника після релізу, який ви зараз використовуєте, і рухайтеся вперед, читаючи примітки до кожного проміжного релізу.

Рекомендовано для екземпляра в режимі автентифікації simple:

  • 2+ ядра процесора
  • 2 ГБ+ оперативної пам’яті
  • 10 ГБ+ дискового простору

Розгортання в режимі full, яке також запускає PostgreSQL, фоновий обробник і планувальник, потребує приблизно вдвічі більше.

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

Головне з них — передача організації новому власнику. Власники організацій не мають для цього ні екрана, ні кінцевої точки, тому передачу виконуєте ви. Скористайтеся командою нижче. Для автоматизації Colonel API надає ту саму операцію за адресою POST /api/colonel/organizations/:org_id/transfer-ownership; вона потребує ролі colonel, приймає назву організації як підтвердження та застосовується негайно без попереднього перегляду.

Термінал
bin/ots org transfer-ownership ORG NEW_OWNER

ORG — це публічний ідентифікатор організації (extid, ідентифікатор, який виводить CLI) або її внутрішній ідентифікатор (objid). NEW_OWNER — це адреса електронної пошти, extid клієнта або ідентифікатор облікового запису Rodauth, і ця особа вже має бути активним учасником — команда ніколи не створює клієнта, тому спершу виконайте bin/ots memberships add ORG CUSTOMER, якщо це не так.

Запустіть її без --yes, і вона спланує передачу, нічого не змінюючи: виведе, хто втрачає право власності, скільки членств власника буде понижено і до якої ролі, а потім попросить підтвердження. Відповідь n — це спосіб переглянути передачу заздалегідь. Параметри: --demote-to ROLE (будь-яка роль членства, крім owner, за замовчуванням admin), --yes (також -y і -f) та --json.

Попередній власник понижується, а не видаляється. Операція підвищує нового власника до пониження старого — захист від відсутності власника відхиляє будь-який інший порядок — тому на час цих двох записів організація має два членства власника, і bin/ots org doctor повідомляє про перевірку 4 (membership_role_sync) як про попередження. Якщо передачу перервано в цьому проміжку, запустіть повторно команду передачі, а не org doctor. Передача ідемпотентна й понижує всіх інших власників; org doctor позначає цю перевірку repairable: false і не виправляє її.

Інструкції для кінцевих користувачів наведено в статті Право власності та передача, яку ваші користувачі прочитають, перш ніж звернутися до вас.