blackroad-os/blackroad-operating-system
9
0
Fork 0
mirror of https://github.com/blackboxprogramming/BlackRoad-Operating-System.git synced 2026-03-18 04:33:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

Clarify deployment targets and UI entrypoint (#134)

Browse Source 
## Summary
- reinforce that deployments must target the satellite repositories and
not the monorepo
- document that the supported UI entry point is
backend/static/index.html and to avoid the legacy blackroad-os bundle

## Testing
- Not run (documentation changes only)


------
[Codex
Task](https://chatgpt.com/codex/tasks/task_e_691f92be93288329867444ec95e4bb7f)
This commit is contained in:
Alexa Amundson
2025-11-20 16:17:32 -06:00
committed by GitHub
parent d3c0751934 b7d5e1b2ed
commit 93c45a7a5b
2 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
DEPLOYMENT_ARCHITECTURE.md
View File

@@ -94,6 +94,11 @@ This document establishes the canonical deployment model to prevent misconfigura
- It's not designed to run as a service - It's not designed to run as a service
- It will break everything - It will break everything
4. **Never host the legacy `blackroad-os` bundle**
- The only supported UI lives in `backend/static/index.html`
- Serve it through the FastAPI backend or the `blackroad-os-web` satellite
- Do not push the monorepo or `/blackroad-os` assets directly to Pages/GoDaddy
### ✅ ALWAYS DO THIS ### ✅ ALWAYS DO THIS
1. **Deploy ONLY satellite repos to Railway** 1. **Deploy ONLY satellite repos to Railway**

4
README.md
View File

@@ -48,6 +48,8 @@ All BlackRoad services, apps, and docs now live in this monorepo and sync out au
> - ❌ **DO NOT** add `BlackRoad-Operating-System` to Railway as a service > - ❌ **DO NOT** add `BlackRoad-Operating-System` to Railway as a service
> - ❌ **DO NOT** deploy this monorepo to any production environment > - ❌ **DO NOT** deploy this monorepo to any production environment
> - ❌ **DO NOT** reference this repo in service configurations or env vars > - ❌ **DO NOT** reference this repo in service configurations or env vars
> - ❌ **DO NOT** publish the legacy `blackroad-os` static bundle; only ship the
> canonical UI that lives under `backend/static/`
> >
> **Deploy ONLY the satellite repositories:** > **Deploy ONLY the satellite repositories:**
> - `blackroad-os-core` (Core API) > - `blackroad-os-core` (Core API)
@@ -56,6 +58,8 @@ All BlackRoad services, apps, and docs now live in this monorepo and sync out au
> - `blackroad-os-prism-console` (Status Console) > - `blackroad-os-prism-console` (Status Console)
> - `blackroad-os-docs` (Documentation) > - `blackroad-os-docs` (Documentation)
> - `blackroad-os-web` (Public Website) > - `blackroad-os-web` (Public Website)
> - **Never deploy `BlackRoad-Operating-System` itself** — Railway, GoDaddy, and
> Pages should point at the satellites above, not this repo
> >
> **This repo is the source of truth for code**, but **satellites are the deployable services**. > **This repo is the source of truth for code**, but **satellites are the deployable services**.
> >