Buuck telepítése VPS-re

A Buuck a saját szervereden fut. Ez az oldal leírja, hogyan telepítsd a Buuckot egy VPS-re a Buuck CLI-vel.

Kövesd a lépéseket a megadott sorrendben. A telepítés körülbelül 15 percet vesz igénybe, miután a DNS-rekordjaid készen állnak.

Start és Pro kiadások

A Buucknak két saját szerveren futtatható kiadása van. A vásárlási e-mailed megmondja, melyik kiadást vetted meg. Csak az abban az e-mailben kapott registry-adatokat használd. Az adatok csak egy kiadáshoz érvényesek.

	Buuck Start	Buuck Pro
Registry projekt	buuck	buuck-pro
Server image	registry.buuck.io/buuck/server	registry.buuck.io/buuck-pro/server
Dashboard image	registry.buuck.io/buuck/dashboard	registry.buuck.io/buuck-pro/dashboard
Booking image	Ugyanaz az image, mindkét projektben (booking)	Ugyanaz az image, mindkét projektben (booking)
Migrate image	registry.buuck.io/buuck/db-migrate	registry.buuck.io/buuck-pro/db-migrate
Márkajelzés	Diszkrét „Powered by Buuck” a foglalási e-mailekben	Nincs Buuck márkajelzés. White-label e-mailek és felület
Márkajelzés beállítása	Rögzített Buuck jel	Egyedi márkajelzés (logó és megjelenés)

A Pro Managed a Pro termék, hostinggal és támogatással tőlünk. A Pro Managedet ezzel az oldallal nem telepíted.

Figyelem

Egy Start registry felhasználó nem tud Pro image-eket letölteni. Egy Pro registry felhasználó nem tud Start image-eket letölteni. Ha a Docker unauthorized vagy denied üzenetet mutat, ellenőrizd, hogy a kiadásod és az adataid egyeznek-e.

Mit telepítesz

A Buuck három alkalmazásból és öt kiegészítő szolgáltatásból áll. A Docker Compose ezeket együtt indítja el.

Szolgáltatás	Funkció	Port
booking	A nyilvános oldal. Az ügyfeleid itt foglalnak.	3002
dashboard	A privát oldal. A munkatársaid itt kezelik a foglalásokat.	3001
server	Az API. A két alkalmazás innen kapja az adatokat.	3000
db-migrate	Egyszeri beállítás. Létrehozza az adatbázis-felhasználókat és az adatbázis-táblákat.	—
postgres	Az adatbázis. Az összes adatot az adatbázis tárolja.	5432
cache	A gyorsítótár. A gyorsítótár gyorsabbá teszi az API-t.	6379
caddy	A reverse proxy. Emellett a TLS-tanúsítványokat is beszerzi.	80, 443
dozzle	A naplónézegető. Itt olvashatod a többi szolgáltatás üzeneteit.	8080

Csak a reverse proxy érhető el az internetről. A többi szolgáltatás privát Docker-hálózaton fut.

A server, a dashboard és a db-migrate image-ek kiadásonként különböznek. A Start build és a Pro build külön image. A Pro migrate image extra táblákat hoz létre, amelyek a Start kiadásban nincsenek. A CLI a registry-adataidhoz tartozó kiadás image-eit tölti le.

Mielőtt elkezded

Ezekre lesz szükséged:

• Egy VPS 2 CPU-maggal, 4 GB RAM-mal és 20 GB szabad lemezterülettel.
• 64 bites x86 processzor. A Buuck image-ek nem futnak ARM processzoron.
• Linux operációs rendszer. A Buuckot Ubuntu 24.04-en teszteljük.
• Root hozzáférés a VPS-hez, vagy sudo jogosultságú felhasználói fiók.
• Egy domainnév. Tudnod kell DNS-rekordokat hozzáadni a zónájához.
• A kiadásod (Start vagy Pro). A vásárlási e-mail megnevezi a kiadást.
• A registry felhasználóneved és a licenckulcsod. Ezeket e-mailben küldjük el.
• A Buuck kiadásod verziószáma. Ugyanaz az e-mail tartalmazza ezt a számot.
• Egy SMTP-fiók. A Buuck ezzel a fiókkal küldi a foglalási e-maileket.

Figyelem

Tartsd titokban a licenckulcsodat. Aki megkapja a licenckulcsodat, a te kiadásod Buuck image-eihez hozzáférhet.

A licenced csak arra a személyre vagy cégre vonatkozik, aki megvette a Buuckot. Ha egy cég vásárolta meg, csak az a cég használhatja. Ne add át a licenckulcsodat más személynek vagy más cégnek.

Ha nem tartod be ezeket a szabályokat, visszavonjuk a licencedet és a licenckulcsodat. Ekkor elveszíted a hozzáférést a Buuck image-ekhez és az összes későbbi verzióhoz.

