Welcome to Squirrel Servers Manager Documentation !

Squirrel Servers Manager (SSM) is a versatile backend and frontend solution for configuration and Docker management. It's designed to be simple to use while offering comprehensive customization options. This portal provides all the information you need to install, configure, use, and understand SSM.

No agents required — just SSH!

🚀 Quick Start: Installation

Get up and running with SSM in just a few minutes.

Automagic Features

Once a device is added, SSM will automagically:

📉 Downtime Detection

Detect downtimes automatically.

⚙️ System Info Retrieval

Retrieve hardware key usage and software versions.

🐳 Docker Element Sync

Pull running containers and Docker elements.

✨ Update Detection

Detect container image updates.

🚀 Container Management

Allow you to deploy & manage containers on your devices.

📜 Playbook Execution

Allow you to run playbooks for configuration management.

Schematic Overview

SSH based

• Connections from SSM 🐿️ to your devices 🌰🌰🌰 run through SSH.
• Credentials are encrypted using Ansible Vault.

Explore Our Documentation

🚀 Getting Started

Installation, first steps, requirements, and troubleshooting basics.

📖 User Guides

Detailed how-to guides for using SSM features like device and container management, playbooks, and settings.

💡 Concepts

Understand the core architecture, agentless operation, data models, and security principles of SSM.

📚 Reference

Detailed reference material for environment variables, configurations (SSH, Docker, Ansible), and technical specifications.

🧑‍💻 Developer Docs

Information for developers on plugins, API integration, and contributing to SSM.

🤝 Community & Support

Find out how to contribute, get support, and view the project roadmap.