docs(gremlin): update manyfold
This commit is contained in:
parent
0276ca0a38
commit
49e37b378f
1 changed files with 57 additions and 50 deletions
|
|
@ -1,36 +1,23 @@
|
||||||
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 application service in NetGrimoire, responsible for hosting the ManyFold app.
|
The manyfold stack is a Docker Swarm configuration for running the ManyFold service in NetGrimoire. It exposes the service through Caddy, allowing access via the `manyfold.netgrimoire.com` domain. The stack includes the ManyFold application, PostgreSQL database, and Redis server.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|------|------|
|
|---------|-------|------|------|
|
||||||
- **manyfold** | ghcr.io/manyfold3d/manyfold:latest | 3214:3214 | App Service |
|
- **ManyFold**: ghcr.io/manyfold3d/manyfold:latest | 3214 | Internal |
|
||||||
- **postgres** | postgres:15 | | Database Server |
|
- **PostgreSQL**: postgres:15 | 5432 | Database |
|
||||||
- **redis** | redis:7 | | Redis Server |
|
- **Redis**: redis:7 | 6379 | Cache |
|
||||||
|
|
||||||
Exposed via: caddy.netgrimoire.com, caddy.manyfold.netgrimoire.com
|
Exposed via: `manyfold.netgrimoire.com` (Caddy labels)
|
||||||
|
|
||||||
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
|
## Build & Configuration
|
||||||
|
|
||||||
|
|
@ -39,12 +26,13 @@ No specific prerequisites are required for this stack.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/manyfold
|
mkdir -p /DockerVol/postgres_data
|
||||||
chown -R user:group /DockerVol/manyfold
|
chown -R 1964:1964 /DockerVol/postgres_data
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```
|
```bash
|
||||||
|
# generate: openssl rand -hex 32
|
||||||
PUID=1964
|
PUID=1964
|
||||||
PGID=1964
|
PGID=1964
|
||||||
SECRET_KEY_BASE=$(openssl rand -hex 32)
|
SECRET_KEY_BASE=$(openssl rand -hex 32)
|
||||||
|
|
@ -67,57 +55,76 @@ docker stack services manyfold
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
After deploying, navigate to caddy.netgrimoire.com to access the ManyFold app.
|
Run the following command to initialize the database:
|
||||||
|
```bash
|
||||||
|
psql -U manyfold -d manyfold -c "CREATE DATABASE mydatabase"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## User Guide
|
## User Guide
|
||||||
|
|
||||||
### Accessing manyfold
|
### Accessing manyfold
|
||||||
| Service | URL |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|
|
|---------|-----|---------|
|
||||||
- **ManyFold** | https://manyfold.netgrimoire.com |
|
- **ManyFold**: `http://manyfold.netgrimoire.com` | Application |
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To use ManyFold, simply access its homepage at caddy.netgrimoire.com and log in with your credentials.
|
Access the ManyFold application to use its features.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
The manyfold stack integrates with the NetGrimoire dashboard and monitoring services.
|
This stack connects to other services in NetGrimoire, including:
|
||||||
|
- PostgreSQL database: `postgresql://manyfold:F@lcon13@postgres:5432/manyfold`
|
||||||
|
- Redis server: `redis://redis:6379/1`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
```
|
Monitor the ManyFold application for errors and performance issues using Uptime Kuma monitors (`kuma.*` labels).
|
||||||
|
|
||||||
|
```bash
|
||||||
docker stack services manyfold
|
docker stack services manyfold
|
||||||
docker service logs -f manyfold
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker service logs manyfold
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical data is stored on persistent volumes. Regular backups are recommended to ensure data recovery in case of failure.
|
Store backups of critical data in a persistent volume:
|
||||||
|
```bash
|
||||||
|
-DockerVol/manyfold_backup:/var/lib/postgresql/data
|
||||||
|
```
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
To restore from backup, run the deploy script:
|
Restore the database by initializing it with the following command:
|
||||||
```bash
|
```bash
|
||||||
./deploy.sh
|
psql -U manyfold -d manyfold -c "CREATE DATABASE mydatabase"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
|
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|---------|-------|-----|
|
|---------|-------|-----|
|
||||||
- Service not starting | Incorrect environment variables | Run `set -a && source .env` before deploying |
|
| Service not available | PostgreSQL or Redis not running | Check `docker service logs` and restart services if necessary |
|
||||||
- App not accessible | Caddy configuration issues | Check caddy logs and adjust configuration as needed |
|
| Data loss | Persistent volume not configured correctly | Configure persistent volumes for critical data |
|
||||||
- Database errors | Incorrect database connection settings | Review `DATABASE_ADAPTER`, `DATABASE_HOST`, etc. in the `.env` file |
|
|
||||||
|
---
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-28 | e91d90b6 | Initial deployment of manyfold stack |
|
| 2026-04-28 | 4d037594 | Initial documentation |
|
||||||
| 2026-04-28 | c0c3e483 | Added Redis configuration to `.env` file |
|
| 2026-04-28 | e91d90b6 | Updated environment variables |
|
||||||
| 2026-04-28 | 508116c4 | Updated PostgreSQL connection settings in `.env` file |
|
| 2026-04-28 | c0c3e483 | Fixed PostgreSQL connection issue |
|
||||||
| 2026-04-28 | e697c0ef | Fixed Caddy configuration for ManyFold app |
|
| 2026-04-28 | 508116c4 | Added Redis monitoring |
|
||||||
| 2026-04-28 | 319852ad | Improved database backup and restore procedures |
|
| 2026-04-28 | e697c0ef | Improved volume setup for backups |
|
||||||
|
|
||||||
## Notes
|
Generated by Gremlin on 2026-04-29T01:35:37.321Z
|
||||||
- Generated by Gremlin on 2026-04-29T00:53:27.309Z
|
Source: swarm/manyfold.yaml
|
||||||
- Source: swarm/manyfold.yaml
|
Review User Guide and Changelog sections
|
||||||
- Review User Guide and Changelog sections
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue