Buuck CLI

A Buuck CLI egyetlen program, a neve buuck. Ezzel kezeled a Buuck telepítését a szervereden.

Ez az oldal leírja, hogyan szerezd be a CLI-t, és hogyan használd a parancsait. A DNS-rekordokhoz, az első fiók beállításához, a mentésekhez és a szolgáltatás-ellenőrzéshez olvasd el a Buuck telepítése útmutatót.

Parancsok

Parancs	Funkció
buuck install	Telepíti a Buuckot a szerverre. Kiírja a Compose fájlokat, és elindítja a szolgáltatásokat.
buuck update	Letölti az új Buuck termék image-eket, és újra létrehozza a kiválasztott szolgáltatásokat.
buuck upgrade	Lecseréli a buuck programot egy újabb CLI-re a get.buuck.io címről.

Figyelem

Az update és az upgrade más munkát végez. Az update az új termék image-ekhez kell. Az upgrade az új CLI binárishoz kell.

A CLI beszerzése

Csatlakozz a VPS-edhez rootként, vagy használd a sudo parancsot. Ezután töltsd le a CLI-t:

curl -fsSL https://get.buuck.io/cli -o /usr/local/bin/buuck
chmod +x /usr/local/bin/buuck

Ellenőrizd a verziót:

buuck --version

A parancs a CLI verziószámát mutatja.

Mutasd a parancslistát:

buuck --help

Mutasd egy parancs beállításait:

buuck install --help
buuck update --help
buuck upgrade --help

Figyelem

A CLI Linuxon fut, 64 bites x86 (amd64) processzoron. A Buuck image-ek nem futnak ARM processzoron.

Parancskészítő

Töltsd ki az űrlapot a vásárlási e-mailed értékeivel. Másold ki a parancsot. Ezután futtasd a parancsot a VPS-eden.

A készítő jelzőket használ. Alapból hozzáadja a --yes jelzőt, így a CLI nem kérdez.

Command builder

Fill in your values to build a one-liner Buuck CLI command.

Install Update

Registry user

From your purchase email (robot$…)

License key

Edition

StartPro

Version

API domain

Dashboard domain

Booking domain

Logs domain

ACME email

For Let's Encrypt certificate notices

Email provider

SMTPSendGridPostmarkResend

Email from

SMTP host

SMTP port

SMTP user (optional)

SMTP password

SMTP secure

Implicit TLS (usually off on port 587)

Noninteractive

Adds --yes

Configure ufw

Opens ports 22, 80, 443

Skip DNS check

Write files only

Do not start Docker

Version

Services db-migrate, server, dashboard, booking

Compose services to recreate

Registry user (optional)

License key (optional)

Noninteractive

Adds --yes

Skip pull

Recreate from local images

Force recreate

Copy

sudo buuck install --yes

Buuck telepítése

Először készítsd elő a DNS-rekordokat. Olvasd el a telepítési útmutató 1. lépését.

Ezután futtasd:

sudo buuck install

A CLI ezeket az értékeket kéri a vásárlási e-mailedből és a saját beállításaidból:

1. Registry felhasználónév (a robot$ előtaggal kezdődik)
2. Licenckulcs
3. Kiadás (start vagy pro)
4. Buuck verzió (például v0.0.1)
5. API domain (például api.example.com)
6. Dashboard domain (például admin.example.com)
7. Foglalási domain (például book.example.com)
8. Napló domain (például logs.example.com)
9. E-mail cím a TLS-tanúsítvány értesítésekhez
10. E-mail szolgáltató (általában smtp)
11. Feladó cím a foglalási e-mailekhez
12. SMTP hoszt, port, felhasználó, jelszó és secure beállítás

A registry felhasználónevet és a licenckulcsot ugyanabból a vásárlási e-mailből add meg. Ezek az adatok már a kiadásodhoz tartoznak (Start → buuck projekt, Pro → buuck-pro projekt).

Ezután a CLI egy összefoglalót mutat. Írd be az y betűt a folytatáshoz.

A CLI ezután elvégzi helyetted a következőket:

1. Telepíti a Docker Engine-t és a Docker Compose-t, ha hiányoznak.
2. Megnyithatja a 22-es, 80-as és 443-as portokat az ufw-vel, ha igent mondasz.
3. Ellenőrzi a DNS-rekordjaidat.
4. Létrehozza a /opt/buuck mappát a compose.yaml, Caddyfile, .env és dozzle-users.yml fájlokkal.
5. Generálja az adatbázis-jelszavakat, a gyorsítótár jelszavát, az auth titkos kulcsot, a beállítási tokent és a naplónézegető jelszavát.
6. Bejelentkezik a Buuck registrybe.
7. Letölti a kiadásod image-eit és elindítja a Buuckot.
8. Megvárja, amíg az API válaszol HTTPS-en.
9. Kiírja a beállítási linket az első fiókhoz.

