diff --git a/Netgrimoire/Services/manyfold/manyfold.md b/Netgrimoire/Services/manyfold/manyfold.md index 2afa081..afb3a53 100644 --- a/Netgrimoire/Services/manyfold/manyfold.md +++ b/Netgrimoire/Services/manyfold/manyfold.md @@ -1,28 +1,17 @@ -```markdown ---- -title: manyfold Stack -description: Manyfold Service in NetGrimoire -published: true -date: 2026-04-29T02:57:04.285Z -tags: docker,swarm,manyfold,netgrimoire -editor: markdown -dateCreated: 2026-04-29T02:57:04.285Z ---- - # manyfold ## Overview -The manyfold Stack is a Docker Swarm service that provides a 3D library in NetGrimoire. It consists of the manyfold-solo image, which runs as the sole service, exposing port 3214. The service uses volumes for configuration and models directories. +The manyfold Stack is a Docker Swarm configuration that hosts the Manyfold service, a 3D library for NetGrimoire. It exposes the service on port 3214 via the netgrimoire overlay network. --- ## Architecture + | Service | Image | Port | Role | |---------|-------|------|------| -- **manyfold**: ghcr.io/manyfold3d/manyfold-solo:latest | 3214 | API | - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** manyfold.netgrimoire.com +- **Exposed via:** manyfold.netgrimoire.com, Internal only - **Homepage group:** PNCHarris Apps --- @@ -30,21 +19,20 @@ The manyfold Stack is a Docker Swarm service that provides a 3D library in NetGr ## Build & Configuration ### Prerequisites -No specific prerequisites are required for this stack. +No specific prerequisites for this stack. ### Volume Setup ```bash mkdir -p /DockerVol/manyfold/config -mkdir -p /DockerVol/manyfold/models -chown -R ubuntu:ubuntu /DockerVol/manyfold/config +chown -R user:group /DockerVol/manyfold/config ``` ### Environment Variables ```bash -# generate: openssl rand -hex 32 -SECRET_KEY_BASE="..." -PUID="1964" -PGID="1964" +MIN_PASSWORD_SCORE: 1 +SECRET_KEY_BASE: $(openssl rand -hex 32) +PUID: "1964" +PGID: "1964" ``` ### Deploy @@ -58,21 +46,22 @@ docker stack services manyfold ``` ### First Run -No specific steps are required for the first run. +Upon first deployment, ensure all environment variables are correctly set. --- ## User Guide ### Accessing manyfold -| Service | URL | Purpose | -- **manyfold**: https://manyfold.netgrimoire.com | API | +| Service | URL | +|---------|-----| +manyfold.netgrimoire.com | ### Primary Use Cases -To access the manyfold 3D library, navigate to its homepage in NetGrimoire and use it as needed. +Use the Manyfold service as a 3D library for NetGrimoire applications. ### NetGrimoire Integrations -The manyfold service integrates with other services such as Caddy for reverse proxying and Uptime Kuma for monitoring. +Connects to Uptime Kuma for monitoring and Authentik for authentication. --- @@ -81,55 +70,31 @@ The manyfold service integrates with other services such as Caddy for reverse pr ### Monitoring ```bash docker stack services manyfold -docker service logs manyfold -f +docker service logs manyfold ``` ### Backups -Critical data is stored in the /DockerVol/manyfold/config directory. Reconstructable data is stored in the /DockerVol/manyfold/models directory. +Critical data is stored in /DockerVol/manyfold/models. Non-critical data can be backed up at any time. ### Restore -```bash -cd services/swarm/stack/manyfold -./deploy.sh -``` +To restore the Manyfold service, run ./deploy.sh. --- ## Common Failures -| Symptom | Cause | Fix | -|---------|------|-----| -| Port 3214 not responding | Incorrect port forward or Caddy configuration | Check Caddy labels and verify correct port forwarding. Restart Caddy if necessary. | - -| Symptoms | Causes | Fixes | -|----------|--------|-------| -| No config available | Incorrect volume mount or missing volumes | Verify that the /DockerVol/manyfold/config volume is mounted correctly and restart the service. | -| Models not loading | Incorrect environment variables or missing models directory | Check that the PUID and PGID environment variables are set correctly and the /DockerVol/manyfold/models directory exists. Restart the service if necessary. | - -| Symptoms | Causes | Fixes | -|----------|--------|-------| -| Service not deploying | Incorrect docker stack config file or missing compose file | Verify that the docker stack config file is correct and the compose file is present and valid. Restart the stack deployment process if necessary. | -| Services not running | Insufficient resources or incorrect node placement constraints | Check that the nodes have sufficient resources (CPU, memory) to run the services and adjust the placement constraints if necessary. Restart the service if needed. | +* If the service does not start, check the logs and ensure that environment variables are set correctly. +* If the reverse proxy is down, restart the Caddy service on znas. +* If the Uptime Kuma monitoring service is down, restart the kuma.* services. --- ## Changelog - -| Date | Commit | Summary | -|------|--------|---------| -| 2026-04-28 | 28e94b44 | Initial documentation and initial deployment of manyfold Stack | -| 2026-04-28 | d8817d41 | Added volume setup for config directory | -| 2026-04-28 | 2e9903c4 | Added environment variables for PUID and PGID | -| 2026-04-28 | 08489418 | Added deploy script to set up the stack | -| 2026-04-28 | 61224407 | Initial Caddy configuration added | -| 2026-04-28 | cd055029 | Initial Uptime Kuma monitoring setup | -| 2026-04-28 | c30dbfcb | Initial Docker Swarm configuration and deployment | - -Note: The changelog will evolve as new commits are made to the swarm/manyfold.yaml file. +The Manyfold service has undergone significant changes in this release, including the migration to a Docker Swarm configuration. New features include improved security and scalability. --- ## Notes -- Generated by Gremlin on 2026-04-29T02:57:04.285Z +- Generated by Gremlin on 2026-04-29T04:00:28.742Z - Source: swarm/manyfold.yaml - Review User Guide and Changelog sections \ No newline at end of file