Shimpz
Installation guide

Install on Linux

Supported · amd64

Follow these steps on a Linux amd64 computer or server. Shimpz encrypts its Local volumes without requiring an encrypted host disk.

  1. Check your processor

    Open a terminal and run:

    Terminal · Linux
    uname -m
    x86_64

    Continue when the result is x86_64.

  2. Install the storage tools

    Shimpz requires cryptsetup 2.4 or newer to create and verify the LUKS2 volume. On Ubuntu or Debian, install the storage tools:

    Terminal · Ubuntu or Debian
    sudo apt-get update && sudo apt-get install -y cryptsetup e2fsprogs util-linux
    Terminal · cryptsetup check
    cryptsetup --version
    cryptsetup 2.4.3

    Continue when the version number is 2.4 or newer.

  3. Install Docker

    Install Docker Engine 25.0 or newer with runc 1.2.8+, 1.3.3+, or 1.4.0+ (shown by docker version) and Docker Compose 2.20.2 or newer, then confirm both commands work:

    Terminal · Docker check
    docker version
    docker compose version

    Both commands must work without sudo. If you just added your user to the docker group, sign out and back in, or restart, before installing Shimpz.

  4. Install Shimpz

    Run the bootstrap from the same terminal. It acquires the release-bound CLI, which asks for administrator authorization and then asks you to create the passphrase for the encrypted Local volume. Keep that passphrase in your password manager.

    Terminal · Shimpz install
    curl -fsSL https://install.shimpz.com | sh

  5. Unlock after a restart

    Shimpz never stores the volume passphrase and remains stopped after the host restarts. Run the installed CLI, enter the existing passphrase, and wait for the success message. Automatic update checks do not prompt, use sudo, or start a locked Space.

    Terminal · Shimpz unlock
    shimpz install

  6. Confirm that Admin opens

    A successful shimpz install prints the exact local Admin address. Open that address on the same computer; it is http://127.0.0.1:7777 when SHIMPZ_PORT was not changed. Continue when you see the initial password-and-authenticator setup or sign-in screen. For a remote server, use the SSH forwarding instructions on the next page.