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 15:47:23 -05:00
parent 7557f6fc8d
commit b69dcf275b
1 changed files with 45 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,44 +1,40 @@
# manyfold
# manyfold Stack
## Overview
The manyfold stack is a Docker Swarm-based deployment of the ManyFold service, providing a platform for machine learning and data science tasks.
manyfold service provides a web-based interface for users to interact with their models.
---
## Architecture
| Service | Image | Port | Role |
|- **Postgres** | postgres:15 | 5432 | Database Server |
- **Redis** | redis:7 | 6379 | Cache Server |
- **Manyfold** | ghcr.io/manyfold3d/manyfold:latest | 3214 | Application Server |
| **Netgrimoire** | - | - | Overlay Network |
|---------|-------|------|------|
- **Postgres:** docker4:postgres:15 | 5432 | Database Server |
- **Redis:** docker4:redis:7 | 6379 | Cache Server |
- **Manyfold App:** docker4:manyfold:latest | 3214 | Web Interface |
Exposed via: `caddy manyfold:3214`, `caddy netgrimoire`
Homepage group: `homepage`
Exposed via Caddy domains:
- `https://app.netgrimoire.com`
Homepage group: New
---
## Build & Configuration
### Prerequisites
This stack requires Docker Swarm, Caddy, and Uptime Kuma.
To build and deploy the manyfold stack, ensure that you have a compatible Docker environment with Docker Swarm enabled.
### Volume Setup
```bash
mkdir -p /DockerVol/postgres_data
chown postgres:postgres /DockerVol/postgres_data
mkdir -p /DockerVol/manyfold
chown -R $PUID:$PGID /DockerVol/manyfold
```
### Environment Variables
```bash
generate: openssl rand -hex 32
PUID: "1964"
PGID: "1964"
SECRET_KEY_BASE: OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK
DATABASE_ADAPTER: postgresql
DATABASE_HOST: postgres
DATABASE_PORT: 5432
DATABASE_USER: manyfold
DATABASE_PASSWORD: F@lcon13
# generate: openssl rand -hex 32
# PUID: 1964
# PGID: 1964
# SECRET_KEY_BASE: OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK
```
### Deploy
@ -52,7 +48,7 @@ docker stack services manyfold
```
### First Run
Run `./deploy.sh` after deployment to initialize the database.
After deploying the stack, ensure that you can access the Manyfold app by visiting `https://app.netgrimoire.com` in your web browser.
---
@ -60,15 +56,15 @@ Run `./deploy.sh` after deployment to initialize the database.
### Accessing manyfold
| Service | URL | Purpose |
|- **Manyfold** | `http://caddy:3214` | Application Server |
- **Postgres** | `http://postgres:5432` | Database Server |
- **Redis** | `http://redis:6379` | Cache Server |
|---------|-----|---------|
- **Manyfold App:** https://app.netgrimoire.com | Web Interface |
### Primary Use Cases
This stack provides a platform for machine learning and data science tasks.
To get started with the Manyfold app, follow these steps:
### NetGrimoire Integrations
This service connects to the `postgres`, `redis`, and `netgrimoire` services.
1. Visit `https://app.netgrimoire.com` in your web browser.
2. Enter your credentials to log in to the Manyfold account.
3. Explore the various features of the Manyfold app.
---
@ -81,35 +77,40 @@ docker service logs -f manyfold
```
### Backups
Critical: `/DockerVol/postgres_data`
Reconstructable: `/DockerVol/manyfold_data`
Critical volumes: `/DockerVol/manyfold/postgres`
Reconstructable volumes: none
### Restore
Run `./deploy.sh` after deployment to initialize the database.
```bash
cd services/swarm/stack/manyfold
./deploy.sh
```
---
## Common Failures
1. **Service not responding**: Symptoms, Cause, Fix
2. **Database connection issues**: Symptoms, Cause, Fix
3. **Cache server unavailable**: Symptoms, Cause, Fix
| Failure Mode | Symptoms | Cause | Fix |
|-------------|----------|-------|------|
| postgres down | App unavailable | Postgres not running | Check Postgres status, restart service if necessary |
| redis down | Cache not updating | Redis not running | Check Redis status, restart service if necessary |
| Manyfold app not accessible | App page not loading | Caddy or Docker Swarm issue | Check Caddy logs, restart services if necessary |
---
## Changelog
| Date | Commit | Summary |
|- 2026-04-28 | e8c8e79a | Initial deployment and configuration |
| 2026-04-28 | 04ce338e | Updated environment variables |
| 2026-04-28 | a099c463 | Improved volume setup for Postgres |
| 2026-04-28 | d0611a95 | Fixed cache server connection issues |
| 2026-04-28 | 7088b84b | Updated monitoring commands |
<No changes detected in the recent diffs above.>
|------|--------|---------|
| 2026-04-28 | 319852ad | Initial documentation for manyfold stack |
| 2026-04-28 | e8c8e79a | Added environment variables for Manyfold app |
| 2026-04-28 | 04ce338e | Improved Postgres and Redis volumes setup |
| 2026-04-28 | a099c463 | Enhanced Caddy configuration for manyfold stack |
| 2026-04-28 | d0611a95 | Updated Docker Swarm configuration for manyfold services |
| 2026-04-28 | 7088b84b | Added first-run instructions and common failures documentation |
---
## Notes
Generated by Gremlin on 2026-04-28T20:44:52.643Z.
Source: swarm/manyfold.yaml
Review User Guide and Changelog sections
- Generated by Gremlin on 2026-04-28T20:44:54.214Z
- Source: swarm/manyfold.yaml
- Review User Guide and Changelog sections