docs(gremlin): update manyfold
This commit is contained in:
parent
be78f9736b
commit
fda23f4bee
1 changed files with 46 additions and 41 deletions
|
|
@ -1,38 +1,49 @@
|
|||
---
|
||||
title: manyfold Stack
|
||||
description: Manyfold service in NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-29T02:41:08.161Z
|
||||
tags: docker,swarm,manyfold,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-29T02:41:08.161Z
|
||||
---
|
||||
|
||||
# manyfold
|
||||
|
||||
## Overview
|
||||
The manyfold Stack is a Docker Swarm configuration for deploying the Manyfold service in NetGrimoire. It consists of a single service, manyfold, which runs as a containerized application. The stack uses a custom compose file and environment variables to configure the deployment.
|
||||
|
||||
---
|
||||
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.
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **manyfold**: ghcr.io/manyfold3d/manyfold-solo:latest | 3214:3214 | - | Web Application |
|
||||
- **manyfold**: ghcr.io/manyfold3d/manyfold-solo:latest | 3214 | Web Interface |
|
||||
- **models**: /DockerVol/manyfold/models:/models | Internal | Model Library |
|
||||
|
||||
**Host:** docker4
|
||||
**Network:** netgrimoire
|
||||
**Exposed via:** https://caddy[0-9]+.netgrimoire.local
|
||||
**Homepage group:** homepage
|
||||
Exposed via: `http://manyfold.netgrimoire.com:3214`, `https://manyfold.netgrimoire.com`
|
||||
|
||||
Homepage group: New
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
This stack requires Docker Swarm and a Docker environment with the necessary dependencies installed.
|
||||
- Docker installed and running
|
||||
- Caddy and Uptime Kuma services also running
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/manyfold/config
|
||||
chown -R 1000:1000 /DockerVol/manyfold/config
|
||||
chown -R user:group /DockerVol/manyfold/config
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
```
|
||||
SECRET_KEY_BASE=$(openssl rand -hex 32)
|
||||
PUID=1000
|
||||
PGID=1000
|
||||
PUID="1964"
|
||||
PGID="1964"
|
||||
|
||||
# generate: openssl rand -hex 32
|
||||
```
|
||||
|
||||
### Deploy
|
||||
|
|
@ -46,7 +57,7 @@ docker stack services manyfold
|
|||
```
|
||||
|
||||
### First Run
|
||||
After deploying the stack, you may need to restart the service for it to be visible in NetGrimoire.
|
||||
No specific steps required for first deployment
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -55,37 +66,39 @@ After deploying the stack, you may need to restart the service for it to be visi
|
|||
### Accessing manyfold
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **manyfold**: https://caddy[0-9]+.netgrimoire.local | Web Application |
|
||||
- **manyfold**: http://manyfold.netgrimoire.com:3214, https://manyfold.netgrimoire.com |
|
||||
|
||||
### Primary Use Cases
|
||||
To use Manyfold, simply access the web application by visiting its URL in a web browser.
|
||||
To access the Manyfold web interface, navigate to `http://manyfold.netgrimoire.com:3214` in your browser.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
Manyfold integrates with other services in NetGrimoire through environment variables and Docker labels.
|
||||
- This service connects to Uptime Kuma for monitoring (`kuma.* labels`)
|
||||
- It also connects to Caddy for reverse proxying (`caddy-docker-proxy labels`)
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
```bash
|
||||
docker stack services manyfold
|
||||
docker service logs manyfold -f
|
||||
```
|
||||
- `docker stack services manyfold`
|
||||
- `docker service logs -f manyfold`
|
||||
|
||||
### Backups
|
||||
Critical data stored in /DockerVol/manyfold/models should be backed up regularly to prevent loss.
|
||||
Critical backups are required for the model library at `/DockerVol/manyfold/models`.
|
||||
|
||||
### Restore
|
||||
To restore the application, run `./deploy.sh` from within the container.
|
||||
```bash
|
||||
cd services/swarm/stack/manyfold
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
| Service not starting | Insufficient resources | Increase resource allocation for docker4 node |
|
||||
| Data corruption | Inadequate backups | Regularly backup critical data to prevent loss |
|
||||
- Service not available | Incorrect environment variables | Check and update `.env` file |
|
||||
- Model library corrupted | Insufficient backups | Restore from backup or re-create model library |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -93,20 +106,12 @@ To restore the application, run `./deploy.sh` from within the container.
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-28 | 61224407 | Initial documentation for manyfold Stack |
|
||||
| 2026-04-28 | cd055029 | Added security optimization feature |
|
||||
| 2026-04-28 | c30dbfcb | Improved data volume handling |
|
||||
| 2026-04-28 | 4d037594 | Enhanced logging and monitoring capabilities |
|
||||
| 2026-04-28 | e91d90b6 | Fixed issues with Docker image caching |
|
||||
| 2026-04-28 | c0c3e483 | Added support for multi-user mode |
|
||||
| 2026-04-28 | 508116c4 | Improved service restart logic |
|
||||
| 2026-04-28 | e697c0ef | Enhanced security features |
|
||||
| 2026-04-28 | 319852ad | Fixed issues with Docker networking |
|
||||
| 2026-04-28 | e8c8e79a | Improved performance and scalability |
|
||||
| 2026-04-28 | 08489418 | Initial documentation creation |
|
||||
| 2026-04-28 | 61224407 | Updated Docker Swarm configuration to use labels for routing and visibility |
|
||||
| 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 |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-29T02:41:06.695Z
|
||||
- Source: swarm/manyfold.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
<Note: This documentation was generated by Gremlin on 2026-04-29T02:41:08.161Z>
|
||||
<Source: swarm/manyfold.yaml>
|
||||
Loading…
Add table
Add a link
Reference in a new issue