rebrand CODEXIUM
This commit is contained in:
15
UNRAID.md
15
UNRAID.md
@@ -7,7 +7,7 @@
|
||||
|
||||
## Purpose
|
||||
|
||||
This guide explains how to deploy MRP Codex on an Unraid server using the Unraid Docker GUI rather than command-line Docker management.
|
||||
This guide explains how to deploy CODEXIUM on an Unraid server using the Unraid Docker GUI rather than command-line Docker management.
|
||||
|
||||
## What this container expects
|
||||
|
||||
@@ -16,7 +16,7 @@ This guide explains how to deploy MRP Codex on an Unraid server using the Unraid
|
||||
- Environment variables for the server port, JWT secret, and SQLite path
|
||||
- Automatic Prisma migration execution during container startup
|
||||
|
||||
MRP Codex stores both the SQLite database and uploaded files inside the same persistent container path:
|
||||
CODEXIUM stores both the SQLite database and uploaded files inside the same persistent container path:
|
||||
|
||||
- database: `/app/data/prisma/app.db`
|
||||
- uploads: `/app/data/uploads`
|
||||
@@ -25,15 +25,15 @@ MRP Codex stores both the SQLite database and uploaded files inside the same per
|
||||
|
||||
- Build and push the image to a registry your Unraid server can access, or import it manually if you are self-hosting images
|
||||
- Choose an Unraid share for persistent app data, for example:
|
||||
- `/mnt/user/appdata/mrp-codex`
|
||||
- `/mnt/user/appdata/codexium`
|
||||
- Choose the port you want to expose in Unraid, for example:
|
||||
- host port `3000`
|
||||
- container port `3000`
|
||||
|
||||
## Recommended Unraid paths
|
||||
|
||||
- App data share: `/mnt/user/appdata/mrp-codex`
|
||||
- Optional backup target: `/mnt/user/backups/mrp-codex`
|
||||
- App data share: `/mnt/user/appdata/codexium`
|
||||
- Optional backup target: `/mnt/user/backups/codexium`
|
||||
|
||||
Keep the entire app data folder together so backups capture both the SQLite database and file attachments.
|
||||
|
||||
@@ -128,7 +128,7 @@ When you publish a new image:
|
||||
2. Apply the update from the Unraid GUI
|
||||
3. Start the container
|
||||
|
||||
Because MRP Codex runs `prisma migrate deploy` during startup, committed migrations are applied automatically before the app launches.
|
||||
Because CODEXIUM runs `prisma migrate deploy` during startup, committed migrations are applied automatically before the app launches.
|
||||
|
||||
This is especially important now that recent releases added CRM expansion, inventory transactions, sales and purchasing documents, shipping/logistics documents, the inventory `defaultPrice` field, purchasable-only purchase-order item selection, the new projects domain, manufacturing work orders, audit tooling, and persisted auth sessions. Let the container complete startup migrations before testing new screens.
|
||||
|
||||
@@ -148,7 +148,7 @@ For consistent backups, stop the container before copying the appdata directory.
|
||||
|
||||
## Reverse proxy notes
|
||||
|
||||
If you place MRP Codex behind Nginx Proxy Manager, Traefik, or another reverse proxy:
|
||||
If you place CODEXIUM behind Nginx Proxy Manager, Traefik, or another reverse proxy:
|
||||
|
||||
- keep the Unraid container on `bridge` or your preferred proxy-compatible network
|
||||
- point the proxy at the Unraid host IP and chosen host port
|
||||
@@ -192,3 +192,4 @@ Set `CLIENT_ORIGIN` to the exact URL used by the browser, including protocol and
|
||||
- Env: `DATABASE_URL=file:../../data/prisma/app.db`
|
||||
- Env: `PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium`
|
||||
- Env: `CLIENT_ORIGIN=http://YOUR-UNRAID-IP:3000`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user