Az első indítás körülbelül 2–3 percet vesz igénybe.

Figyelem

Ne nyisd meg az 5432-es vagy a 6379-es portot. Az adatbázisnak és a gyorsítótárnak privátnak kell maradnia.

A telepítés után ellenőrizd a szolgáltatásokat, és hozd létre az első fiókot. Olvasd el a telepítési útmutató 3. lépését és 4. lépését.

Értékek megadása jelzőkkel

Add meg a telepítési értékeket jelzőként, ha nem szeretnél kérdéseket. A CLI nem kér olyan értéket, amit már megadtál.

sudo buuck install \
  --registry-user 'robot$YOUR-HASH' \
  --license-key 'YOUR-LICENSE-KEY' \
  --edition start \
  --version v0.0.1 \
  --api-domain api.example.com \
  --dashboard-domain admin.example.com \
  --booking-domain book.example.com \
  --logs-domain logs.example.com \
  --acme-email [email protected] \
  --email-from 'Your Business <[email protected]>' \
  --smtp-host smtp.example.com \
  --smtp-user 'smtp-user' \
  --smtp-pass 'smtp-password'

A registry felhasználónevet szimpla idézőjelek közé tedd. A név tartalmazza a $ jelet.

Hasznos jelzők:

Jelző	Funkció
--yes / -y	Ne kérdezzen. Álljon le, ha egy kötelező érték hiányzik.
--write-files-only	Csak a telepítési fájlokat írja ki. Ne indítsa el a Dockert.
--skip-dns-check	Ne ellenőrizze a DNS-rekordokat.
--skip-docker-install	Ne telepítse a Dockert. Álljon le, ha a Docker hiányzik.
--configure-ufw	Nyissa meg a 22-es, 80-as és 443-as portokat az ufw-vel.
--reset-secrets	Új adatbázis- és auth titkokat készítsen. Ez tönkreteszi a meglévő adatbázist.
--install-dir	Telepítési mappa. Az alapértelmezett a /opt/buuck.

Mutasd az összes jelzőt:

buuck install --help

Értékek megadása környezeti változókkal

Minden jelzőhöz tartozik egy környezeti változó. Ha mindkettő be van állítva, a jelző élvez elsőbbséget.

Jelző	Környezeti változó
--registry-user	BUUCK_REGISTRY_USER
--license-key	BUUCK_LICENSE_KEY
--edition	BUUCK_EDITION
--version	BUUCK_VERSION
--api-domain	BUUCK_API_DOMAIN
--dashboard-domain	BUUCK_DASHBOARD_DOMAIN
--booking-domain	BUUCK_BOOKING_DOMAIN
--logs-domain	BUUCK_LOGS_DOMAIN
--acme-email	BUUCK_ACME_EMAIL
--email-provider	BUUCK_EMAIL_PROVIDER
--email-from	BUUCK_EMAIL_FROM
--smtp-host	BUUCK_SMTP_HOST
--smtp-port	BUUCK_SMTP_PORT
--smtp-user	BUUCK_SMTP_USER
--smtp-pass	BUUCK_SMTP_PASS
--smtp-secure	BUUCK_SMTP_SECURE
--install-dir	BUUCK_INSTALL_DIR
--registry	BUUCK_REGISTRY
--yes	BUUCK_NONINTERACTIVE=1
--write-files-only	BUUCK_WRITE_FILES_ONLY=1
--skip-dns-check	BUUCK_SKIP_DNS_CHECK=1
--skip-docker-install	BUUCK_SKIP_DOCKER_INSTALL=1
--configure-ufw	BUUCK_CONFIGURE_UFW=1
--reset-secrets	BUUCK_RESET_SECRETS=1

Példa környezeti változókkal és a --yes jelzővel:

sudo BUUCK_NONINTERACTIVE=1 \
  BUUCK_REGISTRY_USER='robot$YOUR-HASH' \
  BUUCK_LICENSE_KEY='YOUR-LICENSE-KEY' \
  BUUCK_EDITION=start \
  BUUCK_VERSION=v0.0.1 \
  BUUCK_API_DOMAIN=api.example.com \
  BUUCK_DASHBOARD_DOMAIN=admin.example.com \
  BUUCK_BOOKING_DOMAIN=book.example.com \
  BUUCK_LOGS_DOMAIN=logs.example.com \
  [email protected] \
  BUUCK_EMAIL_FROM='Your Business <[email protected]>' \
  BUUCK_SMTP_HOST=smtp.example.com \
  BUUCK_SMTP_USER='smtp-user' \
  BUUCK_SMTP_PASS='smtp-password' \
  buuck install

Figyelem