Ez az oldal az example.com domainnevet használja. Cseréld le az example.com-ot a saját domainnevedre.

1. lépés: DNS-rekordok hozzáadása

A Buuck négy aldomaint használ. Adj hozzá egy DNS A rekordot minden aldomainhez. Minden rekord a VPS-ed IP-címére mutasson.

Rekord	Példa	Szolgáltatás
api	api.example.com	a szerver
admin	admin.example.com	a dashboard
book	book.example.com	a foglalási oldal
logs	logs.example.com	a naplónézegető

Ha a DNS-szolgáltatódnak van proxy funkciója, kapcsold ki a proxyt. A VPS-eden futó reverse proxynak közvetlenül kell megkapnia a kéréseket.

Ellenőrizz egy rekordot, mielőtt továbblépsz:

dig +short api.example.com

A parancs a VPS-ed IP-címét mutatja. Ha a parancs nem ad vissza címet, várj 10 percet. Ezután ellenőrizd újra.

Figyelem

Mind a négy DNS-rekordnak a VPS-edre kell mutatnia, mielőtt elkezded a 2. lépést. Ha előbb futtatod a telepítést, a TLS-tanúsítványok beszerzése sikertelen lesz.

2. lépés: Buuck telepítése

Csatlakozz a VPS-edhez:

ssh root@YOUR-SERVER-IP

Töltsd le a Buuck CLI-t, és futtasd a telepítő parancsot. Használhatod az alábbi parancskészítőt.

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

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

Figyelem

A CLI-t rootként futtasd, vagy használd a sudo parancsot. A CLI fájlokat ír a /opt/buuck mappába, és elindítja a Dockert.

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. A reverse proxy ebben az időben a TLS-tanúsítványokat is beszerzi.

A jelzőkhöz és a környezeti változókhoz olvasd el a Buuck CLI útmutatót.

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.

3. lépés: A telepítés ellenőrzése

Nézd meg a szolgáltatások állapotát:

cd /opt/buuck
docker compose ps

A db-migrate szolgáltatás az exited (0) állapotot mutatja. Ez az állapot helyes. A szolgáltatás csak egyszer fut le. Az összes többi szolgáltatás a running vagy healthy állapotot mutatja.

Küldj egy kérést az API-nak:

curl -i https://api.example.com

Az API 200 OK választ ad, és a szöveg OK.

Ezután nyisd meg ezt a három címet a böngészőben:

• A https://admin.example.com a dashboard bejelentkezési oldalát mutatja.
• A https://book.example.com a foglalási oldalt mutatja.
• A https://logs.example.com a naplónézegetőt mutatja. Jelentkezz be admin néven. A jelszó a DOZZLE_PASSWORD a /opt/buuck/.env fájlban.

A böngészőnek érvényes tanúsítványt kell mutatnia minden címhez. Ha egy oldal nem nyílik meg, olvasd el a Gyakori problémák oldalt.

Start kiadáson a foglalási e-mailek végén egy kis „Powered by Buuck” sor van. Pro kiadáson ez a sor nincs jelen.

Figyelem

A naplónézegető privát. Minden Buuck konténer üzeneteit el tudja olvasni. Ne oszd meg az URL-t és a jelszót. A naplónézegető a Docker socketet használja, ezért kezeld adminisztrátori eszközként.

4. lépés: Első fiók létrehozása

A CLI a végén kiír egy beállítási linket. A link így néz ki:

https://admin.example.com/setup?token=YOUR-SETUP-TOKEN

1. Nyisd meg a beállítási linket a böngészőben.
2. Add meg a neved, az e-mail címed és egy jelszót.
3. Add meg a vállalkozásod nevét és egy rövid nevet a címhez.
4. Válaszd a Complete setup lehetőséget.

A dashboard megnyílik. A fiókod a példány tulajdonosa. Mostantól hozzáadhatod a helyszíneidet, az erőforrásaidat és a szolgáltatásaidat.

Az ügyfeleid a https://book.example.com/YOUR-SHORT-NAME címen foglalnak.

Az új fiókokhoz meghívó kell. Nyisd meg az Instance settings oldalt a dashboardon, és hívd meg a munkatársaidat. Egy meghívó egy e-mail címhez tartozik, és egyszer használható.

Figyelem

Fejezd be a beállítást, mielőtt megosztod a dashboard címét. A beállítási oldal csak egyszer működik. Ha elveszíted a beállítási linket, a token a SETUP_TOKEN érték a /opt/buuck/.env fájlban.

Buuck leállítása és újraindítása

Állítsd le az összes szolgáltatást:

cd /opt/buuck
docker compose stop

Indítsd el újra az összes szolgáltatást:

cd /opt/buuck
docker compose start

Gyakori problémák

A gyakori problémák és a megoldásaik listáját a Gyakori problémák oldalon találod.