27 Commits

Author SHA1 Message Date
885ad069d3 feat: add Docker docs 2025-12-05 12:18:29 +01:00
cd2afee8fc fix: add missing backend and frontend domain variables in .env.example 2025-12-04 23:52:24 +01:00
af5dbc2767 fix: update environment variables for frontend and backend URLs in compose file 2025-12-04 23:50:10 +01:00
430100f62d fix: remove non-functioning sanctum module config 2025-12-04 23:49:46 +01:00
1224d2057b fix: trust all proxies 2025-12-04 22:52:23 +01:00
77e099a16e fix: add runtime configuration for Sanctum base URL and origin 2025-12-04 21:06:37 +01:00
0da6157255 fix: missing https:// in docker environment example 2025-12-04 21:05:55 +01:00
f0ac4e0cdf fix: add APP_KEY to .env.example for configuration 2025-12-04 20:40:06 +01:00
679b6ab913 fix: make APP_KEY configurable with environment variable 2025-12-04 20:39:13 +01:00
a93c8d236a fix: add .env to .gitignore 2025-12-04 20:30:31 +01:00
92782bfff3 fix: fix incorrect environment variable name for frontend service 2025-12-04 20:28:50 +01:00
d052e464b2 fix: update environment variables in docker-compose for better configurability 2025-12-04 20:28:19 +01:00
962ae2d0d3 fix: remove unused runtime config 2025-12-04 20:27:55 +01:00
72bca8876e refactor: remove unused Caddyfile configuration 2025-12-04 20:11:52 +01:00
380cf51b77 Merge branch 'feature/docker-frankenphp' into feature/docker 2025-12-04 20:08:36 +01:00
a6164cdcf0 Merge branch 'develop' into feature/docker 2025-12-04 20:05:28 +01:00
cbfd4f1b68 refactor: remove unused NUXT_HOST and NUXT_PORT environment variables 2025-12-04 12:17:13 +01:00
be284c061e refactor: add sample domain and environment variables 2025-12-04 12:16:09 +01:00
e62fe4c443 feat: make backend image default to port 80 2025-12-04 12:10:48 +01:00
187b56b464 feat: build custom image for backend 2025-12-02 16:19:51 +01:00
c99017623b feat: add docker-compose stack with FrankenPHP 2025-12-02 15:32:23 +01:00
b1c26b762a feat: setup Dockerfile for frontend 2025-12-02 15:31:49 +01:00
77c4164dcb refactor: update docker-compose.yml to define service names and improve structure 2025-10-31 17:46:31 +01:00
550f07df79 fix: update php_fastcgi service reference in Caddyfile 2025-10-31 17:46:17 +01:00
4714cc7892 fix: correct CMD syntax in Dockerfile for frontend server 2025-10-31 17:45:47 +01:00
042cdcdb3a fix: update Sanctum base URL and origin for local development 2025-10-31 17:45:27 +01:00
79a8c4f229 feat: add basic Docker configuration for backend and frontend services 2025-10-28 12:28:11 +01:00
11 changed files with 381 additions and 5 deletions

9
backend/.dockerignore Normal file
View File