Tartsd titokban a licenckulcsodat. Ne tedd a licenckulcsot nyilvános scriptbe vagy nyilvános tárolóba.

A termék frissítése

A licenced tartalmazza a kiadásod összes későbbi verzióját. Minden új verzióról e-mailt küldünk.

Figyelem

Frissítés telepítése előtt készíts mentést az adatbázisról.

Futtasd:

sudo buuck update

A CLI megkérdezi az új verziót (például v0.0.1) és hogy mely szolgáltatásokat frissítse. Módosítja a BUUCK_VERSION értékét a /opt/buuck/.env fájlban, letölti a kiadásod új image-eit, szükség esetén futtatja az adatbázis-migrációkat, és csak a kiválasztott szolgáltatásokat hozza létre újra. Az adatbázis megőrzi az adataidat.

Ha csak egyes szolgáltatásokat szeretnél frissíteni:

sudo buuck update --version v0.0.1 --services dashboard,booking

Alapértelmezett szolgáltatások: db-migrate,server,dashboard,booking.

Hasznos jelzők:

Jelző	Funkció
--version	Image címke. Beírja a BUUCK_VERSION értéket a .env fájlba.
--services	Vesszővel elválasztott Compose szolgáltatások.
--registry-user / --license-key	Bejelentkezés a registrybe a letöltés előtt.
--skip-pull	Ne töltsön le. Csak a helyi image-ekből hozzon létre újra.
--force-recreate	Kényszerítse a kiválasztott szolgáltatások újra létrehozását.
--yes / -y	Ne kérdezzen.

A buuck update nem ad hozzá új Compose szolgáltatásokat. Ha a telepítésedben hiányzó szolgáltatások vannak, először frissítsd a CLI-t. Ezután futtasd újra a buuck install parancsot. A telepítés felülírja a compose.yaml fájlt és a Caddyfile-t. Megőrzi az adatbázis-titkokat.

A CLI frissítése

Ezt a parancsot akkor használd, ha újabb CLI kell. Az újabb CLI az új Compose- és Caddy-sablonokat is tartalmazza.

Ellenőrizd, van-e újabb CLI:

buuck upgrade --check

Telepítsd az újabb CLI-t:

sudo buuck upgrade

A parancs letölti a https://get.buuck.io/cli címet, és lecseréli a jelenlegi buuck binárist.

Hasznos jelzők:

Jelző	Funkció
--check	Mutassa, van-e újabb CLI. Ne cserélje le a binárist.
--force	Töltse le és cserélje le akkor is, ha a verzió ugyanaz.
--yes / -y	Ne kérjen megerősítést.
--base-url	Letöltési hoszt. Az alapértelmezett a https://get.buuck.io.

Ha a CLI-frissítés megváltoztatja a Compose- vagy Caddy-sablonokat, és az új fájlokra van szükséged, futtasd újra a sudo buuck install parancsot. Tartsd meg a titkokat. Ezután futtasd a sudo buuck update parancsot, ha új termék image-ekre is szükséged van.

Problémák

Probléma	Ok és javítás
A parancs Run as root üzenetet mutat.	Futtasd a parancsot sudo-val, vagy jelentkezz be rootként.
A Docker unauthorized vagy denied üzenetet mutat pull közben.	A registry felhasználónév vagy a licenckulcs nem helyes, vagy az adatok nem egyeznek a kiadásoddal. Tedd a registry felhasználónevet szimpla idézőjelek közé.
A Docker manifest unknown üzenetet mutat pull közben.	A --version / BUUCK_VERSION értéke nem helyes, vagy az image útvonala nem egyezik a kiadásoddal. Hasonlítsd össze az értéket a vásárlási e-maileddel.
A buuck upgrade azt mondja, hogy csak a lefordított binárissal működik.	A forrást bun run paranccsal futtattad. Töltsd le a CLI-t a https://get.buuck.io/cli címről, és azt a binárist használd.
A buuck upgrade --check a Remote CLI: unknown üzenetet mutatja.	A VPS nem tudja olvasni a https://get.buuck.io/cli.version címet. Ellenőrizd a hálózatot és a DNS-t.
A telepítés leáll, mert egy érték hiányzik.	A --yes jelzőt használtad az összes kötelező jelző vagy környezeti változó nélkül. Add meg a hiányzó értékeket, vagy futtasd a --yes nélkül.
Új Compose szolgáltatások hiányoznak a buuck update után.	Futtasd a buuck upgrade, majd a buuck install (tartsd meg a titkokat), majd szükség esetén a buuck update parancsot.

Ha a probléma továbbra is fennáll, válaszolj arra az e-mailre, amit a Buuck megvásárlása után küldtünk. Csatold a válaszodhoz a szolgáltatások üzeneteit.