Refactor deployment process to use prebuilt Docker images
All checks were successful
PostgreSQL Compatibility Matrix / PG14 smoke (push) Successful in 8s
PostgreSQL Compatibility Matrix / PG15 smoke (push) Successful in 8s
PostgreSQL Compatibility Matrix / PG16 smoke (push) Successful in 8s
PostgreSQL Compatibility Matrix / PG17 smoke (push) Successful in 8s
PostgreSQL Compatibility Matrix / PG18 smoke (push) Successful in 8s
All checks were successful
PostgreSQL Compatibility Matrix / PG14 smoke (push) Successful in 8s
PostgreSQL Compatibility Matrix / PG15 smoke (push) Successful in 8s
PostgreSQL Compatibility Matrix / PG16 smoke (push) Successful in 8s
PostgreSQL Compatibility Matrix / PG17 smoke (push) Successful in 8s
PostgreSQL Compatibility Matrix / PG18 smoke (push) Successful in 8s
Replaced local builds with prebuilt backend and frontend Docker images for simplified deployment. Updated documentation and Makefile to reflect the changes and added a bootstrap script for quick setup of deployment files. Removed deprecated `VITE_API_URL` variable and references to streamline the setup.
This commit is contained in:
58
README.md
58
README.md
@@ -9,7 +9,7 @@ It combines FastAPI, React, and PostgreSQL in a Docker Compose stack with RBAC,
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Quick Start](#quick-start)
|
||||
- [Quick Deploy (Prebuilt Images)](#quick-deploy-prebuilt-images)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Make Commands](#make-commands)
|
||||
- [Configuration Reference (`.env`)](#configuration-reference-env)
|
||||
@@ -93,27 +93,50 @@ Optional:
|
||||
|
||||
- `psql` for manual DB checks
|
||||
|
||||
## Quick Start
|
||||
## Quick Deploy (Prebuilt Images)
|
||||
|
||||
1. Copy environment template:
|
||||
If you only want to run NexaPG from published Docker Hub images, use the bootstrap script:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
mkdir -p /opt/NexaPG
|
||||
cd /opt/NexaPG
|
||||
wget -O bootstrap-compose.sh https://git.nesterovic.cc/nessi/NexaPG/raw/branch/main/ops/scripts/bootstrap-compose.sh
|
||||
chmod +x bootstrap-compose.sh
|
||||
./bootstrap-compose.sh
|
||||
```
|
||||
|
||||
2. Generate a Fernet key and set `ENCRYPTION_KEY` in `.env`:
|
||||
This downloads:
|
||||
|
||||
- `docker-compose.yml`
|
||||
- `.env.example`
|
||||
- `Makefile`
|
||||
|
||||
Then:
|
||||
|
||||
```bash
|
||||
# generate JWT secret
|
||||
python -c "import secrets; print(secrets.token_urlsafe(64))"
|
||||
# generate Fernet encryption key
|
||||
python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
|
||||
```
|
||||
|
||||
3. Start the stack:
|
||||
|
||||
```bash
|
||||
# put both values into .env (JWT_SECRET_KEY / ENCRYPTION_KEY)
|
||||
# note: .env is auto-created by bootstrap if it does not exist
|
||||
make up
|
||||
```
|
||||
|
||||
4. Open the application:
|
||||
Manual download alternative:
|
||||
|
||||
```bash
|
||||
mkdir -p /opt/NexaPG
|
||||
cd /opt/NexaPG
|
||||
wget https://git.nesterovic.cc/nessi/NexaPG/raw/branch/main/docker-compose.yml
|
||||
wget https://git.nesterovic.cc/nessi/NexaPG/raw/branch/main/.env.example
|
||||
wget https://git.nesterovic.cc/nessi/NexaPG/raw/branch/main/Makefile
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
`make up` pulls `nesterovicit/nexapg-backend:latest` and `nesterovicit/nexapg-frontend:latest`, then starts the stack.
|
||||
|
||||
Open the application:
|
||||
|
||||
- Frontend: `http://<SERVER_IP>:<FRONTEND_PORT>`
|
||||
- API base: `http://<SERVER_IP>:<BACKEND_PORT>/api/v1`
|
||||
@@ -127,7 +150,7 @@ Initial admin bootstrap user (created from `.env` if missing):
|
||||
## Make Commands
|
||||
|
||||
```bash
|
||||
make up # build and start all services
|
||||
make up # pull latest images and start all services
|
||||
make down # stop all services
|
||||
make logs # follow compose logs
|
||||
make migrate # optional/manual: run alembic upgrade head in backend container
|
||||
@@ -183,12 +206,6 @@ Note: Migrations run automatically when the backend container starts (`entrypoin
|
||||
| Variable | Description |
|
||||
|---|---|
|
||||
| `FRONTEND_PORT` | Host port mapped to frontend container port `80` |
|
||||
| `VITE_API_URL` | Frontend API base URL (build-time) |
|
||||
|
||||
Recommended values for `VITE_API_URL`:
|
||||
|
||||
- Reverse proxy setup: `/api/v1`
|
||||
- Direct backend access: `http://<SERVER_IP>:<BACKEND_PORT>/api/v1`
|
||||
|
||||
## Core Functional Areas
|
||||
|
||||
@@ -318,7 +335,7 @@ For production, serve frontend and API under the same public origin via reverse
|
||||
|
||||
- Frontend URL example: `https://monitor.example.com`
|
||||
- Proxy API path `/api/` to backend service
|
||||
- Use `VITE_API_URL=/api/v1`
|
||||
- Route `/api/v1` to the backend service
|
||||
|
||||
This prevents mixed-content and CORS issues.
|
||||
|
||||
@@ -351,8 +368,7 @@ docker compose logs --tail=200 db
|
||||
|
||||
### CORS or mixed-content issues behind SSL proxy
|
||||
|
||||
- Set `VITE_API_URL=/api/v1`
|
||||
- Ensure proxy forwards `/api/` to backend
|
||||
- Ensure proxy forwards `/api/` (or `/api/v1`) to backend
|
||||
- Set correct frontend origin(s) in `CORS_ORIGINS`
|
||||
|
||||
### `rejected SSL upgrade` for a target
|
||||
|
||||
Reference in New Issue
Block a user