@@ -0,0 +1,9 @@
.git
.env
storage/logs/*
storage/framework/cache/*
storage/framework/sessions/*
storage/framework/views/*
bootstrap/cache/*
.phpunit.result.cache
vendor/*

18
backend/Dockerfile Normal file
View File

@@ -0,0 +1,18 @@
FROM dunglas/frankenphp:1.10-php8.4-bookworm
RUN install-php-extensions \
pdo_mysql \
gd \
intl \
zip \
opcache
COPY . /app
WORKDIR /app
RUN curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/local/bin --filename=composer
RUN composer install --no-dev --optimize-autoloader
ENV SERVER_NAME=:80

View File

@@ -6,12 +6,14 @@ use Illuminate\Foundation\Configuration\Middleware;
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__.'/../routes/web.php',
api: __DIR__.'/../routes/api.php',
commands: __DIR__.'/../routes/console.php',
web: __DIR__ . '/../routes/web.php',
api: __DIR__ . '/../routes/api.php',
commands: __DIR__ . '/../routes/console.php',
health: '/up',
)
->withMiddleware(function (Middleware $middleware): void {
$middleware->trustProxies('*');
$middleware->api(prepend: [
\Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
]);

View File

@@ -0,0 +1,14 @@
#!/bin/bash
function exit_container_SIGTERM(){
echo "Caught SIGTERM"
exit 0
}
trap exit_container_SIGTERM SIGTERM
echo "Setting /app/public ownership..."
chgrp -R 33 /app
chown -hR 33:33 /app
echo "Starting PHP-FPM..."
php-fpm -F & wait

6
docker/.env.example Normal file
View File

@@ -0,0 +1,6 @@
BACKEND_URL=https://backend.example.com
FRONTEND_URL=https://example.com
BACKEND_DOMAIN=backend.example.com
FRONTEND_DOMAIN=example.com
SESSION_DOMAIN=.example.com
APP_KEY=SOME-KEY

2
docker/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
mariadb_data/
.env

199
docker/README.md Normal file
View File

@@ -0,0 +1,199 @@
# Docker
Hostovanie s Dockerom je možné použitím `docker-compose.yml`. Definuje 3 služby:
- Frontend
- `node:22-alpine`
- Build aplikácie prebieha cez [pnpm](https://pnpm.io/).
- Backend
- `dunglas/frankenphp:1.10-php8.4-bookworm`
- PHP verzia `8.4`
- Extensions:
- `pdo_mysql`
- `gd`
- `intl`
- `zip`
- `opcache`
- Aplikácia je servovaná pomocou [Caddy](https://caddyserver.com/)
- Databáza
- `mariadb:11.8.2-noble`
Každá služba má `healthcheck` a `depends_on` na zabezpečenie vhodného spustenia a kontroly funkčnosti.
> ⚠️ Tento setup je určený pre produkčné nasadenie a vyžaduje manuálne nastavenie reverzných proxy na zabezpečenie pomocou HTTPS. Pre lokálne testovanie (neodporúčané) je nutné ručne nastaviť DNS záznamy (napr. cez `/etc/hosts`).
## Prerekvizity
### Softvérové požiadavky
Je vyžadovaný iba Docker s Docker Compose. V novších verzách Dockeru je už Compose zabudovaný.
Testované s:
| **Verzia** | **OS** |
|-------------------|--------------------|
| 28.5.2/ecc694264d | linux/arch-cachyos |
| 29.1.1/0aedba5 | linux/debian-lxc |
Ako reverzné proxy môžete použiť napríklad [Caddy](https://caddyserver.com/), [Traefik](https://traefik.io/), [Nginx](https://nginx.org/) alebo [Cloudflare Tunely](https://www.cloudflare.com/products/tunnel/). Odporúčame však Caddy kvôli jednoduchej konfigurácii a automatickému získavaniu SSL certifikátov cez Let's Encrypt, prípadne Cloudflare Tunely pre jednoduché nastavenie bez potreby spravovať DNS záznamy a certifikáty.
### Hardvérové požiadavky (pre build)
| | Minimálne | Odporúčané |
|-----|-----------|------------|
| RAM | 2GB | 4GB |
| CPU | 2 | 4 |
Ak máte iba 2GB RAM, odporúčame nastaviť min 2GB swap pamäte, aby build prebehol úspešne. Prípadne môžete obmedziť počet paralelných buildov.
## Základná inštalácia a nastavenie
### Stiahnutie projektu a buildovanie
Projekt si najprv stiahnite do vami zvoleného priečinka:
```sh
git clone https://github.com/isop-ukf/isop-app.git
```
Podľa potreby prejdite na požadovanú branchu:
```sh
cd isop-app
git checkout [branch]
```
Prejdite do adresára `docker`:
```sh
cd docker
```
Spustite build nasledovným príkazom:
```sh
docker compose build
```
> Počet paralelných buildov môžete obmedziť pomocou `--parallel N` (pred `build`), kde N je počet súčasne bežiacich buildov.
> ⏱️ Build trvá približne 2 min.
> ⚠️ Kvôli kompilácii PHP modulov počas buildu dôjde k zvýšenému využitiu CPU a RAM.
### Nastavenie prostredia
Pred prvým spustením je potrebné vytvoriť súbor `.env` na základe šablóny `.env.example`:
```sh
cp .env.example .env
```
- `BACKEND_URL`: URL adresa backendu **vrátane** protokolu (a prípade portu)
- `FRONTEND_URL`: URL adresa frontendu **vrátane** protokolu (a prípade portu)
- `BACKEND_DOMAIN`: Doména pre backend **bez** protokolu a portu
- `FRONTEND_DOMAIN`: Doména pre frontend **bez** protokolu a portu
- `SESSION_DOMAIN`: Doména pre session cookies, prípadne aj s bodkou na začiatku pre zdieľanie medzi subdoménami
- `APP_KEY`: Aplikačný kľúč pre šifrovanie (postup nižšie)
Príklad `.env` súboru:
```env
BACKEND_URL=https://backend.myapp.com
FRONTEND_URL=https://myapp.com
BACKEND_DOMAIN=backend.myapp.com
FRONTEND_DOMAIN=myapp.com
SESSION_DOMAIN=.myapp.com
APP_KEY=base64:Xxx00XX+X/ABC+AABBCCDDEEFFGGHHXYZ0+00000000=
```
### Vygenerovanie aplikačného kľúča
Aplikačný kľúč môžete vygenerovať pomocou nasledujúceho príkazu:
```sh
docker compose run --rm --no-deps isop-backend php artisan key:generate --show
```
> ⚠️ Odporúčame zmazať vytvorený kontajner po vygenerovaní kľúča.
> ```sh
> docker compose down
> ```
### Spustenie migrácií
Pred prvým spustením aplikácie je potrebné spustiť databázové migrácie príkazmi:
```sh
docker compose up -d isop-backend isop-database
docker compose exec isop-backend php artisan migrate:fresh
docker compose down
```
## Spustenie aplikácie
Aplikáciu spustíte príkazom:
```sh
docker compose up -d
```
Logy môžete sledovať pomocou:
```sh
docker compose logs -f
```
## Zastavenie aplikácie
Aplikáciu zastavíte príkazom:
```sh
docker compose down
```
## Aktualizácia aplikácie
Pre aktualizáciu aplikácie postupujte nasledovne:
1. Stiahnite najnovšie zmeny z repozitára:
```sh
git pull
```
2. Zastavte bežiacu aplikáciu:
```sh
docker compose down
```
3. Znovu postavte kontajnery:
```sh
docker compose build
```
4. Spustite aplikáciu:
```sh
docker compose up -d
```
## Záloha a obnova dát
Dáta aplikácie sú uložené v databáze, ktorú je možné zálohovať a obnoviť pomocou štandardných nástrojov pre MariaDB/MySQL, ako je `mysqldump` a `mysql`, alebo pomcou archivácie dátového adresára databázy.
Príklad na zálohovanie databázy:
```sh
tar czvf db-backup.tar.gz mariadb-data/
```
> ⚠️ Odporúčame použiť `tar` na archiváciu dátového adresára, aby ste zachovali správne oprávnenia.
## Zabezpečenie
## Cloudflare Tunnel
Inštaláciu a základné nastavenie nájdete v [dokumentácii Cloudflare](https://developers.cloudflare.com/cloudflare-one/networks/connectors/cloudflare-tunnel/). Je potrebné vytvoriť 2 tunely - jeden pre frontend a druhý pre backend.
Na spustenie tunela môžete vytvoriť samostatný Docker Compose súbor, napríklad:
```yaml
services:
tunnel:
image: cloudflare/cloudflared:2025.11.1
container_name: cloudflared-tunnel
restart: unless-stopped
network_mode: "host"
command: tunnel run
environment:
- TUNNEL_TOKEN=TOKEN-XYZ
```
Následne nastavne DNS záznamy vo vašom Cloudflare účte, aby smerovali na tunely, napríklad:
- `myapp.com` -> `localhost:80`
- `backend.myapp.com` -> `localhost:8111`
## Caddy
Inštaláciu a základné nastavenie nájdete v [dokumentácii Caddy](https://caddyserver.com/docs/).
Príklad konfigurácie:
```
backend.myapp.com {
reverse_proxy localhost:8111
}
myapp.com {
reverse_proxy localhost:80
}
```

83
docker/docker-compose.yml Normal file
View File

@@ -0,0 +1,83 @@
services:
isop-frontend:
container_name: isop-frontend
build:
context: ../frontend
dockerfile: Dockerfile
restart: unless-stopped
environment:
NUXT_PUBLIC_SANCTUM_BASE_URL: ${BACKEND_URL:-https://backend.example.com}
ports:
- 80:80
depends_on:
- isop-backend
healthcheck:
test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost"]
start_period: 10s
interval: 1m
timeout: 5s
retries: 5
isop-backend:
container_name: isop-backend
build:
context: ../backend
dockerfile: Dockerfile
restart: unless-stopped
environment:
APP_NAME: ISOP
APP_ENV: production
APP_KEY: ${APP_KEY:-SOME-KEY}
APP_DEBUG: false
APP_URL: ${BACKEND_URL:-https://example.com}
FRONTEND_URL: ${FRONTEND_URL:-https://example.com}
SANCTUM_STATEFUL_DOMAINS: ${BACKEND_DOMAIN:-https://backend.example.com},${FRONTEND_DOMAIN:-https://example.com}
SESSION_DOMAIN: ${SESSION_DOMAIN:-.example.com} # Note the first dot
APP_LOCALE: sk
APP_FALLBACK_LOCALE: en_US
MAIL_MAILER: smtp
MAIL_HOST: smtp.example.com
MAIL_PORT: 2525
MAIL_USERNAME: username
MAIL_PASSWORD: password
MAIL_FROM_ADDRESS: "noreply@example.com"
MAIL_FROM_NAME: "ISOP"
DB_CONNECTION: mariadb
DB_HOST: isop-database
DB_PORT: 3306
DB_DATABASE: isop
DB_USERNAME: root
DB_PASSWORD: admin
ports:
- 8111:80
depends_on:
isop-database:
condition: service_healthy
healthcheck:
test: ["CMD", "wget", "--no-verbose", "--tries=1", "--spider", "http://localhost/api"]
start_period: 10s
interval: 1m
timeout: 5s
retries: 5
isop-database:
container_name: isop-database
image: mariadb:11.8.2-noble
restart: unless-stopped
cap_add:
# Allow memory binding
- SYS_NICE
environment:
MARIADB_DATABASE: "isop"
MARIADB_ROOT_PASSWORD: "admin"
volumes:
- ./mariadb_data:/var/lib/mysql
healthcheck:
test: [ "CMD", "healthcheck.sh", "--su-mysql", "--connect", "--innodb_initialized" ]
start_period: 10s
interval: 1m
timeout: 5s
retries: 3

8
frontend/.dockerignore Normal file
View File

@@ -0,0 +1,8 @@
.nuxt/
.output/
.env*
node_modules/
cypress/
cypress.config.ts
package-lock.json
*.md

37
frontend/Dockerfile Normal file
View File

@@ -0,0 +1,37 @@
# Build Stage 1
FROM node:22-alpine AS build
WORKDIR /app
RUN corepack enable
# Copy package.json and your lockfile
COPY package.json ./
# Install dependencies
RUN pnpm i
# Copy the entire project
COPY . ./
# Prepare Nuxt (generates .nuxt with type definitions and auto-imports)
RUN pnpm run postinstall
# Build the project
RUN pnpm run build
# Build Stage 2
FROM node:22-alpine
WORKDIR /app
# Only `.output` folder is needed from the build stage
COPY --from=build /app/.output/ ./
# Change the port and host
ENV PORT=80
ENV HOST=0.0.0.0
EXPOSE 80
CMD ["node", "/app/server/index.mjs"]

View File

@@ -22,8 +22,6 @@ export default defineNuxtConfig({
},
sanctum: {
baseUrl: 'http://localhost:8000',
origin: 'http://localhost:3000',
redirect: {
onLogin: '/dashboard',
onLogout: "/",