docs(gremlin): update manyfold
This commit is contained in:
parent
1e92b784f3
commit
8d0d9ff5ed
1 changed files with 41 additions and 28 deletions
|
|
@ -1,44 +1,48 @@
|
|||
```markdown
|
||||
---
|
||||
title: manyfold Stack
|
||||
description: Manyfold 3D Library service in NetGrimoire
|
||||
description: Manyfold Service in NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-29T02:46:18.939Z
|
||||
date: 2026-04-29T02:57:04.285Z
|
||||
tags: docker,swarm,manyfold,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-29T02:46:18.939Z
|
||||
dateCreated: 2026-04-29T02:57:04.285Z
|
||||
---
|
||||
|
||||
# manyfold
|
||||
|
||||
## Overview
|
||||
The manyfold Stack is a Docker Swarm service that runs the Manyfold 3D Library in NetGrimoire. It provides a web interface for accessing and managing the library.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **manyfold**: ghcr.io/manyfold3d/manyfold-solo:latest | 3214 | API |
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** manyfold.netgrimoire.com, 3214
|
||||
- **Homepage group:** "PNCHarris Apps"
|
||||
- **Exposed via:** manyfold.netgrimoire.com
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites for this stack.
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/manyfold/config
|
||||
chmod -R 755 /DockerVol/manyfold/config
|
||||
mkdir -p /DockerVol/manyfold/models
|
||||
chown -R ubuntu:ubuntu /DockerVol/manyfold/config
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
SECRET_KEY_BASE=$(openssl rand -hex 32)
|
||||
# generate: openssl rand -hex 32
|
||||
SECRET_KEY_BASE="..."
|
||||
PUID="1964"
|
||||
PGID="1964"
|
||||
```
|
||||
|
|
@ -54,7 +58,7 @@ docker stack services manyfold
|
|||
```
|
||||
|
||||
### First Run
|
||||
Upon first deployment, ensure that Caddy is configured to reverse proxy to the correct URL.
|
||||
No specific steps are required for the first run.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -62,14 +66,13 @@ Upon first deployment, ensure that Caddy is configured to reverse proxy to the c
|
|||
|
||||
### Accessing manyfold
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- Manyfold | manyfold.netgrimoire.com | 3D Library |
|
||||
- **manyfold**: https://manyfold.netgrimoire.com | API |
|
||||
|
||||
### Primary Use Cases
|
||||
To access the library, navigate to the provided URL. The primary use case is accessing and managing the library's content.
|
||||
To access the manyfold 3D library, navigate to its homepage in NetGrimoire and use it as needed.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service connects to other services through environment variables and labels, including Uptime Kuma for monitoring.
|
||||
The manyfold service integrates with other services such as Caddy for reverse proxying and Uptime Kuma for monitoring.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -78,11 +81,11 @@ This service connects to other services through environment variables and labels
|
|||
### Monitoring
|
||||
```bash
|
||||
docker stack services manyfold
|
||||
docker service logs manyfold
|
||||
docker service logs manyfold -f
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data should be backed up on a regular basis. Critical vs reconstructable paths include /DockerVol/manyfold/models.
|
||||
Critical data is stored in the /DockerVol/manyfold/config directory. Reconstructable data is stored in the /DockerVol/manyfold/models directory.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
|
|
@ -93,13 +96,20 @@ cd services/swarm/stack/manyfold
|
|||
---
|
||||
|
||||
## Common Failures
|
||||
- **Symptom:** Caddy fails to start.
|
||||
- **Cause:** Incorrect configuration or environment variable issues.
|
||||
- **Fix:** Review and correct the `.env` file, then restart Caddy.
|
||||
|
||||
- **Symptom:** Manyfold is not accessible.
|
||||
- **Cause:** Incorrect reverse proxy URL or port issues.
|
||||
- **Fix:** Review and correct the Caddy configuration, then restart Caddy.
|
||||
| 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. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -107,16 +117,19 @@ cd services/swarm/stack/manyfold
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-28 | d8817d41 | Initial documentation for manyfold Stack |
|
||||
| 2026-04-28 | 2e9903c4 | Migration to swarm configuration |
|
||||
| 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 |
|
||||
|
||||
<Write a paragraph summarizing the evolution of this service based on the diffs above.>
|
||||
|
||||
The manyfold Stack has been migrated from a traditional Docker Compose setup to a Docker Swarm configuration, providing more flexibility and scalability for NetGrimoire.
|
||||
Note: The changelog will evolve as new commits are made to the swarm/manyfold.yaml file.
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-29T02:46:18.939Z
|
||||
- Generated by Gremlin on 2026-04-29T02:57:04.285Z
|
||||
- Source: swarm/manyfold.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue