EasySafe Capella

Installation

Prerequisites

• Internet access for downloading Docker images (~5 GB)
• At least 8 GB RAM and 20 GB free disk space
• Docker is automatically installed on both platforms

Windows

1. Download the EasySafe Installer: EasySafe-Setup.exe
2. Run the installer (automatically installs Docker Desktop if not present)
3. If prompted to restart: restart your PC, then run the installer again
4. Double-click “EasySafe Capella” on your Desktop

The installer adds capella-docker to the system PATH. After installation, open a new terminal (PowerShell or CMD) to use capella-docker from any directory.

Linux (Ubuntu 22.04+)

# 1. Add the EasySafe repository
echo "deb [trusted=yes] https://apt.easy-safe.eu stable main" | sudo tee /etc/apt/sources.list.d/easysafe.list
sudo apt update

# 2. Install (automatically installs Docker, TigerVNC, Git, GitHub CLI)
sudo apt install easysafe

# 3. Log out and log back in (for Docker group permissions)

# 4. Start
capella-docker start

On first launch you will be asked for the project directory and registry login.

First Launch — EasySafe Setup

On first launch (or when Git is not configured in the workspace), EasySafe shows a Welcome to EasySafe setup dialog. Fill in:

• Name and Email (required) — your Git identity for commits
• Remote URL (optional) — HTTPS URL of your remote repository

Click Get Started to apply. EasySafe initializes Git and configures your identity automatically. You can also skip and configure later via Window > Preferences > EasySafe.

The dialog does not appear again once Git identity is configured.

Command Reference

Usage

Start and Stop

capella-docker start     # Start Capella + LSP Server
capella-docker stop      # Stop everything
capella-docker status    # Show status

capella-docker start launches Capella and the LSP Server together. After startup, the VNC Viewer opens automatically with the Capella interface.

Loading Projects

Your home directory is available inside the container at /host-home. This allows loading any Capella project without restarting:

1. In Capella: File > Import > General > Existing Projects into Workspace
2. Navigate to /host-home/path/to/project
3. Select the project and import it

The configured workspace directory is mounted at /workspace.

Switching Workspace

capella-docker workspace              # Show current, prompt for new one
capella-docker workspace /path/to/dir # Switch to a specific directory

If Capella is running, it will be stopped and restarted with the new workspace automatically.

Updating

capella-docker update    # Pull latest images and restart
capella-docker pull      # Pull latest images without restart

LSP Server (for VS Code)

The LSP Server starts automatically with capella-docker start. It can also be managed separately:

capella-docker lsp start    # Start LSP Server
capella-docker lsp stop     # Stop LSP Server
capella-docker lsp restart  # Restart LSP Server
capella-docker lsp status   # Show LSP Server status

EasySafe Help in Capella

EasySafe includes built-in documentation inside Capella:

1. Click Help > Help Contents in the Capella menu bar
2. Select EasySafe in the table of contents on the left
3. Browse topics: Overview, Getting Started, Issues, Versioning, Configuration

Troubleshooting

Configuration

Configuration is created on first launch:

• Windows: %APPDATA%\easysafe-capella\config.env
• Linux: ~/.config/easysafe-capella/config.env

Settings can be reconfigured with capella-docker init.

Ports