Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
515b412
Add reusable dashboard card components for visual insights
May 12, 2025
fc86841
Merge remote-tracking branch 'origin/master' into feature/poc-dashboard
May 20, 2025
a150842
Merge remote-tracking branch 'origin/master' into feature/poc-dashboard
May 20, 2025
b3451a5
Add customizable dashboard with drag-and-drop widget support
May 21, 2025
028f385
Merge remote-tracking branch 'origin/master' into feature/poc-dashboard
Jun 9, 2025
663ffaf
POC DASHBOARD
Jun 15, 2025
b79b0a9
Merge remote-tracking branch 'origin/master' into feature/poc-dashboard
Jun 28, 2025
e49b02b
Refactor LineChart component and integrate dynamic widget settings
Jun 29, 2025
999316c
Merge remote-tracking branch 'origin/master' into feature/poc-dashboard
Jul 13, 2025
09f47f0
Add `isPreview` mode for LineChart and AreaInstalledBarChartCard
Jul 19, 2025
dd0fa4e
Merge remote-tracking branch 'origin/master' into feature/poc-dashboard
Jul 19, 2025
a2c4be4
Remove deprecated dashboard chart components and styles
Jul 19, 2025
469fe5e
Refactor dashboard components and add `DebugOverlay`
Jul 19, 2025
41fc94a
Add enhanced widget configuration features and color themes.
Jul 19, 2025
d7ca9aa
Add logging improvements and RSS widget enhancements
Jul 19, 2025
56db715
Add advanced logger, RSSController tests, and dashboard optimizations
Jul 19, 2025
2768049
Refactor dashboard components to streamline widget configuration and …
Jul 20, 2025
3b2f88e
Remove unused dashboard chart components: `PieChart`, `StackedBarChar…
Jul 21, 2025
46c3372
Optimize dashboard layout and widget configuration
Jul 21, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,4 @@ README-task-master.md
.mcp.json
.claude/settings.local.json
**/.claude/settings.local.json
/next-js/
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20.18.2
298 changes: 298 additions & 0 deletions README-github-compatible.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,298 @@
<div align="center">
<a href="https://squirrelserversmanager.io">
<img src="./site/public/images/logo.svg" alt="Squirrel Servers Manager" width="400" />
</a>

<br />
<br />

<h1>🐿️ Squirrel Servers Manager</h1>

<p align="center">
<b>The beautiful, user-friendly server management platform you've been waiting for</b>
</p>

<p align="center">
All-in-one configuration and container management, powered by Ansible, Docker & Prometheus
</p>

<br />

<!-- Navigation -->
<p align="center">
<a href="https://squirrelserversmanager.io"><b>Website</b></a> •
<a href="https://squirrelserversmanager.io/docs"><b>Documentation</b></a> •
<a href="https://demo.squirrelserversmanager.io"><b>Live Demo</b></a> •
<a href="#-quickstart"><b>Quick Start</b></a> •
<a href="#-features"><b>Features</b></a> •
<a href="#-community"><b>Community</b></a>
</p>

<br />

<!-- Badges -->
<p align="center">
<a href="https://github.com/SquirrelCorporation/SquirrelServersManager/actions/workflows/docker-publish.yml">
<img src="https://github.com/SquirrelCorporation/SquirrelServersManager/actions/workflows/docker-publish.yml/badge.svg" alt="Docker Build" />
</a>
<a href="https://github.com/SquirrelCorporation/SquirrelServersManager/actions/workflows/test-client.yml">
<img src="https://github.com/SquirrelCorporation/SquirrelServersManager/actions/workflows/test-client.yml/badge.svg" alt="Client Tests" />
</a>
<a href="https://github.com/SquirrelCorporation/SquirrelServersManager/actions/workflows/test-server.yml">
<img src="https://github.com/SquirrelCorporation/SquirrelServersManager/actions/workflows/test-server.yml/badge.svg" alt="Server Tests" />
</a>
<a href="https://github.com/SquirrelCorporation/SquirrelServersManager/actions/workflows/test-playbooks.yml">
<img src="https://github.com/SquirrelCorporation/SquirrelServersManager/actions/workflows/test-playbooks.yml/badge.svg" alt="Playbook Tests" />
</a>
</p>

<p align="center">
<img src="https://img.shields.io/github/license/SquirrelCorporation/SquirrelServersManager?style=flat-square&color=blue" alt="License" />
<img src="https://img.shields.io/github/stars/SquirrelCorporation/SquirrelServersManager?style=flat-square&color=yellow" alt="Stars" />
<img src="https://img.shields.io/github/forks/SquirrelCorporation/SquirrelServersManager?style=flat-square&color=blue" alt="Forks" />
<img src="https://img.shields.io/badge/status-alpha-orange?style=flat-square" alt="Status" />
</p>

<br />

<!-- Hero Screenshot -->
<img src="./site/public/images/home-dashboard.png" alt="SSM Dashboard" width="90%" />
</div>

<br />

---

## 🎯 Why Squirrel Servers Manager?

### 🎨 **Beautiful UI/UX First**
> Unlike traditional server management tools, SSM prioritizes user experience with a modern, intuitive interface that makes complex tasks simple.

### 🔓 **100% Open Source**
> No vendor lock-in, no hidden costs. SSM is completely open source and free forever. Run it on your infrastructure, your way.

### 🔧 **All-in-One Solution**
> Stop juggling multiple tools. SSM combines container management, configuration automation, monitoring, and more in a single platform.

### 🚀 **Easy to Get Started**
> One command to install, intuitive onboarding, and sensible defaults. Get up and running in minutes, not hours.

<br />

## ⚡ QuickStart

### 🎯 One-Line Install (Recommended)

```bash
curl https://raw.githubusercontent.com/SquirrelCorporation/SquirrelServersManager/master/getSSM.sh | bash
```

> 🔗 See the [full installation guide](https://squirrelserversmanager.io/docs/getting-started) for detailed instructions

### 🐳 Docker Compose Install

<details>
<summary><b>Production Setup</b></summary>

```bash
# 1. Clone the repository
git clone https://github.com/SquirrelCorporation/SquirrelServersManager.git
cd SquirrelServersManager

