EasySafe

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

Features

Getting Started

The recommended workflow is to create a repository on GitHub first, then clone it locally. EasySafe automatically detects the Git configuration and sets everything up.

Step 1: Create a Repository on GitHub

Go to github.com/new and create a new repository for your Capella project. Choose a repository name, select public or private visibility, and click Create repository.

Step 2: Clone the Repository

Copy the SSH URL from the repository page and clone it in a terminal:

git clone git@github.com:owner/repo.git

Use the cloned directory as your workspace when starting Capella with capella-docker start. EasySafe automatically detects the Git configuration (remote URL, user name, email, GitHub token) — no manual configuration needed.

Step 3: Configure Versioning

Open Window > Preferences > EasySafe > Versioning inside Capella:

1. Click Auto-detect from Remote — verifies that the Git remote is correctly configured and fills in Remote Provider, URL, Username, and Repository automatically.
2. Click Sign in with GitHub... — authenticates your GitHub account and stores a token. The token is required for the GitHub Issue Bridge. If a token was already detected (e.g. from gh auth login), this step can be skipped.
3. Click Apply and Close.

If no token is available yet, clicking Sign in with GitHub... opens a Device Flow dialog. A browser window opens where you log in to GitHub and enter the displayed code to authorize EasySafe.

Step 4: Enable Issue Bridges

Open Window > Preferences > EasySafe > Issues:

1. Under Bridge Integrations, enable one or more bridges (GitHub Bridge, GitLab Bridge, or Jira Bridge).
2. Click Apply and Close.
3. Reopen Preferences > EasySafe > Issues. The enabled bridge now appears as a sub-page (e.g. Issues > GitHub Bridge).
4. Open the bridge sub-page, click Test Connection to verify the token, then click Sync Now for an initial synchronization. The status should show OK - Connected.

Alternative: Manual Setup via Setup Wizard

If you do not have a GitHub repository yet, EasySafe shows a Welcome to EasySafe setup dialog on first launch. Enter your Name, Email, and optionally a Remote URL, then click Get Started. EasySafe initializes Git and configures your identity automatically. You can also skip and configure later via Window > Preferences > EasySafe.

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.

Versioning (inside Capella)

Right-click on a model element in Capella and use the EasySafe context menu:

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

The EasySafe splash screen checks for updates on every start. If an update is available, an orange Update button appears. Click it to update automatically. You can also skip the update by clicking Next.

The splash screen showing an available update — click Update to install, or Next to skip.

CLI (all platforms): Update Docker images from the command line:

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

Uninstalling

Windows: Use Settings > Apps > EasySafe Capella > Uninstall or run the uninstaller from the Start Menu.

Ubuntu/Debian: sudo apt remove easysafe

Other Linux: cd easysafe && sudo ./uninstall.sh

On all platforms, Docker images remain on disk after uninstall. To remove them:

docker rmi docker.easy-safe.eu/easysafe/capella:7.0.1-vnc
docker rmi docker.easy-safe.eu/easysafe/lsp-server:latest

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, Excel-Git Sync, Templates, 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