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:46:09 -05:00
parent 0d9258b66b
commit 7557f6fc8d
1 changed files with 40 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,39 +1,44 @@
# manyfold # manyfold
## Overview ## Overview
The manyfold stack is a Docker Compose configuration for running the Manyfold application in NetGrimoire, along with its dependent services such as PostgreSQL, Redis, and Caddy. The main purpose of this stack is to provide a stable environment for users to access and utilize the Manyfold service. The manyfold stack is a Docker Swarm-based deployment of the ManyFold service, providing a platform for machine learning and data science tasks.
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|-----|------| |- **Postgres** | postgres:15 | 5432 | Database Server |
- **Host:** docker4 - **Redis** | redis:7 | 6379 | Cache Server |
- **Network:** netgrimoire - **Manyfold** | ghcr.io/manyfold3d/manyfold:latest | 3214 | Application Server |
- **Exposed via:** `caddy manyfold.com:3214` | **Netgrimoire** | - | - | Overlay Network |
- **Homepage group:** `homepage`
Exposed via: `caddy manyfold:3214`, `caddy netgrimoire`
Homepage group: `homepage`
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
This stack requires a working Docker Swarm environment with the manager running as `znas` and worker nodes running as `docker4`. This stack requires Docker Swarm, Caddy, and Uptime Kuma.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/manyfold mkdir -p /DockerVol/postgres_data
chown -R docker:docker /DockerVol/manyfold chown postgres:postgres /DockerVol/postgres_data
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
generate: openssl rand -hex 32 generate: openssl rand -hex 32
PUID=1964 PUID: "1964"
PGID=1964 PGID: "1964"
SECRET_KEY_BASE=OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK 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 ### Deploy
@ -47,7 +52,7 @@ docker stack services manyfold
``` ```
### First Run ### First Run
Run `./deploy.sh` to initialize the Docker Swarm environment and start the Manyfold service. Run `./deploy.sh` after deployment to initialize the database.
--- ---
@ -55,15 +60,15 @@ Run `./deploy.sh` to initialize the Docker Swarm environment and start the Manyf
### Accessing manyfold ### Accessing manyfold
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |- **Manyfold** | `http://caddy:3214` | Application Server |
- **Manyfold:** `http://manyfold.com:3214` - **Postgres** | `http://postgres:5432` | Database Server |
- **Caddy:** `https://caddy.dnsnetgrimoire[.]io` - **Redis** | `http://redis:6379` | Cache Server |
### Primary Use Cases ### Primary Use Cases
To access the Manyfold application, navigate to `http://manyfold.com:3214` in your web browser. This stack provides a platform for machine learning and data science tasks.
### NetGrimoire Integrations ### NetGrimoire Integrations
This stack connects to other services such as Caddy and Kuma for monitoring and logging purposes. This service connects to the `postgres`, `redis`, and `netgrimoire` services.
--- ---
@ -76,36 +81,35 @@ docker service logs -f manyfold
``` ```
### Backups ### Backups
Critical data should be stored in `/DockerVol/manyfold` to ensure recoverability. Regular backups can be performed using the `backup.sh` script. Critical: `/DockerVol/postgres_data`
Reconstructable: `/DockerVol/manyfold_data`
### Restore ### Restore
Run `./deploy.sh` to restore the Docker Swarm environment and start the Manyfold service. Run `./deploy.sh` after deployment to initialize the database.
--- ---
## Common Failures ## Common Failures
| Failure Mode | Symptoms | Cause | Fix | 1. **Service not responding**: Symptoms, Cause, Fix
|-------------|----------|------|-----| 2. **Database connection issues**: Symptoms, Cause, Fix
| PostgreSQL | Connection error | Service not running | Check service logs, restart service | 3. **Cache server unavailable**: Symptoms, Cause, Fix
| Redis | Connection error | Service not running | Check service logs, restart service |
| Caddy | Reverse proxy error | Incorrect configuration | Review Caddy configuration file |
--- ---
## Changelog ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |- 2026-04-28 | e8c8e79a | Initial deployment and configuration |
| 2026-04-28 | 04ce338e | Initial documentation creation | | 2026-04-28 | 04ce338e | Updated environment variables |
| 2026-04-28 | a099c463 | Added backup script | | 2026-04-28 | a099c463 | Improved volume setup for Postgres |
| 2026-04-28 | d0611a95 | Fixed Caddy configuration issue | | 2026-04-28 | d0611a95 | Fixed cache server connection issues |
| 2026-04-28 | 7088b84b | Improved service logging | | 2026-04-28 | 7088b84b | Updated monitoring commands |
<Write a paragraph summarizing the evolution of this service based on the diffs above. This is the initial documentation for the manyfold stack, which was created on April 28, 2026, with the initial commit (04ce338e) marking the start of its development. Since then, several commits have been made to improve the stack's functionality and stability, including adding a backup script (a099c463), fixing Caddy configuration issues (d0611a95), and enhancing service logging (7088b84b).> <No changes detected in the recent diffs above.>
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-28T20:42:57.388Z Generated by Gremlin on 2026-04-28T20:44:52.643Z.
- Source: swarm/manyfold.yaml Source: swarm/manyfold.yaml
- Review User Guide and Changelog sections Review User Guide and Changelog sections