# 2. Configure your environment
cp .env.example .env
# Edit .env with your settings

# 3. Start SSM
docker compose up -d

# 🎉 Access SSM at http://localhost:3000
```

</details>

<details>
<summary><b>Development Setup</b></summary>

```bash
# 1. Clone the repository
git clone https://github.com/SquirrelCorporation/SquirrelServersManager.git
cd SquirrelServersManager

# 2. Configure your environment
cp .env.example .env
# Edit .env with your settings

# 3. Start development environment
docker compose -f docker-compose.dev.yml up

# 🔧 Development server with hot reload at http://localhost:3000
```

</details>

<br />

## ✨ Features

### 📊 **Metrics & Monitoring**
Real-time CPU, RAM, disk, and network monitoring with anomaly detection and beautiful dashboards.

### 🐳 **Container Management**
Full Docker integration - manage containers, monitor stats, handle multi-registry authentication, and receive update notifications.

### 📚 **Ansible Playbooks**
Execute and manage Ansible playbooks with a beautiful interface, Git integration, and real-time execution logs.

### 🤖 **Automations**
Create powerful automation workflows triggered by events, schedules, or system conditions.

### 🔐 **Enterprise Security**
Ansible Vault integration, encrypted credential storage, SSH key management, and role-based access control.

### 📦 **Service Collections**
Deploy popular open-source services with one click from our curated collection.

<br />

## 🖼️ Screenshots

<details>
<summary><b>View All Screenshots</b></summary>

#### Devices Overview
![Devices](./site/public/images/home-devices.png)

#### Services Management
![Services](./site/public/images/home-services.png)

#### Service Store
![Store](./site/public/images/home-store.png)

#### Playbook Execution
![Playbook](./site/public/images/home-playbook.png)

#### Device Details
![Device Info](./site/public/images/home-device-info.png)

#### Add New Device
![New Device](./site/public/images/home-new-device.png)

</details>

<br />

## 🏗️ Tech Stack

**Frontend:**
React 18 • TypeScript • Ant Design Pro • WebSocket

**Backend:**
NestJS • MongoDB • Redis • WebSocket • Clean Architecture

**Infrastructure:**
Docker • Ansible • Prometheus • Node Exporter

<br />

## 🚀 Roadmap

### ✅ **Current (Alpha)**
- Core device management
- Container orchestration
- Ansible integration
- Basic automations
- Real-time monitoring

### 🚧 **Beta (Q1 2025)**
- Plugin system
- Advanced automations
- Multi-user improvements
- Mobile app
- Kubernetes support

### 🔮 **Future**
- Cloud sync
- AI-powered insights
- Terraform integration
- Advanced RBAC
- Enterprise features

<br />

## 🤝 Community

### 💬 Get Help & Connect

[![Discord](https://img.shields.io/badge/Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/your-discord)
[![GitHub Discussions](https://img.shields.io/badge/GitHub_Discussions-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/SquirrelCorporation/SquirrelServersManager/discussions)
[![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/your-twitter)

### 🌟 Contributing

We love contributions! Whether it's:
- 🐛 Bug reports
- 💡 Feature requests
- 📖 Documentation improvements
- 🔧 Code contributions

See our [Contributing Guide](./CONTRIBUTING.md) to get started.

### 🏆 Contributors

<a href="https://github.com/SquirrelCorporation/SquirrelServersManager/graphs/contributors">
<img src="https://contrib.rocks/image?repo=SquirrelCorporation/SquirrelServersManager" />
</a>

<br />

## 🛡️ Security

- 🔐 All secrets encrypted with Ansible Vault
- 🔑 SSH key management with encryption
- 🛡️ Role-based access control
- 📝 Audit logging
- 🔒 HTTPS/TLS support

Found a security issue? Please email security@squirrelserversmanager.io

<br />

## 📊 Telemetry

SSM collects anonymous usage statistics to help improve the product. This data:
- ✅ Is completely anonymous
- ✅ Contains no sensitive information
- ✅ Helps us understand usage patterns
- ✅ Can be disabled anytime

To opt-out, set `TELEMETRY_ENABLED=false` in your `.env` file.

<br />

## ⚖️ License

Squirrel Servers Manager is licensed under the [GNU Affero General Public License v3.0](./LICENSE).

<br />

## 🙏 Acknowledgments

Built with amazing open-source projects including NestJS, React, Ansible, Docker, MongoDB, and many more.

Special thanks to all our contributors, early adopters, testers, and the open-source community.

---

<div align="center">
<br />
<img src="./site/public/images/squirrels/happy-fox.svg" width="100" alt="Happy Squirrel" />
<br />
<br />
<p>
<b>Made with 🥜 by the Squirrel Corporation team</b>
</p>
<p>
<i>Building the future of server management, one nut at a time</i>
</p>
</div>
Loading
Loading