docs(gremlin): update manyfold
This commit is contained in:
parent
fda23f4bee
commit
1e92b784f3
1 changed files with 41 additions and 36 deletions
|
|
@ -1,49 +1,46 @@
|
||||||
---
|
---
|
||||||
title: manyfold Stack
|
title: manyfold Stack
|
||||||
description: Manyfold service in NetGrimoire
|
description: Manyfold 3D Library service in NetGrimoire
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-29T02:41:08.161Z
|
date: 2026-04-29T02:46:18.939Z
|
||||||
tags: docker,swarm,manyfold,netgrimoire
|
tags: docker,swarm,manyfold,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-29T02:41:08.161Z
|
dateCreated: 2026-04-29T02:46:18.939Z
|
||||||
---
|
---
|
||||||
|
|
||||||
# manyfold
|
# manyfold
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The manyfold stack is a Docker Swarm-based service in NetGrimoire that provides the Manyfold application. The main services of this stack are the Manyfold web interface and the model library.
|
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.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|------|------|
|
|---------|-------|------|------|
|
||||||
- **manyfold**: ghcr.io/manyfold3d/manyfold-solo:latest | 3214 | Web Interface |
|
- **Host:** docker4
|
||||||
- **models**: /DockerVol/manyfold/models:/models | Internal | Model Library |
|
- **Network:** netgrimoire
|
||||||
|
- **Exposed via:** manyfold.netgrimoire.com, 3214
|
||||||
Exposed via: `http://manyfold.netgrimoire.com:3214`, `https://manyfold.netgrimoire.com`
|
- **Homepage group:** "PNCHarris Apps"
|
||||||
|
|
||||||
Homepage group: New
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- Docker installed and running
|
No specific prerequisites for this stack.
|
||||||
- Caddy and Uptime Kuma services also running
|
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/manyfold/config
|
mkdir -p /DockerVol/manyfold/config
|
||||||
chown -R user:group /DockerVol/manyfold/config
|
chmod -R 755 /DockerVol/manyfold/config
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```
|
```bash
|
||||||
SECRET_KEY_BASE=$(openssl rand -hex 32)
|
SECRET_KEY_BASE=$(openssl rand -hex 32)
|
||||||
PUID="1964"
|
PUID="1964"
|
||||||
PGID="1964"
|
PGID="1964"
|
||||||
|
|
||||||
# generate: openssl rand -hex 32
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy
|
### Deploy
|
||||||
|
|
@ -57,7 +54,7 @@ docker stack services manyfold
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
No specific steps required for first deployment
|
Upon first deployment, ensure that Caddy is configured to reverse proxy to the correct URL.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -66,25 +63,26 @@ No specific steps required for first deployment
|
||||||
### Accessing manyfold
|
### Accessing manyfold
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|---------|-----|---------|
|
||||||
- **manyfold**: http://manyfold.netgrimoire.com:3214, https://manyfold.netgrimoire.com |
|
- Manyfold | manyfold.netgrimoire.com | 3D Library |
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To access the Manyfold web interface, navigate to `http://manyfold.netgrimoire.com:3214` in your browser.
|
To access the library, navigate to the provided URL. The primary use case is accessing and managing the library's content.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
- This service connects to Uptime Kuma for monitoring (`kuma.* labels`)
|
This service connects to other services through environment variables and labels, including Uptime Kuma for monitoring.
|
||||||
- It also connects to Caddy for reverse proxying (`caddy-docker-proxy labels`)
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
- `docker stack services manyfold`
|
```bash
|
||||||
- `docker service logs -f manyfold`
|
docker stack services manyfold
|
||||||
|
docker service logs manyfold
|
||||||
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical backups are required for the model library at `/DockerVol/manyfold/models`.
|
Critical data should be backed up on a regular basis. Critical vs reconstructable paths include /DockerVol/manyfold/models.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -95,10 +93,13 @@ cd services/swarm/stack/manyfold
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Symptom | Cause | Fix |
|
- **Symptom:** Caddy fails to start.
|
||||||
|---------|-------|-----|
|
- **Cause:** Incorrect configuration or environment variable issues.
|
||||||
- Service not available | Incorrect environment variables | Check and update `.env` file |
|
- **Fix:** Review and correct the `.env` file, then restart Caddy.
|
||||||
- Model library corrupted | Insufficient backups | Restore from backup or re-create model library |
|
|
||||||
|
- **Symptom:** Manyfold is not accessible.
|
||||||
|
- **Cause:** Incorrect reverse proxy URL or port issues.
|
||||||
|
- **Fix:** Review and correct the Caddy configuration, then restart Caddy.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -106,12 +107,16 @@ cd services/swarm/stack/manyfold
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-28 | 08489418 | Initial documentation creation |
|
| 2026-04-28 | d8817d41 | Initial documentation for manyfold Stack |
|
||||||
| 2026-04-28 | 61224407 | Updated Docker Swarm configuration to use labels for routing and visibility |
|
| 2026-04-28 | 2e9903c4 | Migration to swarm configuration |
|
||||||
| 2026-04-28 | cd055029 | Improved environment variable management and security |
|
|
||||||
| 2026-04-28 | c30dbfcb | Enhanced model library backup and restore functionality |
|
|
||||||
| 2026-04-28 | 4d037594 | Updated Uptime Kuma integration for monitoring purposes |
|
|
||||||
| 2026-04-28 | e91d90b6 | Fixed security vulnerability in Caddy reverse proxy configuration |
|
|
||||||
|
|
||||||
<Note: This documentation was generated by Gremlin on 2026-04-29T02:41:08.161Z>
|
<Write a paragraph summarizing the evolution of this service based on the diffs above.>
|
||||||
<Source: swarm/manyfold.yaml>
|
|
||||||
|
The manyfold Stack has been migrated from a traditional Docker Compose setup to a Docker Swarm configuration, providing more flexibility and scalability for NetGrimoire.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Generated by Gremlin on 2026-04-29T02:46:18.939Z
|
||||||
|
- Source: swarm/manyfold.yaml
|
||||||
|
- Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue