https://github.com/patchmon/patchmon
Linux Patch Monitoring Automation Platform
https://github.com/patchmon/patchmon
apt apt-get centos debian dnf docker linux node redhat ubuntu updates yum
Last synced: 3 months ago
JSON representation
Linux Patch Monitoring Automation Platform
- Host: GitHub
- URL: https://github.com/patchmon/patchmon
- Owner: PatchMon
- License: gpl-3.0
- Created: 2025-09-16T13:23:41.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-10-31T15:41:20.000Z (3 months ago)
- Last Synced: 2025-10-31T17:27:09.209Z (3 months ago)
- Topics: apt, apt-get, centos, debian, dnf, docker, linux, node, redhat, ubuntu, updates, yum
- Language: JavaScript
- Homepage: https://patchmon.net
- Size: 57.7 MB
- Stars: 711
- Watchers: 2
- Forks: 32
- Open Issues: 97
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PatchMon - Linux Patch Monitoring made Simple
[](https://patchmon.net)
[](https://patchmon.net/discord)
[](https://github.com/9technologygroup/patchmon.net)
[](https://github.com/users/9technologygroup/projects/1)
[](https://docs.patchmon.net/)
---
## Please STAR this repo :D
## Purpose
PatchMon provides centralized patch management across diverse server environments. Agents communicate outbound-only to the PatchMon server, eliminating inbound ports on monitored hosts while delivering comprehensive visibility and safe automation.
## Features
### Dashboard
- Customisable dashboard with per‑user card layout and ordering
### Users & Authentication
- Multi-user accounts (admin and standard users)
- Roles, Permissions & RBAC
### Hosts & Inventory
- Host inventory/groups with key attributes and OS details
- Host grouping (create and manage host groups)
### Packages & Updates
- Package inventory across hosts
- Outdated packages overview and counts
- Repositories per host tracking
### Agent & Data Collection
- Agent version management and script content stored in DB
### Settings & Configuration
- Server URL/protocol/host/port
- Signup toggle and default user role selection
### API & Integrations
- REST API under `/api/v1` with JWT auth
- Proxmox LXC Auto-Enrollment - Automatically discover and enroll LXC containers from Proxmox hosts
### Security
- Rate limiting for general, auth, and agent endpoints
- Outbound‑only agent model reduces attack surface
### Deployment & Operations
- Docker installation & One‑line self‑host installer (Ubuntu/Debian)
- systemd service for backend lifecycle
- nginx vhost for frontend + API proxy; optional Let’s Encrypt integration
## Getting Started
### PatchMon Cloud (coming soon)
Managed, zero-maintenance PatchMon hosting. Stay tuned.
### Self-hosted Installation
#### Docker (preferred)
For getting started with Docker, see the [Docker documentation](https://github.com/PatchMon/PatchMon/blob/main/docker/README.md)
#### Native Install (advanced/non-docker)
Run on a clean Ubuntu/Debian server with internet access:
#### Debian:
```bash
apt update -y
apt upgrade -y
apt install curl -y
```
#### Ubuntu:
```bash
apt-get update -y
apt-get upgrade -y
apt install curl -y
```
#### Install Script
```bash
curl -fsSL -o setup.sh https://raw.githubusercontent.com/PatchMon/PatchMon/refs/heads/main/setup.sh && chmod +x setup.sh && bash setup.sh
```
#### Update Script (--update flag)
```bash
curl -fsSL -o setup.sh https://raw.githubusercontent.com/PatchMon/PatchMon/refs/heads/main/setup.sh && chmod +x setup.sh && bash setup.sh --update
```
#### Minimum specs for building : #####
CPU : 2 vCPU
RAM : 2GB
Disk : 15GB
During setup you’ll be asked:
- Domain/IP: public DNS or local IP (default: `patchmon.internal`)
- SSL/HTTPS: `y` for public deployments with a public IP, `n` for internal networks
- Email: only if SSL is enabled (for Let’s Encrypt)
- Git Branch: default is `main` (press Enter)
The script will:
- Install prerequisites (Node.js, PostgreSQL, nginx)
- Clone the repo, install dependencies, build the frontend, run migrations
- Create a systemd service and nginx site vhost config
- Start the service and write a consolidated info file at:
- `/opt//deployment-info.txt`
- Copies the full installer log to `/opt//patchmon-install.log` from /var/log/patchmon-install.log
After installation:
- Visit `http(s)://` and complete first-time admin setup
- See all useful info in `deployment-info.txt`
## Forcing updates after host package changes
Should you perform a manual package update on your host and wish to see the results reflected in PatchMon quicker than the usual scheduled update, you can trigger the process manually by running:
```bash
/usr/local/bin/patchmon-agent.sh update
```
This will send the results immediately to PatchMon.
## 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
```mermaid
flowchart LR
A[End Users / Browser
Admin UI / Frontend] -- HTTPS --> B[nginx
serve FE, proxy API]
B -- HTTP --> C["Backend
(Node/Express)
/api, auth, Prisma"]
C -- TCP --> D[PostgreSQL
Database]
E["Agents on your servers (Outbound Only)"] -- HTTPS --> F["Backend API
(/api/v1)"]
```
Operational
- systemd manages backend service
- certbot/nginx for TLS (public)
- setup.sh bootstraps OS, app, DB, config
## Support
- Discord: [https://patchmon.net/discord](https://patchmon.net/discord)
- Email: support@patchmon.net
## Roadmap
- Roadmap board: https://github.com/orgs/PatchMon/projects/2
## License
- AGPLv3 (More information on this soon)
---
## 🤝 Contributing
We welcome contributions from the community! Here's how you can get involved:
### Development Setup
1. **Fork the Repository**
```bash
# Click the "Fork" button on GitHub, then clone your fork
git clone https://github.com/YOUR_USERNAME/patchmon.net.git
cd patchmon.net
```
2. **Create a Feature Branch**
```bash
git checkout -b feature/your-feature-name
# or
git checkout -b fix/your-bug-fix
```
4. **Install Dependencies and Setup Hooks**
```bash
npm install
npm run prepare
```
5. **Make Your Changes**
- Write clean, well-documented code
- Follow existing code style and patterns
- Add tests for new functionality
- Update documentation as needed
6. **Test Your Changes**
```bash
# Run backend tests
cd backend
npm test
# Run frontend tests
cd ../frontend
npm test
```
7. **Commit and Push**
```bash
git add .
git commit -m "Add: descriptive commit message"
git push origin feature/your-feature-name
```
8. **Create a Pull Request**
- Go to your fork on GitHub
- Click "New Pull Request"
- Provide a clear description of your changes
- Link any related issues
### Contribution Guidelines
- **Code Style**: Follow the existing code patterns and Biome configuration
- **Commits**: Use conventional commit messages (feat:, fix:, docs:, etc.)
- **Testing**: Ensure all tests pass and add tests for new features
- **Documentation**: Update README and code comments as needed
- **Issues**: Check existing issues before creating new ones
---
## 🏢 Enterprise & Custom Solutions
### PatchMon Cloud
- **Fully Managed**: We handle all infrastructure and maintenance
- **Scalable**: Grows with your organization
- **Secure**: Enterprise-grade security and compliance
- **Support**: Dedicated support team
### Custom Integrations
- **API Development**: Custom endpoints for your specific needs
- **Third-Party Integrations**: Connect with your existing tools
- **Custom Dashboards**: Tailored reporting and visualization
- **White-Label Solutions**: Brand PatchMon as your own
### Enterprise Deployment
- **On-Premises**: Deploy in your own data center
- **Air-Gapped**: Support for isolated environments
- **Compliance**: Meet industry-specific requirements
- **Training**: Comprehensive team training and onboarding
*Contact us at support@patchmon.net for enterprise inquiries*
---
---
## 🙏 Acknowledgments
### Special Thanks
- **Jonathan Higson** - For inspiration, ideas, and valuable feedback
- **@Adam20054** - For working on Docker Compose deployment
- **@tigattack** - For working on GitHub CI/CD pipelines
- **Cloud X** and **Crazy Dead** - For moderating our Discord server and keeping the community awesome
- **Beta Testers** - For keeping me awake at night
- **My family** - For understanding my passion
### Contributors
Thank you to all our contributors who help make PatchMon better every day!
## 🔗 Links
- **Website**: [patchmon.net](https://patchmon.net)
- **Discord**: [https://patchmon.net/discord](https://patchmon.net/discord)
- **Roadmap**: [GitHub Projects](https://github.com/users/9technologygroup/projects/1)
- **Documentation**: [https://docs.patchmon.net](https://docs.patchmon.net)
- **Support**: support@patchmon.net
---
**Made with ❤️ by the PatchMon Team**
[](https://patchmon.net/discord)
[](https://github.com/PatchMon/PatchMon)