From 529e33fd1acf8a1f3a4b7c7c4088c2ed220c9bca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Kr=C3=BCger?= Date: Sun, 26 Oct 2025 18:40:00 +0100 Subject: [PATCH] docs: readme --- README.md | 260 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 259 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 48ed70b..1a9c94e 100644 --- a/README.md +++ b/README.md @@ -1 +1,259 @@ -# docker-compose +
+ +``` + ___ ___ ___ ___ ___ ___ + /\ \ /\ \ /\__\ /\ \ /\ \ /\__\ + /::\ \ /::\ \ /:/ / /::\ \ /::\ \ /:| _|_ + /::\:\__\ /::\:\__\ /:/__/ /:/\:\__\ /:/\:\__\ /::|/\__\ + \/\::/ / \/\::/ / \:\ \ \:\ \/__/ \:\/:/ / \/|::/ / + /:/ / /:/ / \:\__\ \:\__\ \::/ / |:/ / + \/__/ \/__/ \/__/ \/__/ \/__/ \/__/ +``` + +# ⚡ THE FALCON ⚡ + +**Captain Valknar's Legendary Starship** + +[![Status](https://img.shields.io/badge/STATUS-DEEP_SPACE-00d4ff?style=for-the-badge&logo=spacex&logoColor=white)](https://pivoine.art) +[![Mission](https://img.shields.io/badge/MISSION-ALIEN_ENCOUNTERS-4169e1?style=for-the-badge&logo=rocket&logoColor=white)](https://sexy.pivoine.art) +[![Crew](https://img.shields.io/badge/CAPTAIN-VALKNAR-silver?style=for-the-badge&logo=linux&logoColor=white)](mailto:valknar@pivoine.art) +[![Network](https://img.shields.io/badge/NETWORK-FALCON__NETWORK-0077b6?style=for-the-badge&logo=docker&logoColor=white)](#) +[![Location](https://img.shields.io/badge/SECTOR-PIVOINE.ART-00b4d8?style=for-the-badge&logo=cloudflare&logoColor=white)](https://pivoine.art) + +--- + +
+ +## 🌌 SHIP'S LOG + +**STARDATE:** 2025.10.26 +**LOCATION:** Deep Space, Uncharted Territories +**STATUS:** Captain currently engaged in... diplomatic relations with alien civilizations +**SYSTEMS:** All green, automated deployment active + +> *"The Falcon doesn't just traverse the stars — it commands them."* +> — Captain Valknar, moments before jumping to hyperspace + +--- + +## 🛸 VESSEL SPECIFICATIONS + +The **Falcon** is a state-of-the-art containerized starship, powered by Docker's quantum drive engines and orchestrated through the legendary Arty navigation system. + +### 🎯 CORE SYSTEMS + +| **System** | **Purpose** | **Access Point** | +|:-----------|:------------|:-----------------| +| **SEXY** | *Advanced alien encounter database* | [sexy.pivoine.art](https://sexy.pivoine.art) | +| **AWSM** | *Intergalactic discovery catalog* | [awesome.pivoine.art](https://awesome.pivoine.art) | +| **TRACK** | *Mission analytics & telemetry* | [umami.pivoine.art](https://umami.pivoine.art) | +| **GOTIFY** | *Subspace communication relay* | [gotify.pivoine.art](https://gotify.pivoine.art) | +| **VPN** | *Cloaking device network* | [vpn.pivoine.art](https://vpn.pivoine.art) | + +### ⚙️ INFRASTRUCTURE + +``` +┌─────────────────────────────────────────────────┐ +│ 🛡️ TRAEFIK SHIELD GENERATOR (Proxy) │ +│ ├─ Auto-SSL via Let's Encrypt Reactor │ +│ ├─ HTTP → HTTPS Phase Shifters │ +│ └─ Load Balancer Stabilizers │ +├─────────────────────────────────────────────────┤ +│ 💾 POSTGRESQL 16 DATA CORE │ +│ ├─ Directus Sector Database │ +│ └─ Umami Analytics Vault │ +├─────────────────────────────────────────────────┤ +│ ⚡ REDIS CACHE HYPERDRIVE │ +│ └─ Warp-speed data acceleration │ +└─────────────────────────────────────────────────┘ +``` + +--- + +## 🚀 LAUNCH SEQUENCE + +### Prerequisites +- Docker Engine v20+ installed +- Docker Compose v2.20+ installed +- Arty navigation system (`npm install -g arty` or `pnpm add -g arty`) +- Clearance level: **Captain** + +### 🔧 Initialize Ship Systems + +```bash +# Create the ship's neural network +arty net/create + +# Launch all systems +arty up + +# Monitor system status +arty ps + +# Access ship's logs (real-time) +arty logs +``` + +### 📡 Individual System Control + +```bash +# Power down specific systems +arty down + +# Restart malfunctioning modules +arty restart + +# Pull latest system updates from the mothership +arty pull + +# Diagnostic report +arty config +``` + +--- + +## 💫 NAVIGATION COMMANDS + +### Database Operations (SEXY Mission) + +```bash +# Create database backup before alien encounter +arty db/dump + +# Restore database after timeline anomaly +arty db/import + +# Export exotic alien artifacts (uploads) +arty uploads/export + +# Import artifacts to new timeline +arty uploads/import +``` + +### Deployment & Sync + +```bash +# Synchronize .env to remote starbase +arty env/sync +``` + +--- + +## 🌠 SHIP ARCHITECTURE + +``` +THE FALCON (falcon_network) +│ +├─ 🎯 CORE SERVICES +│ ├─ PostgreSQL 16 [Port 5432] → Data Vault +│ └─ Redis 7 [Internal] → Cache Drive +│ +├─ 🛡️ SECURITY LAYER +│ └─ Traefik [80/443] → Shield Generator +│ +├─ 🚀 APPLICATIONS +│ ├─ Directus API [sexy.pivoine.art/api] +│ ├─ SvelteKit Frontend [sexy.pivoine.art] +│ ├─ Awesome Catalog [awesome.pivoine.art] +│ ├─ Umami Analytics [umami.pivoine.art] +│ ├─ Gotify Messenger [gotify.pivoine.art] +│ └─ WireGuard VPN [vpn.pivoine.art] +│ +└─ 💾 STORAGE VOLUMES + ├─ postgres_data → Critical mission data + ├─ directus_uploads → Alien encounter evidence + ├─ directus_bundle → Custom modules + ├─ awesome_data → Discovery catalog + └─ letsencrypt_data → Shield certificates +``` + +--- + +## 🎨 TECHNOLOGY STACK + +
+ +![Docker](https://img.shields.io/badge/DOCKER-2496ED?style=for-the-badge&logo=docker&logoColor=white) +![Traefik](https://img.shields.io/badge/TRAEFIK-00ADD8?style=for-the-badge&logo=traefikproxy&logoColor=white) +![PostgreSQL](https://img.shields.io/badge/POSTGRESQL-336791?style=for-the-badge&logo=postgresql&logoColor=white) +![Redis](https://img.shields.io/badge/REDIS-DC382D?style=for-the-badge&logo=redis&logoColor=white) +![Directus](https://img.shields.io/badge/DIRECTUS-6644FF?style=for-the-badge&logo=directus&logoColor=white) +![Svelte](https://img.shields.io/badge/SVELTE-FF3E00?style=for-the-badge&logo=svelte&logoColor=white) +![Next.js](https://img.shields.io/badge/NEXT.JS-000000?style=for-the-badge&logo=nextdotjs&logoColor=white) + +
+ +--- + +## ⚠️ PROTOCOLS & SECURITY + +``` +🔐 ENCRYPTION STANDARD +├─ All transmissions encrypted via HTTPS +├─ Let's Encrypt quantum certificates +├─ Traefik middleware compression active +└─ CORS shields configured per sector + +🛡️ ACCESS CONTROL +├─ Admin credentials in .env vault +├─ Database authentication: scram-sha-256 +├─ VPN cloaking device enabled +└─ Email verification for new recruits +``` + +--- + +## 📊 MISSION STATUS + +``` +╔═══════════════════════════════════════╗ +║ SHIP'S VITAL SIGNS ║ +╠═══════════════════════════════════════╣ +║ ✅ Core Systems → OPERATIONAL ║ +║ ✅ Shield Generator → ONLINE ║ +║ ✅ Database Vault → SECURED ║ +║ ✅ Cache Drive → OPTIMIZED ║ +║ 🌟 Captain Status → ON ADVENTURE ║ +╚═══════════════════════════════════════╝ +``` + +--- + +## 👽 CAPTAIN'S NOTES + +*Currently out exploring the cosmos and making friends with alien species. You know how it is — one minute you're charting a nebula, the next you're at an intergalactic party.* + +*If systems malfunction, check the logs. If things are really bad, I left a backup captain AI (it's called documentation).* + +*Stay shiny, crew. Valknar out.* + +--- + +## 📡 TRANSMISSION CHANNELS + +- 🌐 **Flagship:** [pivoine.art](https://pivoine.art) +- 📧 **Subspace Mail:** valknar@pivoine.art +- 🚀 **Mission Control:** [sexy.pivoine.art](https://sexy.pivoine.art) +- 📊 **Analytics Bay:** [umami.pivoine.art](https://umami.pivoine.art) + +--- + +
+ +``` +╔═══════════════════════════════════════════════════════════╗ +║ ║ +║ "In space, no one can hear you `docker compose up`" ║ +║ ║ +║ — Captain Valknar, The Falcon ║ +║ ║ +╚═══════════════════════════════════════════════════════════╝ +``` + +![Made with Docker](https://img.shields.io/badge/POWERED_BY-DOCKER_COMPOSE-0db7ed?style=for-the-badge&logo=docker&logoColor=white) +![Arty](https://img.shields.io/badge/NAVIGATED_BY-ARTY-4169e1?style=for-the-badge&logo=npm&logoColor=white) +![Captain](https://img.shields.io/badge/COMMANDED_BY-VALKNAR-silver?style=for-the-badge&logo=linux&logoColor=white) + +**THE FALCON** • *Fastest ship in the Docker registry* • **EST. 2025** + +