diff --git a/Projects/kompose/docs/content/docs/guide/database.md b/Projects/kompose/docs/content/docs/guide/database.md index 7f94dde9..ea67da16 100644 --- a/Projects/kompose/docs/content/docs/guide/database.md +++ b/Projects/kompose/docs/content/docs/guide/database.md @@ -11,19 +11,19 @@ description: Export, import, and manage PostgreSQL databases - **Cleanup utilities**: Keep only the latest dumps, remove old backups - **Hook integration**: Custom pre/post operations for each database action -### πŸͺ Extensibility +### hook Extensibility - **Custom hooks**: Define `pre_db_export`, `post_db_export`, `pre_db_import`, `post_db_import` - **Stack-specific logic**: Each stack can have unique operational requirements - **Environment access**: Hooks inherit all environment variables - **Dry-run aware**: Test hook execution without side effects -### 🌐 Network Management +### network Network Management - **Unified network**: All stacks communicate on a single Docker network - **CLI overrides**: Change network on-the-fly without editing configs - **Traefik integration**: Seamless reverse proxy setup with proper network awareness - **Multi-network support**: Special stacks can have additional internal networks -### πŸ”§ Environment Control +### tools Environment Control - **Global overrides**: Set environment variables via CLI flags - **Layered configs**: Root `.env` + stack `.env` + CLI overrides - **Precedence rules**: CLI > Stack > Root configuration hierarchy diff --git a/Projects/kompose/docs/content/docs/guide/hooks.md b/Projects/kompose/docs/content/docs/guide/hooks.md index 31199dd1..758b98a9 100644 --- a/Projects/kompose/docs/content/docs/guide/hooks.md +++ b/Projects/kompose/docs/content/docs/guide/hooks.md @@ -77,14 +77,14 @@ The `sexy` stack uses hooks for Directus schema management: ### Hook Best Practices -βœ… **DO:** +check **DO:** - Return 0 for success, 1 for failure - Use indented output: `echo " Message"` - Make non-critical operations return 0 - Check container status before `docker exec` - Test in dry-run mode first -❌ **DON'T:** +cancel **DON'T:** - Assume containers are running - Use blocking operations without timeouts - Forget error handling diff --git a/Projects/kompose/docs/content/docs/guide/quick-start.md b/Projects/kompose/docs/content/docs/guide/quick-start.md index 35a84e7f..308d77c4 100644 --- a/Projects/kompose/docs/content/docs/guide/quick-start.md +++ b/Projects/kompose/docs/content/docs/guide/quick-start.md @@ -25,5 +25,5 @@ chmod +x kompose.sh # Export all databases ./kompose.sh "*" db:export -# That's it! πŸŽ‰ +# That's it! celebration ``` diff --git a/Projects/kompose/docs/content/docs/guide/troubleshooting.md b/Projects/kompose/docs/content/docs/guide/troubleshooting.md index ebf191b4..949ce42a 100644 --- a/Projects/kompose/docs/content/docs/guide/troubleshooting.md +++ b/Projects/kompose/docs/content/docs/guide/troubleshooting.md @@ -7,7 +7,7 @@ description: Common issues and solutions ### Common Issues -#### 🚫 404 Error from Traefik +#### error 404 Error from Traefik **Problem:** Websites return 404 even though containers are running @@ -33,7 +33,7 @@ http://your-server:8080 docker inspect blog_app | grep traefik ``` -#### πŸ’Ύ Database Import Fails +#### database Database Import Fails **Problem:** `db:import` command fails @@ -55,7 +55,7 @@ ls -lh news/*.sql ./kompose.sh news db:import 2>&1 | tee import.log ``` -#### πŸ”Œ Container Won't Connect to Network +#### connection Container Won't Connect to Network **Problem:** Container fails to join kompose network @@ -70,7 +70,7 @@ docker network create kompose ./kompose.sh "*" up -d ``` -#### πŸͺ Hooks Not Executing +#### hook Hooks Not Executing **Problem:** Custom hooks aren't running diff --git a/Projects/kompose/docs/content/docs/index.md b/Projects/kompose/docs/content/docs/index.md index 7076a49f..c10ba8a1 100644 --- a/Projects/kompose/docs/content/docs/index.md +++ b/Projects/kompose/docs/content/docs/index.md @@ -11,40 +11,40 @@ description: Learn about Kompose, your Docker Compose Symphony Conductor for man ### Why Kompose? -🎯 **One Command to Rule Them All** - Manage dozens of stacks with a single command -πŸ”„ **Database Wizardry** - Export, import, and clean up PostgreSQL databases like a boss -πŸŽͺ **Hook System** - Extend functionality with custom pre/post operation hooks -🌐 **Network Maestro** - Smart network management with CLI overrides -πŸ” **Environment Juggler** - Override any environment variable on the fly -🎨 **Beautiful Output** - Color-coded logs and status indicators -πŸ§ͺ **Dry-Run Mode** - Test changes before applying them +target **One Command to Rule Them All** - Manage dozens of stacks with a single command +reload **Database Wizardry** - Export, import, and clean up PostgreSQL databases like a boss +tent **Hook System** - Extend functionality with custom pre/post operation hooks +network **Network Maestro** - Smart network management with CLI overrides +lock **Environment Juggler** - Override any environment variable on the fly +colors **Beautiful Output** - Color-coded logs and status indicators +test **Dry-Run Mode** - Test changes before applying them -### 🎼 Stack Management +### music Stack Management - **Pattern-based selection**: Target stacks with globs, comma-separated lists, or wildcards - **Bulk operations**: Execute commands across multiple stacks simultaneously - **Status monitoring**: Visual feedback with color-coded success/failure indicators - **Smart filtering**: Include/exclude stacks with flexible pattern matching -### πŸ’Ύ Database Operations +### database Database Operations - **Automated backups**: Export PostgreSQL databases with timestamped dumps - **Smart imports**: Auto-detect latest dumps or specify exact files - **Drop & recreate**: Safe database import with connection termination - **Cleanup utilities**: Keep only the latest dumps, remove old backups - **Hook integration**: Custom pre/post operations for each database action -### πŸͺ Extensibility +### hook Extensibility - **Custom hooks**: Define `pre_db_export`, `post_db_export`, `pre_db_import`, `post_db_import` - **Stack-specific logic**: Each stack can have unique operational requirements - **Environment access**: Hooks inherit all environment variables - **Dry-run aware**: Test hook execution without side effects -### 🌐 Network Management +### network Network Management - **Unified network**: All stacks communicate on a single Docker network - **CLI overrides**: Change network on-the-fly without editing configs - **Traefik integration**: Seamless reverse proxy setup with proper network awareness - **Multi-network support**: Special stacks can have additional internal networks -### πŸ”§ Environment Control +### tools Environment Control - **Global overrides**: Set environment variables via CLI flags - **Layered configs**: Root `.env` + stack `.env` + CLI overrides - **Precedence rules**: CLI > Stack > Root configuration hierarchy diff --git a/Projects/kompose/docs/content/docs/reference/cli.md b/Projects/kompose/docs/content/docs/reference/cli.md index 6447e5dc..234865aa 100644 --- a/Projects/kompose/docs/content/docs/reference/cli.md +++ b/Projects/kompose/docs/content/docs/reference/cli.md @@ -116,7 +116,7 @@ Import PostgreSQL database from SQL dump file. ./kompose.sh db:import path/to/dump.sql ``` -**⚠️ WARNING:** Drops and recreates the database! +**warning WARNING:** Drops and recreates the database! ### db:cleanup diff --git a/Projects/kompose/docs/content/docs/reference/environment.md b/Projects/kompose/docs/content/docs/reference/environment.md index b0f14faa..ca026719 100644 --- a/Projects/kompose/docs/content/docs/reference/environment.md +++ b/Projects/kompose/docs/content/docs/reference/environment.md @@ -107,17 +107,17 @@ DB_HOST=news-postgres # Overrides root ### Security -- βœ… Use strong, random passwords -- βœ… Never commit `.env` files to version control -- βœ… Use `.env.example` as template -- βœ… Rotate secrets regularly +- check Use strong, random passwords +- check Never commit `.env` files to version control +- check Use `.env.example` as template +- check Rotate secrets regularly ### Organization -- βœ… Document custom variables -- βœ… Group related variables -- βœ… Use consistent naming -- βœ… Keep defaults in root `.env` +- check Document custom variables +- check Group related variables +- check Use consistent naming +- check Keep defaults in root `.env` ## Generating Secrets diff --git a/Projects/kompose/docs/content/docs/stacks/auth.md b/Projects/kompose/docs/content/docs/stacks/auth.md index 3c3681ae..49a1ecd8 100644 --- a/Projects/kompose/docs/content/docs/stacks/auth.md +++ b/Projects/kompose/docs/content/docs/stacks/auth.md @@ -3,7 +3,7 @@ title: Auth Stack - The Bouncer at Your Digital Club description: "You shall not pass... without proper credentials!" --- -# πŸ” Auth Stack - The Bouncer at Your Digital Club +# lock Auth Stack - The Bouncer at Your Digital Club > *"You shall not pass... without proper credentials!"* - Keycloak, probably @@ -13,18 +13,18 @@ This stack is your authentication and identity management powerhouse. Think of i ## The Star of the Show -### 🎭 Keycloak +### theater Keycloak **Container**: `auth_keycloak` **Image**: `quay.io/keycloak/keycloak:latest` **Home**: https://auth.pivoine.art Keycloak is like having a Swiss Army knife for authentication. It handles: -- πŸ‘€ **Single Sign-On (SSO)**: Log in once, access everything. Magic! -- 🎫 **Identity Brokering**: Connect with Google, GitHub, and other OAuth providers -- πŸ‘₯ **User Management**: Keep track of who's who in your digital zoo -- πŸ”’ **OAuth 2.0 & OpenID Connect**: Industry-standard security protocols (the fancy stuff) -- πŸ›‘οΈ **Authorization Services**: Fine-grained control over who can do what +- user **Single Sign-On (SSO)**: Log in once, access everything. Magic! +- ticket **Identity Brokering**: Connect with Google, GitHub, and other OAuth providers +- users **User Management**: Keep track of who's who in your digital zoo +- security **OAuth 2.0 & OpenID Connect**: Industry-standard security protocols (the fancy stuff) +- shield **Authorization Services**: Fine-grained control over who can do what ## Configuration Breakdown @@ -53,11 +53,11 @@ Running in `edge` mode because we're living on the edge (behind Traefik)! This t | Variable | What It Does | Cool Factor | |----------|-------------|-------------| -| `KC_DB` | Database type (postgres) | 🐘 Elephants never forget | -| `KC_DB_URL` | JDBC connection string | πŸ”Œ The digital umbilical cord | -| `KC_HOSTNAME` | Public-facing URL | 🌐 Your internet identity | -| `KC_PROXY` | Proxy mode setting | 🎭 Trust the middleman | -| `KC_FEATURES` | Enabled features (docker) | 🐳 Whale hello there! | +| `KC_DB` | Database type (postgres) | elephant Elephants never forget | +| `KC_DB_URL` | JDBC connection string | plug The digital umbilical cord | +| `KC_HOSTNAME` | Public-facing URL | globe Your internet identity | +| `KC_PROXY` | Proxy mode setting | proxy Trust the middleman | +| `KC_FEATURES` | Enabled features (docker) | docker Whale hello there! | ## Ports & Networking @@ -119,13 +119,13 @@ A: Clear your browser cache, Keycloak loves to cache things **Q: Database connection issues?** A: Ensure the `data` stack is running and healthy -## Security Notes πŸ”’ +## Security Notes security -- 🚨 **Change the default admin password** (seriously, do it now) -- πŸ” Database credentials are shared via root `.env` -- 🌐 Always access via HTTPS in production -- πŸ“ Enable audit logging for compliance -- 🎯 Use realms to separate different applications/teams +- alert **Change the default admin password** (seriously, do it now) +- lock Database credentials are shared via root `.env` +- globe Always access via HTTPS in production +- log Enable audit logging for compliance +- target Use realms to separate different applications/teams ## Fun Facts @@ -142,4 +142,4 @@ A: Ensure the `data` stack is running and healthy --- -*Remember: With great authentication power comes great responsibility. Don't be the person who uses "admin/admin" in production.* πŸ¦Έβ€β™‚οΈ +*Remember: With great authentication power comes great responsibility. Don't be the person who uses "admin/admin" in production.* hero