docs(gremlin): update manyfold

This commit is contained in:
traveler 2026-04-28 15:13:20 -05:00
parent 4501e9a790
commit a31d226835

View file

@ -1,60 +1,44 @@
# manyfold Stack
description: Manyfold NetGrimoire service
---
title: manyfold Stack
published: true
date: 2026-04-28T20:11:03.785Z
tags: docker,compose,manyfold,netgrimoire
editor: markdown
dateCreated: 2026-04-28T20:11:03.785Z
---
# manyfold
## Overview
The manyfold stack is a NetGrimoire service that runs Manyfold, an AI-based platform for various applications.
The Manyfold stack is a Docker Compose configuration for running the Manyfold application in NetGrimoire, utilizing Docker Swarm as the orchestration engine.
---
## Architecture
| Service | Image | Port | Role |
|---------|-------|------|------|
| app | ghcr.io/manyfold3d/manyfold:latest | 3214 | Web App |
| postgres | postgres:15 | - | Database |
| redis | redis:7 | - | Cache |
|---------|-------|-----|------|
- **Postgres:** docker4 | postgres:15 | 5432 | Database Server |
- **Redis:** docker4 | redis:7 | | Cache Server |
- **Manyfold:** docker4 | ghcr.io/manyfold3d/manyfold:latest | 3214 | Application Server |
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** <caddy://manyfold.app:3214> or Internal only
- **Homepage group:** homepage
Exposed via: <http://caddy[netgrimoire]>, <http://localhost[netgrimoire]> (Internal only)
Homepage group: homepage.group
---
## Build & Configuration
### Prerequisites
No specific prerequisites are required for this stack.
### Volume Setup
```bash
mkdir -p /DockerVol/manyfold
chown -R manyfold:manyfold /DockerVol/manyfold
mkdir -p /DockerVol/postgres db_data
chown -R postgres:postgres /DockerVol/postgres
```
### Environment Variables
```bash
generate: openssl rand -hex 32
PUID=1000
PGID=1000
# generate: openssl rand -hex 32
PUID=1964
PGID=1964
SECRET_KEY_BASE=a_nice_long_random_string
DATABASE_ADAPTER=postgresql
DATABASE_HOST=postgres
DATABASE_PORT=5432
DATABASE_USER=manyfold
DATABASE_PASSWORD=F@lcon13
DATABASE_NAME=manyfold
REDIS_URL=redis://redis:6379/1
```
### Deploy
@ -68,7 +52,7 @@ docker stack services manyfold
```
### First Run
Perform `./deploy.sh` after deployment to initialize the database and populate it with data.
No specific steps are required for the first run, as Docker Swarm will automatically detect and deploy all services.
---
@ -77,37 +61,40 @@ Perform `./deploy.sh` after deployment to initialize the database and populate i
### Accessing manyfold
| Service | URL | Purpose |
|---------|-----|---------|
| app | <caddy://manyfold.app:3214> | Web App |
- **Manyfold:** http://localhost[netgrimoire]
### Primary Use Cases
Use Manyfold for its AI-based features and applications.
Use Manyfold to access and visualize your model libraries, with the option to upload new models directly from the application.
### NetGrimoire Integrations
This service connects to Postgres, Redis, and Caddy for data storage, caching, and reverse proxying respectively.
This stack connects to Postgres and Redis services, utilizing environment variables for communication.
---
## Operations
### Monitoring
[kuma monitors: kuma.*
```bash
docker stack services manyfold
docker-compose logs -f
docker service logs -f manyfold | grep kuma.*
```
### Backups
Critical: /DockerVol/manyfold and reconstructable on demand.
Critical data should be backed up on a persistent volume at /DockerVol/postgres.
### Restore
Perform `./deploy.sh` to restore the stack from a previous snapshot.
Restore from a backup by re-deploying the Manyfold stack.
---
## Common Failures
| Failure | Symptom | Cause | Fix |
|---------|---------|------|-----|
| CRASH | Application crash | Network issue | Restart service |
| FAILURE | Database failure | Connection timeout | Update database connection parameters |
| Failure Mode | Symptom | Cause | Fix |
|-------------|---------|------|-----|
- **Postgres Unavailable** | Service not responding. | No data available in Docker Vol. | Check the volume's existence and permissions.
- **Redis Unavailable** | Service not responding. | No connection established to Redis server. | Ensure that Redis is running and accessible.
- **Manyfold Connection Failure**| Application unable to connect to Postgres or Redis. | No valid credentials provided for either service. | Correct and re-deploy the stack.
---
@ -115,15 +102,14 @@ Perform `./deploy.sh` to restore the stack from a previous snapshot.
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-28 | 7088b84b | Migrated to swarm configuration. Added initial documentation. |
| 2026-04-28 | d0611a95 | Initial documentation creation. |
| 2026-04-28 | 7088b84b | Updated service dependencies to match swarm/manyfold.yaml changes. |
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
The manyfold stack was recently migrated from a previous configuration to an improved swarm-based setup. This change enables better scalability and maintainability for the NetGrimoire service. The provided documentation now covers the essential aspects of the service's deployment, configuration, and usage.
<Write a paragraph summarizing the evolution of this service based on the diffs above. The initial commit and recent file diff provided minimal changes, indicating that no significant updates were made beyond this point.>
---
## Notes
- Generated by Gremlin on 2026-04-28T20:11:03.785Z
- Generated by Gremlin on 2026-04-28T20:11:06.959Z
- Source: swarm/manyfold.yaml
- Review User Guide and Changelog sections