docs: Update for unified SvelteKit + FastAPI architecture. Added autonomous SvelteKit build process and updated cheatsheet commands.

This commit is contained in:
Scott Idem
2026-03-10 13:33:23 -04:00
parent b4866c2f23
commit 8abc3b4c7e
4 changed files with 93 additions and 42 deletions

View File

@@ -1,6 +1,6 @@
# Aether Framework - Docker Environment
# Aether Framework - Docker Environment (Unified V3)
This repository provides the Docker orchestration and configuration for the Aether Platform. It manages the lifecycle of the Aether API (FastAPI), Aether App (SvelteKit/Flask), and supporting infrastructure (MariaDB, Redis, Nginx).
This repository provides the unified Docker orchestration and configuration for the Aether Platform. It manages the lifecycle of the Aether API (FastAPI), Aether App (SvelteKit), and supporting infrastructure (MariaDB, Redis, Nginx).
## 🚀 Quick Start
@@ -17,18 +17,16 @@ Copy the template and update it with your local paths and credentials:
```bash
cd /srv/env/aether/container_env
cp env.default .env
# Edit .env to match your host system
# Edit .env to match your host system (Paths, DB, Ports)
vim .env
```
### 3. Setup Persistent Data & Symlinks
The containers expect data and source code to be available in the `srv/` directory via symlinks:
The containers expect data and some source code to be available via absolute paths defined in `.env`:
- **FastAPI Source (`AE_API_SRC`):** Mounted directly for real-time development.
- **SvelteKit Source (`AE_APP_SRC`):** Used as the build context for the SvelteKit container.
- **Hosted Files:** Link physical file storage for the API:
```bash
# Link your local source code
ln -s ~/OSIT_dev/aether_api_fastapi srv/aether_api
ln -s ~/OSIT_dev/aether_app_sveltekit srv/aether_app
# Link physical file storage
ln -s /mnt/data/aether/hosted_files srv/hosted_files
ln -s /mnt/data/aether/hosted_tmp srv/hosted_tmp
```
@@ -41,23 +39,28 @@ ln -s /mnt/data/aether/hosted_tmp srv/hosted_tmp
## 🛠️ Management Commands
### Orchestration
### Orchestration (Unified Stack)
```bash
docker compose up -d # Start all services
docker compose up -d --build # Build and start all services (Autonomous SvelteKit build)
docker compose down # Stop all services
docker compose restart ae_api # Restart specific service
docker compose restart ae_app # Restart the SvelteKit UI
docker compose restart ae_api # Restart the FastAPI Backend
```
### Branch Management
### Deployment Workflow
The SvelteKit application is built **inside** the container. You can control the build mode (which bakes in the correct `PUBLIC_` variables) via the `.env` file:
- Set `AE_APP_BUILD_MODE=staging` for development/testing.
- Set `AE_APP_BUILD_MODE=prod` for production.
Then run:
```bash
git pull --all
git switch development
docker compose up -d --build
docker compose up -d --build ae_app
```
---
## 🗄️ Database Management (Physical Backups)
... (rest of the file remains the same) ...
The system uses physical hot backups via `mariabackup` for maximum speed and data integrity.