paulmataruso/patchmon.net
1
0
Fork 0
mirror of https://github.com/9technologygroup/patchmon.net.git synced 2025-11-06 15:03:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: move getting started above architecture/comms model

Browse Source
This commit is contained in:
tigattack
2025-09-24 10:07:43 +01:00
committed by GitHub
parent 8dc702e7fc
commit 61db61e1ba
1 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
README.md
View File

@@ -100,37 +100,6 @@ PatchMon provides centralized patch management across diverse server environment
- Works for internal (HTTP) and public (HTTPS) deployments - Works for internal (HTTP) and public (HTTPS) deployments
- Defaults safe for first‑time setup; admin created interactively - Defaults safe for first‑time setup; admin created interactively
## Communication Model
- Outbound-only agents: servers initiate communication to PatchMon
- No inbound connections required on monitored servers
- Secure server-side API with JWT authentication and rate limiting
## Architecture
- Backend: Node.js/Express + Prisma + PostgreSQL
- Frontend: Vite + React
- Reverse proxy: nginx
- Database: PostgreSQL
- System service: systemd-managed backend
```
+----------------------+ HTTPS +--------------------+ HTTP +------------------------+ TCP +---------------+
| End Users (Browser) | ---------> | nginx | --------> | Backend (Node/Express) | ------> | PostgreSQL |
| Admin UI / Frontend | | serve FE, proxy API| | /api, auth, Prisma | | Database |
+----------------------+ +--------------------+ +------------------------+ +---------------+
Agents (Outbound Only)
+---------------------------+ HTTPS +------------------------+
| Agents on your servers | ----------> | Backend API (/api/v1) |
+---------------------------+ +------------------------+
Operational
- systemd manages backend service
- certbot/nginx for TLS (public)
- setup.sh bootstraps OS, app, DB, config
```
## Getting Started ## Getting Started
### PatchMon Cloud (coming soon) ### PatchMon Cloud (coming soon)
@@ -169,6 +138,37 @@ After installation:
- Visit `http(s)://<your-domain>` and complete first-time admin setup - Visit `http(s)://<your-domain>` and complete first-time admin setup
- See all useful info in `deployment-info.txt` - See all useful info in `deployment-info.txt`
## Communication Model
- Outbound-only agents: servers initiate communication to PatchMon
- No inbound connections required on monitored servers
- Secure server-side API with JWT authentication and rate limiting
## Architecture
- Backend: Node.js/Express + Prisma + PostgreSQL
- Frontend: Vite + React
- Reverse proxy: nginx
- Database: PostgreSQL
- System service: systemd-managed backend
```
+----------------------+ HTTPS +--------------------+ HTTP +------------------------+ TCP +---------------+
| End Users (Browser) | ---------> | nginx | --------> | Backend (Node/Express) | ------> | PostgreSQL |
| Admin UI / Frontend | | serve FE, proxy API| | /api, auth, Prisma | | Database |
+----------------------+ +--------------------+ +------------------------+ +---------------+
Agents (Outbound Only)
+---------------------------+ HTTPS +------------------------+
| Agents on your servers | ----------> | Backend API (/api/v1) |
+---------------------------+ +------------------------+
Operational
- systemd manages backend service
- certbot/nginx for TLS (public)
- setup.sh bootstraps OS, app, DB, config
```
## Support ## Support
- Discord: https://discord.gg/S7RXUHwg - Discord: https://discord.gg/S7RXUHwg