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 16:00:39 -05:00
parent 8a6320e9ca
commit 767fffb97f
1 changed files with 31 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,40 +1,37 @@
# manyfold Stack # manyfold
manyfold service provides a web-based interface for users to interact with their models. ## Overview
The manyfold stack is a Docker Swarm configuration for the Manyfold service, providing an application server for NetGrimoire users. The stack consists of services such as app, postgres, and redis, which work together to provide a scalable and performant user interface.
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-------|------|------| |- **Host:** docker4 |
- **Postgres:** docker4:postgres:15 | 5432 | Database Server | |- **Network:** netgrimoire |
- **Redis:** docker4:redis:7 | 6379 | Cache Server | |- **Exposed via:** <https://app.netgrimoire.com:3214> |
- **Manyfold App:** docker4:manyfold:latest | 3214 | Web Interface | - **Homepage group:** New |
Exposed via Caddy domains:
- `https://app.netgrimoire.com`
Homepage group: New
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
To build and deploy the manyfold stack, ensure that you have a compatible Docker environment with Docker Swarm enabled. This stack requires the .env file to be in the same directory as the swarm configuration.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/manyfold mkdir -p /DockerVol/app
chown -R $PUID:$PGID /DockerVol/manyfold chmod -R 755 /DockerVol/app
``` ```
### 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
``` ```
### Deploy ### Deploy
@ -48,7 +45,7 @@ docker stack services manyfold
``` ```
### First Run ### First Run
After deploying the stack, ensure that you can access the Manyfold app by visiting `https://app.netgrimoire.com` in your web browser. After the initial deployment, make sure to check the logs of the app service for any errors.
--- ---
@ -56,29 +53,28 @@ After deploying the stack, ensure that you can access the Manyfold app by visiti
### Accessing manyfold ### Accessing manyfold
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |- **Service** | **URL** | **Purpose** |
- **Manyfold App:** https://app.netgrimoire.com | Web Interface | - <https://app.netgrimoire.com:3214> |
### Primary Use Cases ### Primary Use Cases
To get started with the Manyfold app, follow these steps: This stack is designed to provide a scalable and performant user interface for NetGrimoire users.
1. Visit `https://app.netgrimoire.com` in your web browser. ### NetGrimoire Integrations
2. Enter your credentials to log in to the Manyfold account. The manyfold service integrates with the netgrimoire network, allowing for seamless communication between services.
3. Explore the various features of the Manyfold app.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
<kuma monitors from kuma.* labels>
```bash ```bash
docker stack services manyfold docker stack services manyfold
docker service logs -f manyfold <docker service logs commands>
``` ```
### Backups ### Backups
Critical volumes: `/DockerVol/manyfold/postgres` Critical data should be stored on a persistent volume to ensure recoverability. The /DockerVol/ path is recommended for this purpose.
Reconstructable volumes: none
### Restore ### Restore
```bash ```bash
@ -89,28 +85,23 @@ cd services/swarm/stack/manyfold
--- ---
## Common Failures ## Common Failures
| Failure Mode | Symptoms | Cause | Fix | | Failure Mode | Symptom | Cause | Fix |
|-------------|----------|-------|------| |- **Failure Mode** | **Symptom** | **Cause** | **Fix** |
| postgres down | App unavailable | Postgres not running | Check Postgres status, restart service if necessary | - Service not responding | Service not responding | Incorrect Docker stack configuration | Check and correct the Docker stack configuration file.
| redis down | Cache not updating | Redis not running | Check Redis status, restart service if necessary | - Database errors | Database errors | Incorrect database connection details | Check and correct the database connection details in the environment variables.
| Manyfold app not accessible | App page not loading | Caddy or Docker Swarm issue | Check Caddy logs, restart services if necessary |
--- ---
## Changelog ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |- **Date** | **Commit** | **Summary** |
| 2026-04-28 | 319852ad | Initial documentation for manyfold stack |
| 2026-04-28 | e8c8e79a | Added environment variables for Manyfold app | <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.]
| 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 ## Notes
- Generated by Gremlin on 2026-04-28T20:44:54.214Z - Generated by Gremlin on 2026-04-28T20:59:20.436Z
- Source: swarm/manyfold.yaml - Source: swarm/manyfold.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections