Встановлення Kept

Виберіть, як ви запускаєте Kept, і пройдіть його кроки. Для кожного шляху є повний посібник у цьому розділі; посилання в кінці його кроків.

У терміналі

• Docker ComposeОдна машина
• KubernetesЗ Helm
• З вихідного кодуВаш власний образ

Одним кліком

• Home AssistantЯк додаток

Docker Compose

Що потрібно

Docker з плагіном Compose і термінал. Протестовано на 1 ГБ оперативної пам’яті та одному ядрі процесора; Kept і його база даних споживають близько 200–400 МБ (що було протестовано).

1. Завантажте compose.yaml в окрему теку: Kept і його база даних в одному файлі, без копії репозиторію і без паролів, які треба вигадувати.

   mkdir kept && cd kept
   curl -fsSLO https://raw.githubusercontent.com/keptinventory/kept/v1.14.7/compose.yaml

2. Запишіть .env. init запитує адресу, за якою ви відкриватимете Kept, наприклад http://kept.home.arpa:8080. Беріть ім’я, а не IP-адресу: її несуть надруковані мітки.

   docker compose run --rm init

   Ви маєте побачити

   Wrote .env.
   
   KEPT SETUP CODE: XXX-XXX
   
   Next: docker compose up -d, then open http://kept.home.arpa:8080 and enter the setup code.

3. Запустіть. Стартує база даних, два одноразові сервіси створюють її облікові записи та застосовують міграції, потім Kept стартує на порті 8080.

   docker compose up -d

   Ви маєте побачити

   За адресою сторінка Kept Введіть код налаштування.

4. Налаштуйте. Введіть код, який показав init, і створіть перший обліковий запис: він стає адміністратором інстанції.

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

   docker compose exec kept kept admin recovery-kit

   Ви маєте побачити

   Текст, що починається з KEPT RECOVERY KIT.

Windows

У PowerShell пишіть curl.exe там, де в кроках стоїть curl, і виконуйте mkdir kept та cd kept окремо. Або виконуйте всі кроки у WSL.

Кожен крок докладно, з Caddy для HTTPS і Ollama для локального ШІ: Встановлення за допомогою Docker Compose.

Kubernetes

Ще не протестовано на справжньому кластері

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

Що потрібно

Кластер Kubernetes, наприклад k3s, kubectl і helm, і термінал. Чарт запитує 384 МіБ пам’яті для Kept (щонайбільше 1 ГіБ) і 256 МіБ для вбудованого Postgres (щонайбільше 512 МіБ).

1. Створіть секрети. Чарт ніколи не записує секретів: облікові записи бази даних і суперкористувач вбудованого Postgres беруть паролі із секретів, які ви створюєте заздалегідь.

   kubectl create namespace kept
   pw() { openssl rand -hex 32; }
   # The four database logins (always).
   kubectl -n kept create secret generic kept-db \
     --from-literal=KEPT_DB_OWNER_PASSWORD="$(pw)" --from-literal=KEPT_DB_APP_PASSWORD="$(pw)" \
     --from-literal=KEPT_DB_AUTH_PASSWORD="$(pw)" --from-literal=KEPT_DB_SYSTEM_PASSWORD="$(pw)"
   # The bundled Postgres's superuser (or, for external Postgres with roles.create, the server admin's password).
   kubectl -n kept create secret generic kept-postgres --from-literal=POSTGRES_PASSWORD="$(pw)"

2. Встановіть чарт, з publicUrl на адресу, яку відкриватимуть люди. Не додавайте --wait до цього першого встановлення: міграції виконуються після нього.

   helm install kept oci://ghcr.io/keptinventory/charts/kept --version 1.14.7 -n kept \
     --set publicUrl=https://kept.example.org \
     --set roles.existingSecret=kept-db --set postgres.superuserSecret=kept-postgres

   Ви маєте побачити

   Перший рядок приміток, які виводить Helm:

   Kept 1.14.7 is installed as "kept" in namespace "kept".

3. Знайдіть код налаштування. Kept виводить його один раз, під час першого запуску.

   kubectl -n kept logs deploy/kept | grep 'KEPT SETUP CODE'

   Ви маєте побачити

   KEPT SETUP CODE: XXX-XXX

   Відкрийте адресу, введіть код і створіть перший обліковий запис: він стає адміністратором інстанції.

4. Збережіть ключі. Збережіть набір для відновлення поза кластером.

   kubectl -n kept exec deploy/kept -- kept admin recovery-kit > kept-recovery-kit.txt

   Ви маєте побачити

   kept-recovery-kit.txt, що починається з KEPT RECOVERY KIT.

5. Перевірте. helm test запитує в запущеного Kept /readyz і /version.

   helm test kept -n kept

У Windows виконуйте ці команди у WSL. Значення, необов’язкові секрети і що запускає чарт: Встановлення на Kubernetes за допомогою Helm.

З вихідного коду

Що потрібно

Git, Docker з плагіном Compose і термінал. Kept працює так само, як з Docker Compose, на вашому власному образі.

1. Отримайте код.

   git clone https://github.com/keptinventory/kept.git && cd kept

2. Зберіть образ з тегом kept:local.

   docker build -t kept:local .

3. Запишіть .env. Спрямуйте compose.yaml на ваш образ, потім запустіть init. Він знаходить .env, питає, чи оновити його (відповідайте Y), а потім запитує адресу, за якою ви відкриватимете Kept.

   echo KEPT_IMAGE=kept:local >> .env
   docker compose run --rm init

   Ви маєте побачити

   Updated .env.
   
   KEPT SETUP CODE: XXX-XXX

