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 16:11:28 -05:00
parent ac58527b8c
commit 42ba8883bb
1 changed files with 6 additions and 103 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,114 +1,17 @@
# manyfold
## Overview
The ManyFold stack is a Docker Swarm-based application service in NetGrimoire, providing a dedicated server for the ManyFold platform.
The manyfold stack is a Docker Swarm-based service that provides the ManyFold app in NetGrimoire. It consists of three services: manyfold, postgres, and redis.
---
## Architecture
| Service | Image | Port | Role |
|---------|-------|------|------|
- **manyfold:** ghcr.io/manyfold3d/manyfold:latest
- Host: docker4
- Network: netgrimoire
- Exposed via: https://manyfold.netgrimoire.com and <caddy domains from labels>
- Homepage group: PNCHarris Apps
- **manyfold**: ghcr.io/manyfold3d/manyfold:latest | 3214:3214 | ManyFold app service |
- **postgres**: postgres:15 | - | PostgreSQL database server |
- **redis**: redis:7 | - | Redis cache |
---
Exposed via: `manyfold.netgrimoire.com`
## Build & Configuration
### Prerequisites
To deploy the ManyFold stack, ensure Docker Swarm and Caddy are installed and configured on your manager node.
### Volume Setup
```bash
mkdir -p /DockerVol/manyfold
chown -R 1964:1964 /DockerVol/manyfold
```
### Environment Variables
```bash
generate: openssl rand -hex 32
PUID="1964"
PGID="1964"
SECRET_KEY_BASE="OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK"
REDIS_URL="redis://redis:6379/1"
DATABASE_ADAPTER="postgresql"
DATABASE_HOST="postgres"
DATABASE_PORT=5432
DATABASE_USER="manyfold"
DATABASE_PASSWORD="F@lcon13"
```
### Deploy
```bash
cd services/swarm/stack/manyfold
set -a && source .env && set +a
docker stack config --compose-file manyfold-stack.yml > resolved.yml
docker stack deploy --compose-file resolved.yml manyfold
rm resolved.yml
docker stack services manyfold
```
### First Run
No initial setup is required for the ManyFold application service.
---
## User Guide
### Accessing manyfold
| Service | URL | Purpose |
|---------|-----|---------|
- **manyfold:** https://manyfold.netgrimoire.com
### Primary Use Cases
The primary use case for this stack is to run a server for the ManyFold platform. This can be accessed via the provided Caddy domain.
### NetGrimoire Integrations
This service connects to other services such as the Uptime Kuma monitoring service and the PostgreSQL database.
---
## Operations
### Monitoring
-kuma monitors from kuma.* labels:
```bash
docker stack services manyfold
<docker service logs commands>
```
### Backups
- Critical vs reconstructable `/DockerVol/manyfold` paths
### Restore
```bash
cd services/swarm/stack/manyfold
./deploy.sh
```
---
## Common Failures
| Symptom | Cause | Fix |
|---------|-------|-----|
| <service-name> is not responding | Insufficient resources on the manager node | Increase the CPU and memory resources on the manager node. |
| ManyFold server cannot connect to Redis | Inadequate Redis configuration | Ensure that the Redis service is properly configured with a correct hostname, port, and password. |
---
## Changelog
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-28 | 508116c4 | Initial documentation for ManyFold stack. |
| 2026-04-28 | e697c0ef | Updated environment variables to include additional configuration options. |
| 2026-04-28 | 319852ad | Fixed the PostgreSQL database connection details. |
| 2026-04-28 | e8c8e79a | Enhanced the volume setup for the ManyFold service. |
| 2026-04-28 | 04ce338e | Added a new environment variable to configure the Caddy reverse proxy. |
Generated by Gremlin on 2026-04-28T21:08:34.070Z
Source: swarm/manyfold.yaml
Review User Guide and Changelog sections
Homepage group: `PNCHarris Apps`