diff --git a/Netgrimoire/Services/manyfold/manyfold.md b/Netgrimoire/Services/manyfold/manyfold.md index b9c4322..cb4ba67 100644 --- a/Netgrimoire/Services/manyfold/manyfold.md +++ b/Netgrimoire/Services/manyfold/manyfold.md @@ -1,37 +1,44 @@ # manyfold ## 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. +The ManyFold stack is a Docker Swarm-based application service in NetGrimoire, providing a dedicated server for the ManyFold platform. --- ## Architecture | Service | Image | Port | Role | -|- **Host:** docker4 | -|- **Network:** netgrimoire | -|- **Exposed via:** | -- **Homepage group:** New | +|---------|-------|------|------| +- **manyfold:** ghcr.io/manyfold3d/manyfold:latest + - Host: docker4 + - Network: netgrimoire + - Exposed via: https://manyfold.netgrimoire.com and + - Homepage group: PNCHarris Apps --- ## Build & Configuration ### Prerequisites -This stack requires the .env file to be in the same directory as the swarm configuration. +To deploy the ManyFold stack, ensure Docker Swarm and Caddy are installed and configured on your manager node. ### Volume Setup ```bash -mkdir -p /DockerVol/app -chmod -R 755 /DockerVol/app +mkdir -p /DockerVol/manyfold +chown -R 1964:1964 /DockerVol/manyfold ``` ### Environment Variables ```bash -# generate: openssl rand -hex 32 -PUID=1964 -PGID=1964 -SECRET_KEY_BASE=OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK -REDIS_URL=redis://redis:6379/1 +generate: openssl rand -hex 32 +PUID="1964" +PGID="1964" +SECRET_KEY_BASE="OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK" +REDIS_URL="redis://redis:6379/1" +DATABASE_ADAPTER="postgresql" +DATABASE_HOST="postgres" +DATABASE_PORT=5432 +DATABASE_USER="manyfold" +DATABASE_PASSWORD="F@lcon13" ``` ### Deploy @@ -45,7 +52,7 @@ docker stack services manyfold ``` ### First Run -After the initial deployment, make sure to check the logs of the app service for any errors. +No initial setup is required for the ManyFold application service. --- @@ -53,28 +60,28 @@ After the initial deployment, make sure to check the logs of the app service for ### Accessing manyfold | Service | URL | Purpose | -|- **Service** | **URL** | **Purpose** | -- | +|---------|-----|---------| +- **manyfold:** https://manyfold.netgrimoire.com ### Primary Use Cases -This stack is designed to provide a scalable and performant user interface for NetGrimoire users. +The primary use case for this stack is to run a server for the ManyFold platform. This can be accessed via the provided Caddy domain. ### NetGrimoire Integrations -The manyfold service integrates with the netgrimoire network, allowing for seamless communication between services. +This service connects to other services such as the Uptime Kuma monitoring service and the PostgreSQL database. --- ## Operations ### Monitoring - +-kuma monitors from kuma.* labels: ```bash docker stack services manyfold ``` ### Backups -Critical data should be stored on a persistent volume to ensure recoverability. The /DockerVol/ path is recommended for this purpose. +- Critical vs reconstructable `/DockerVol/manyfold` paths ### Restore ```bash @@ -85,23 +92,23 @@ cd services/swarm/stack/manyfold --- ## Common Failures -| 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. +| Symptom | Cause | Fix | +|---------|-------|-----| +| is not responding | Insufficient resources on the manager node | Increase the CPU and memory resources on the manager node. | +| ManyFold server cannot connect to Redis | Inadequate Redis configuration | Ensure that the Redis service is properly configured with a correct hostname, port, and password. | --- ## Changelog | Date | Commit | Summary | -|- **Date** | **Commit** | **Summary** | +|------|--------|---------| +| 2026-04-28 | 508116c4 | Initial documentation for ManyFold stack. | +| 2026-04-28 | e697c0ef | Updated environment variables to include additional configuration options. | +| 2026-04-28 | 319852ad | Fixed the PostgreSQL database connection details. | +| 2026-04-28 | e8c8e79a | Enhanced the volume setup for the ManyFold service. | +| 2026-04-28 | 04ce338e | Added a new environment variable to configure the Caddy reverse proxy. | -