4. Запустіть і відкрийте адресу.

   docker compose up -d

   Ви маєте побачити

   Сторінка Kept Введіть код налаштування. Введіть код, який показав init, і створіть перший обліковий запис: він стає адміністратором інстанції.

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

   docker compose exec kept kept admin recovery-kit

   Ви маєте побачити

   Текст, що починається з KEPT RECOVERY KIT.

У Windows виконуйте ці команди у WSL. Той самий compose.yaml, що й у релізі, докладно: Встановлення за допомогою Docker Compose.

Home Assistant

Що потрібно

Home Assistant OS із Supervisor 2026.10.4 або новішим: додаткам потрібен Supervisor, тож не Home Assistant Container і не Core. Машина aarch64 або amd64, наприклад Raspberry Pi 4 або 5 на 64-бітній системі чи міні-ПК. 4 ГБ пам’яті; 2 ГБ вистачає з небагатьма іншими додатками. Без термінала.

1. Додайте репозиторій Kept. Кнопка відкриває ваш Home Assistant із уже заповненим репозиторієм. Або перейдіть до Налаштування → Додатки → Встановити додаток → ⋮ → Репозиторії і додайте https://github.com/keptinventory/kept.

   Додати Kept до Home Assistant

2. Встановіть, потім запустіть. Знайдіть Kept у магазині додатків, потім Встановити, потім Почати.

   Ви маєте побачити

   На вкладці Журнал додатка власна адреса Kept і код налаштування:

   Kept is at http://homeassistant.local:8080 (change it in Configuration: "Kept's address")

   KEPT SETUP CODE: XXX-XXX

3. Відкрити веб-інтерфейс. Kept відкривається всередині Home Assistant, також у бічній панелі.

   Ви маєте побачити

   Для адміністратора Home Assistant Створіть перший обліковий запис, без коду. Усі інші бачать Введіть код налаштування і вводять код із вкладки Журнал.

Адреса Kept, https і резервні копії: Встановлення як додаток Home Assistant.

Щось не працює?

• Контейнер постійно перезапускається. Прочитайте його журнал: docker compose logs kept. Kept перевіряє свої налаштування до запуску і зупиняється з рядком, що називає першу проблему, наприклад kept: invalid environment: KEPT_PUBLIC_URL (виконайте docker compose run --rm init). Якщо docker compose up -d зупиняється на bootstrap, docker compose logs bootstrap каже чому. Коли пам’яті менше за 1 ГБ, резервному копіюванню може її забракнути, і Docker перезапускає Kept (що потрібно). Докладніше
• Порт зайнятий. Kept займає порт 8080 на хості. Виконайте docker compose run --rm init ще раз з адресою http:// на вільному порті: він записує адресу і порт (KEPT_HTTP_PORT) у .env. Потім docker compose up -d. У додатку Home Assistant змініть порт у Конфігурація → Мережа і вкажіть нову адресу в опції Власна адреса Kept. Докладніше
• Відмовлено в доступі. Kept працює від користувача 10001 з файловою системою лише для читання, тож тека, яку ви в нього монтуєте, наприклад каталог для резервних копій, має належати uid 10001. init записує .env у теку, з якої ви його запускаєте: запускайте його у власній теці. Докладніше
• Інші пристрої не відкривають його. localhost відкривається лише на цій машині. Візьміть ім’я, яке знаходять інші пристрої, задане в DNS вашого роутера або у файлі hosts кожного пристрою, і виконайте init ще раз із ним. Якщо Kept каже «Цей Kept налаштовано для адреса. Відкрийте його там.», відкрийте його саме за цією адресою або додайте іншу в KEPT_EXTRA_ADDRESSES (більше ніж одна адреса). Докладніше
• 502 від зворотного проксі. Kept говорить звичайним HTTP на порті 8080: спрямуйте проксі на http://, а не https://, на цьому порті (за зворотним проксі). Kept запускається лише після завершення migrate; якщо воно не вдалося, docker compose logs migrate каже чому. Докладніше

Усе інше: Усунення несправностей.

Далі

• HTTPS: він потрібен камері, встановленню застосунку, push-сповіщенням і геолокації. Поставте Kept на HTTPS, або Kept у домашній мережі про те, що працює без нього.
• Асистент: питайте простими словами, з вашим власним провайдером ШІ; Kept працює і без нього. Провайдери ШІ і Підключити клієнта штучного інтелекту (MCP).
• Резервні копії: щоночі й зашифровані, у каталог, S3 або SFTP. Резервні копії.
• Пошта: скидання паролів, запрошення й нагадування поштою, з KEPT_SMTP_URL і KEPT_SMTP_FROM. Пошта, Push-сповіщення та стрічка календаря.
• Home Assistant: інтеграція приносить те, що настає, на панелі та в автоматизації. Home Assistant.

Оновлення

• Docker Compose: вкажіть новий реліз у KEPT_IMAGE в .env, потім:

  docker compose pull
  docker compose up -d

  Реліз, що змінює compose.yaml, каже про це у своїх примітках: завантажте його файл поверх вашого.

• З вихідного коду:

  git pull
  docker build -t kept:local .
  docker compose up -d

• Kubernetes: кожен реліз публікує чарт тієї самої версії, і його міграції виконуються в Job, перш ніж нова версія почне обслуговувати.

• Home Assistant: Home Assistant пропонує оновлення. Увімкніть Keep backup of the last version у його діалоговому вікні оновлення.

Коли задано ціль резервного копіювання, Kept робить знімок перед міграцією. Оновлення та відкат.