In a Nutshell (🌰)

• Comprehensive guides for all major SSM features
• Step-by-step instructions with screenshots
• Organized by functional areas (devices, containers, etc.)
• Includes troubleshooting and best practices
• Follow user paths based on your specific needs

What You'll Find Here

The User Guides section provides detailed instructions for using all major features of Squirrel Servers Manager, organized by functional area.

🖥️

Devices

Add, configure, manage, and monitor your servers and devices

Adding devices · Management

🐳

Containers

Deploy and manage Docker containers across your infrastructure

Container basics · Deploy from store

⏱️

Automations

Set up scheduled tasks and automated workflows

Automation basics · Schedules

📦

Stacks

Deploy multi-container applications and run Ansible playbooks

Playbooks · Container Stacks

Getting Started

If you're new to SSM, we recommend following this learning path:

1

First Steps

Begin with adding your first device to SSM.

Add a Device

2

Container Basics

Learn the fundamentals of managing containers.

Manage Containers

3

Simple Deployment

Try deploying an application from the template store.

Deploy from Store

4

Automate

Set up basic automations for your routine tasks.

Setup Automations

User Paths

Depending on your role and goals, you might want to explore the documentation in different orders:

For DevOps Engineers

Focus on container orchestration and automation:

1

Container Management

Master deploying and managing Docker containers.

Explore Management

2

Container Stacks

Define and run multi-container applications using Docker Compose.

Explore Stacks

3

Automations

Automate routine tasks and workflows for your servers.

Explore Automations

4

Remote Stack Repositories

Manage and use remote repositories for container stacks.

Explore Repositories

For System Administrators

Prioritize device management and playbooks:

1

Device Management

Add, configure, and monitor your physical or virtual devices.

Explore Devices

2

SSH Configuration

Set up secure SSH connections for device management.

Explore SSH Config

3

Playbooks

Use Ansible playbooks for advanced server configuration.

Explore Playbooks

4

Scheduled Tasks

Configure and manage scheduled automations.

Explore Schedules

For Home Lab Users

Start with the basics and build up:

1

Adding Devices

Get your first server or device connected to SSM.

Learn Adding Devices

2

Deploying from Store

Quickly deploy common applications from the template store.

Explore Store

3

Container Basics

Understand the fundamentals of container management.

Learn Container Basics

4

Simple Automations

Create basic automations to simplify your lab tasks.

Explore Creating Automations

Advanced Features

Beyond the basics, SSM offers advanced capabilities for power users:

🗄️

Repository Management

Work with local and remote repositories for playbooks and container stacks.

Local Repositories · Remote Repositories

⚙️

System Settings

Configure global system settings and integrations.

General Settings · Container Registries · MCP Settings