docs(gremlin): update manyfold

This commit is contained in:
traveler 2026-04-28 19:55:02 -05:00
parent 42ba8883bb
commit 0276ca0a38

View file

@ -1,17 +1,123 @@
Frontmatter:
---
title: manyfold Stack
description: ManyFold App Service in NetGrimoire
published: true
date: 2026-04-29T00:53:27.309Z
tags: docker,swarm,manyfold,netgrimoire
editor: markdown
dateCreated: 2026-04-29T00:53:27.309Z
---
# manyfold # manyfold
## Overview ## Overview
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. The manyfold stack is a Docker Swarm-based application service in NetGrimoire, responsible for hosting the ManyFold app.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |---------|-------|------|------|
- **manyfold**: ghcr.io/manyfold3d/manyfold:latest | 3214:3214 | ManyFold app service | - **manyfold** | ghcr.io/manyfold3d/manyfold:latest | 3214:3214 | App Service |
- **postgres**: postgres:15 | - | PostgreSQL database server | - **postgres** | postgres:15 | | Database Server |
- **redis**: redis:7 | - | Redis cache | - **redis** | redis:7 | | Redis Server |
Exposed via: `manyfold.netgrimoire.com` Exposed via: caddy.netgrimoire.com, caddy.manyfold.netgrimoire.com
Homepage group: `PNCHarris Apps` Homepage group: PNCHarris Apps
Homepage name: ManyFold
Homepage icon: manyfold.png
Homepage href: https://manyfold.netgrimoire.com
Homepage description: App service
diun.enable: true
monitor.name: manyfold
monitor.url: https://manyfold.netgrimoire.com
## Build & Configuration
### Prerequisites
No specific prerequisites are required for this stack.
### Volume Setup
```bash
mkdir -p /DockerVol/manyfold
chown -R user:group /DockerVol/manyfold
```
### Environment Variables
```
PUID=1964
PGID=1964
SECRET_KEY_BASE=$(openssl rand -hex 32)
DATABASE_ADAPTER=postgresql
DATABASE_HOST=postgres
DATABASE_PORT=5432
DATABASE_USER=manyfold
DATABASE_PASSWORD=F@lcon13
REDIS_URL=redis://redis:6379/1
```
### 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
After deploying, navigate to caddy.netgrimoire.com to access the ManyFold app.
## User Guide
### Accessing manyfold
| Service | URL |
|---------|-----|
- **ManyFold** | https://manyfold.netgrimoire.com |
### Primary Use Cases
To use ManyFold, simply access its homepage at caddy.netgrimoire.com and log in with your credentials.
### NetGrimoire Integrations
The manyfold stack integrates with the NetGrimoire dashboard and monitoring services.
## Operations
### Monitoring
```
docker stack services manyfold
docker service logs -f manyfold
```
### Backups
Critical data is stored on persistent volumes. Regular backups are recommended to ensure data recovery in case of failure.
### Restore
To restore from backup, run the deploy script:
```bash
./deploy.sh
```
## Common Failures
| Symptom | Cause | Fix |
|---------|-------|-----|
- Service not starting | Incorrect environment variables | Run `set -a && source .env` before deploying |
- App not accessible | Caddy configuration issues | Check caddy logs and adjust configuration as needed |
- Database errors | Incorrect database connection settings | Review `DATABASE_ADAPTER`, `DATABASE_HOST`, etc. in the `.env` file |
## Changelog
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-28 | e91d90b6 | Initial deployment of manyfold stack |
| 2026-04-28 | c0c3e483 | Added Redis configuration to `.env` file |
| 2026-04-28 | 508116c4 | Updated PostgreSQL connection settings in `.env` file |
| 2026-04-28 | e697c0ef | Fixed Caddy configuration for ManyFold app |
| 2026-04-28 | 319852ad | Improved database backup and restore procedures |
## Notes
- Generated by Gremlin on 2026-04-29T00:53:27.309Z
- Source: swarm/manyfold.yaml
- Review User Guide and Changelog sections