traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update manyfold

Browse source
This commit is contained in:
traveler 2026-04-28 23:01:48 -05:00
parent 8d0d9ff5ed
commit dafeef5be5
1 changed files with 23 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

81
Netgrimoire/Services/manyfold/manyfold.md
View file

@ -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 # manyfold
## Overview ## 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 ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|------|
- **manyfold**: ghcr.io/manyfold3d/manyfold-solo:latest | 3214 | API |
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** manyfold.netgrimoire.com - **Exposed via:** manyfold.netgrimoire.com, Internal only
- **Homepage group:** PNCHarris Apps - **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 ## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites are required for this stack. No specific prerequisites for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/manyfold/config mkdir -p /DockerVol/manyfold/config
mkdir -p /DockerVol/manyfold/models chown -R user:group /DockerVol/manyfold/config
chown -R ubuntu:ubuntu /DockerVol/manyfold/config
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 MIN_PASSWORD_SCORE: 1
SECRET_KEY_BASE="..." SECRET_KEY_BASE: $(openssl rand -hex 32)
PUID="1964" PUID: "1964"
PGID="1964" PGID: "1964"
``` ```
### Deploy ### Deploy
@ -58,21 +46,22 @@ docker stack services manyfold
``` ```
### First Run ### First Run
No specific steps are required for the first run. Upon first deployment, ensure all environment variables are correctly set.
--- ---
## User Guide ## User Guide
### Accessing manyfold ### Accessing manyfold
| Service | URL | Purpose | | Service | URL |
- **manyfold**: https://manyfold.netgrimoire.com | API | |---------|-----|
manyfold.netgrimoire.com |
### Primary Use Cases ### 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 ### 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 ### Monitoring
```bash ```bash
docker stack services manyfold docker stack services manyfold
docker service logs manyfold -f docker service logs manyfold
``` ```
### Backups ### 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 ### Restore
```bash To restore the Manyfold service, run ./deploy.sh.
cd services/swarm/stack/manyfold
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
| Symptom | Cause | Fix | * 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.
| Port 3214 not responding | Incorrect port forward or Caddy configuration | Check Caddy labels and verify correct port forwarding. Restart Caddy if necessary. | * If the Uptime Kuma monitoring service is down, restart the kuma.* services.
| 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. |
--- ---
## Changelog ## Changelog
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.
| 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.
--- ---
## Notes ## 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 - Source: swarm/manyfold.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections