Адміністраторам

# Запустіть власний сервер Welley

Наш інструмент командного рядка встановлює все, що потрібно Welley, на одну машину з Linux. Підійде хмарний сервер, а також ваше власне обладнання.

[Читати: Швидкий старт: мінімальне розгортання Welley](https://welley.com/uk/administrators/docs/quick-start/) [Читати: Welley CLI](https://welley.com/uk/administrators/docs/cli/) [Встановіть Docker Engine](https://docs.docker.com/engine/install/)

Ми плануємо в майбутньому випустити Welley з відкритим кодом. Дата випуску й ліцензія ще не оголошені.

## Підготуйте хост, DNS і пошту

Це початкові вимоги зі швидкого старту. Скільки потужності потрібно, залежить від ваших користувачів і навантаження.

### Хост із Linux

-   Ubuntu 24.04 LTS або подібний сучасний дистрибутив.
-   Почніть із 2 vCPU, 4 ГБ RAM і 60 ГБ диска.
-   Використовуйте фіксовану публічну адресу IPv4 і користувача без прав root із sudo.

### Мережа

-   Дозвольте вхідні TCP 80 і 443 з інтернету. Дозвольте TCP 22 зі своєї мережі.
-   Залишайте порт 80 вільним для перевірки сертифіката та щотижневого оновлення сертифіката.

### DNS сайту

-   Вкажіть для вашого домену та storage.<domain> IP-адресу хоста.
-   Створіть обидва записи до встановлення. CLI перевіряє їх і зупиняється, якщо вони не вказують на хост.

### SMTP і пошта адміністратора

-   Підготуйте хост SMTP, користувача, пароль і адресу відправника. За замовчуванням використовується STARTTLS на порту 587.
-   Також знадобиться адреса електронної пошти адміністратора для першого входу та відновлення пароля.

### DNS для пошти

-   Налаштуйте SPF, DMARC і DKIM, який створює ваш провайдер, для домену адреси відправника.
-   Використайте точне значення SPF від провайдера. Додайте його до наявного запису SPF, а не створюйте другий.
-   CLI попередить вас, якщо SPF або DMARC немає. Селектор DKIM вашого провайдера він перевірити не може.

## Встановіть Docker Engine і Compose

Дотримуйтеся офіційних інструкцій Docker для вашого дистрибутива Linux. Потім надайте користувачу розгортання доступ до Docker.

[Встановлення Docker Engine](https://docs.docker.com/engine/install/)

### Додайте користувача до групи Docker

Замініть <user> на вашого користувача розгортання без прав root. Після цієї команди вийдіть із системи й увійдіть знову.

```
sudo usermod -aG docker <user>
```

### Перевірте Docker і Compose

Обидві команди мають працювати для цього користувача.

```
docker ps
docker compose version
```

## Завантажте CLI

Оберіть бінарний файл для машини, на якій запускатимете CLI. Сам хост розгортання має працювати на Linux.

### Linux, x86-64

```
curl -fL "https://appstore.allroads.social/v1/social.wellesley.wlycli/latest?channel=stable&platform=linux/amd64" -o wlycli
chmod +x wlycli
./wlycli -v
```

### Linux, ARM64

```
curl -fL "https://appstore.allroads.social/v1/social.wellesley.wlycli/latest?channel=stable&platform=linux/arm64" -o wlycli
chmod +x wlycli
./wlycli -v
```

### macOS, Apple silicon

```
curl -fL "https://appstore.allroads.social/v1/social.wellesley.wlycli/latest?channel=stable&platform=darwin/arm64" -o wlycli
chmod +x wlycli
./wlycli -v
```

### macOS, Intel

```
curl -fL "https://appstore.allroads.social/v1/social.wellesley.wlycli/latest?channel=stable&platform=darwin/amd64" -o wlycli
chmod +x wlycli
./wlycli -v
```

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

## Створіть розгортання

Запустіть цю команду на підготовленому хості з Linux. Замініть приклад домену, пошти та значень SMTP на власні.

```
./wlycli deploy create \
-d example.com \
-e admin@example.com \
--smtp-host smtp.example.com \
--smtp-user "$MAIL_USER" \
--smtp-password "$MAIL_PASSWORD" \
--smtp-from noreply@example.com
```

| Параметр | Типове значення |
| --- | --- |
| Каталог встановлення | ~/.welley/<project>. Для прикладу домену назва проєкту буде example\_com. |
| База даних | Вбудована PostgreSQL, дані зберігаються в каталозі встановлення. |
| Склад | Платформа Welley, конвеєр RAG, Nginx, Redis і PostgreSQL, а також контейнери обслуговування. |
| Сертифікати | Let’s Encrypt через Certbot, із щотижневим оновленням. |
| Медіа | Завантаження та статичні файли за адресою https://storage.<domain>. |
| Оновлення | Стабільний канал, перевіряється щодня. Процес оновлення за можливості обходиться без простою. |
| Додаткові служби | Мінімальне налаштування не додає керовану базу даних, CDN, телеметрію чи інтеграцію зі Slack. |

-   Перш ніж запускати її, задайте в MAIL\_USER і MAIL\_PASSWORD свої облікові дані SMTP.
-   Швидкий старт вимагає цих шести прапорців.
-   Команда перевіряє DNS, записує файли розгортання, отримує сертифікат через Certbot і запускає контейнери.
-   Команда deploy є псевдонімом для deployment.

## Увійдіть і перевірте результат

Згенерований пароль адміністратора є в журналі платформи. Не показуйте цей вивід нікому.

### Знайдіть початковий пароль

Ця назва контейнера для example.com. Для власного домену змініть назву проєкту.

```
docker logs example_com-platform-blue-1 | grep "Auto-init complete"
```

### Вхід

Відкрийте свій домен і увійдіть з адресою пошти адміністратора, яку ви вказали через -e. Одразу змініть згенерований пароль.

### Перевірте контейнери

Швидкий старт очікує побачити nginx, platform-blue, rag-pipeline-blue, postgres, redis, autoheal і snoopy.

```
docker ps
```

## Користуйтеся CLI для адміністрування

У CLI також є команди для API платформи. Вашому акаунту й надалі потрібні дозволи на кожну операцію.

-   Перш ніж запускати операцію, перевірте її поточні прапорці в довідці команди.
-   Команда login приймає базовий URL API, пошту та пароль. Вона зберігає токен сеансу, який отримує у відповідь.
-   Наразі команда login виводить токен сесії в журнал успішного входу. Нікому не показуйте цей вивід.

Групи команд: `accounts`, `posts`, `apps`, `emojis`, `feeds`, `reports`, `rules`, `settings`.

### Показати доступні команди

```
./wlycli --help
```

### Показати команди розгортання

```
./wlycli deployment --help
```

### Показати параметри входу

```
./wlycli login --help
```

### Показати параметри налаштувань

```
./wlycli settings --help
```

## Оновлення та відновлення

За замовчуванням розгортання щодня перевіряє наявність стабільних оновлень. Адміністратор сервера може керувати випусками в інтерфейсі адміністрування.

-   Якщо файли розгортання досі дійсні, але деякі контейнери не запускаються, у швидкому старті сказано виконати restart. Ця команда заново створює контейнери.
-   Команда create не запуститься знову, поки існують каталог проєкту або його контейнери.
-   Параметр примусового видалення стирає файли розгортання та вбудовану базу даних. Це не крок відновлення, і ваші дані він не зберігає.
-   Навичка deploy-server досі використовує назву deployment update. У поточному CLI замість неї є deployment auto-update. Перш ніж обслуговувати розгортання вручну, перегляньте актуальну довідку CLI.

### Перестворити контейнери з наявного розгортання

```
./wlycli deploy restart -d example.com
```

Заново створює контейнери з вашої збереженої конфігурації. Дані розгортання не видаляє.

## Розгортання з ШІ-помічником

Якщо ваш ШІ-помічник підтримує пакети SKILL.md, завантажте нашу офіційну навичку deploy-server. Вона веде вас через розгортання на DigitalOcean.

Поки що навичка охоплює лише DigitalOcean. Швидкий старт із CLI працює також з іншими хмарами та з вашим власним хостом Linux.

### Як користуватися

-   Розпакуйте пакет і завантажте каталог deploy-server так, як ваш помічник встановлює навички.
-   Попросіть помічника використати $deploy-server.
-   Навичка запитає у вас домен, доступ до DNS, налаштування SSH, дані SMTP та електронну адресу адміністратора.
-   Вона може налаштувати віртуальну машину DigitalOcean і, якщо ви захочете, керовану базу даних PostgreSQL. Вхідні дані розгортання та вартість керованої бази даних вона узгоджує з вами.

### Перед завантаженням

-   Пакет є незміненою копією оригінальної навички.
-   Приклади завантаження й оновлення в ньому застаріли. Актуальну адресу стабільного завантаження візьміть зі швидкого старту на цьому сайті. Перед обслуговуванням перегляньте довідку CLI.
-   До навички не додаються облікові дані хмари чи запущений сервер, і ми не можемо гарантувати, що вона працює з кожним помічником.

У пакеті `SKILL.md`, `agents/openai.yaml` і `references/digitalocean.md`. Обидва завантаження містять однакові файли.

[Завантажити deploy-server.zip (10,7 KB)](https://welley.com/downloads/deploy-server.zip) [Завантажити deploy-server.skill (10,7 KB)](https://welley.com/downloads/deploy-server.skill)

## Довідкова документація

Повна документація CLI та файли навички розгортання. Ви можете читати їх тут без акаунта.

-   [**Welley CLI** docs/index.md](https://welley.com/uk/administrators/docs/cli/)
-   [**Швидкий старт: мінімальне розгортання Welley** docs/quick-start.md](https://welley.com/uk/administrators/docs/quick-start/)
-   [**Розгортання сервера** skills/deploy-server/SKILL.md](https://welley.com/uk/administrators/docs/deploy-server-skill/)
-   [**openai.yaml** skills/deploy-server/agents/openai.yaml](https://welley.com/uk/administrators/docs/deploy-server-openai-yaml/)
-   [**Довідка з DigitalOcean** skills/deploy-server/references/digitalocean.md](https://welley.com/uk/administrators/docs/deploy-server-digitalocean/)
