diff --git a/Netgrimoire/Services/manyfold/manyfold.md b/Netgrimoire/Services/manyfold/manyfold.md index 329f741..b9c4322 100644 --- a/Netgrimoire/Services/manyfold/manyfold.md +++ b/Netgrimoire/Services/manyfold/manyfold.md @@ -1,40 +1,37 @@ -# manyfold Stack +# manyfold -manyfold service provides a web-based interface for users to interact with their models. +## Overview +The manyfold stack is a Docker Swarm configuration for the Manyfold service, providing an application server for NetGrimoire users. The stack consists of services such as app, postgres, and redis, which work together to provide a scalable and performant user interface. --- ## Architecture | Service | Image | Port | Role | -|---------|-------|------|------| -- **Postgres:** docker4:postgres:15 | 5432 | Database Server | -- **Redis:** docker4:redis:7 | 6379 | Cache Server | -- **Manyfold App:** docker4:manyfold:latest | 3214 | Web Interface | - -Exposed via Caddy domains: -- `https://app.netgrimoire.com` - -Homepage group: New +|- **Host:** docker4 | +|- **Network:** netgrimoire | +|- **Exposed via:** | +- **Homepage group:** New | --- ## Build & Configuration ### Prerequisites -To build and deploy the manyfold stack, ensure that you have a compatible Docker environment with Docker Swarm enabled. +This stack requires the .env file to be in the same directory as the swarm configuration. ### Volume Setup ```bash -mkdir -p /DockerVol/manyfold -chown -R $PUID:$PGID /DockerVol/manyfold +mkdir -p /DockerVol/app +chmod -R 755 /DockerVol/app ``` ### Environment Variables ```bash # generate: openssl rand -hex 32 -# PUID: 1964 -# PGID: 1964 -# SECRET_KEY_BASE: OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK +PUID=1964 +PGID=1964 +SECRET_KEY_BASE=OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK +REDIS_URL=redis://redis:6379/1 ``` ### Deploy @@ -48,7 +45,7 @@ docker stack services manyfold ``` ### First Run -After deploying the stack, ensure that you can access the Manyfold app by visiting `https://app.netgrimoire.com` in your web browser. +After the initial deployment, make sure to check the logs of the app service for any errors. --- @@ -56,29 +53,28 @@ After deploying the stack, ensure that you can access the Manyfold app by visiti ### Accessing manyfold | Service | URL | Purpose | -|---------|-----|---------| -- **Manyfold App:** https://app.netgrimoire.com | Web Interface | +|- **Service** | **URL** | **Purpose** | +- | ### Primary Use Cases -To get started with the Manyfold app, follow these steps: +This stack is designed to provide a scalable and performant user interface for NetGrimoire users. -1. Visit `https://app.netgrimoire.com` in your web browser. -2. Enter your credentials to log in to the Manyfold account. -3. Explore the various features of the Manyfold app. +### NetGrimoire Integrations +The manyfold service integrates with the netgrimoire network, allowing for seamless communication between services. --- ## Operations ### Monitoring + ```bash docker stack services manyfold -docker service logs -f manyfold + ``` ### Backups -Critical volumes: `/DockerVol/manyfold/postgres` -Reconstructable volumes: none +Critical data should be stored on a persistent volume to ensure recoverability. The /DockerVol/ path is recommended for this purpose. ### Restore ```bash @@ -89,28 +85,23 @@ cd services/swarm/stack/manyfold --- ## Common Failures -| Failure Mode | Symptoms | Cause | Fix | -|-------------|----------|-------|------| -| postgres down | App unavailable | Postgres not running | Check Postgres status, restart service if necessary | -| redis down | Cache not updating | Redis not running | Check Redis status, restart service if necessary | -| Manyfold app not accessible | App page not loading | Caddy or Docker Swarm issue | Check Caddy logs, restart services if necessary | +| Failure Mode | Symptom | Cause | Fix | +|- **Failure Mode** | **Symptom** | **Cause** | **Fix** | +- Service not responding | Service not responding | Incorrect Docker stack configuration | Check and correct the Docker stack configuration file. +- Database errors | Database errors | Incorrect database connection details | Check and correct the database connection details in the environment variables. --- ## Changelog | Date | Commit | Summary | -|------|--------|---------| -| 2026-04-28 | 319852ad | Initial documentation for manyfold stack | -| 2026-04-28 | e8c8e79a | Added environment variables for Manyfold app | -| 2026-04-28 | 04ce338e | Improved Postgres and Redis volumes setup | -| 2026-04-28 | a099c463 | Enhanced Caddy configuration for manyfold stack | -| 2026-04-28 | d0611a95 | Updated Docker Swarm configuration for manyfold services | -| 2026-04-28 | 7088b84b | Added first-run instructions and common failures documentation | +|- **Date** | **Commit** | **Summary** | + +