Skip to main content
Under 60 seconds

Get started with nyxd

Pick your system, then run three steps: install, check, and run a container.

Linux
Desktop

  1. Install

    ~30 s

    Adds the signed nyxd repository for your package manager, installs nyxd, nyx and crun, and starts the service. It asks for sudo.

    curl -fsSL https://pkgs.nyxd.io/install.sh | sh

  2. Use nyx without sudo

    ~5 s

    Join the nyx group and pick it up in this shell.

    sudo usermod -aG nyx "$USER"
    newgrp nyx
    nyx ping

  3. Run your first container

    ~20 s

    Start nginx, publish it on port 8080, check it answers, then clean up.

    nyx run -d --name web -p 8080:80 nginx:alpine
    curl -s localhost:8080 | grep title
    nyx ps
    nyx rm web
Set up the apt repository by hand
sudo curl -fsSLo /usr/share/keyrings/nyxd.gpg https://pkgs.nyxd.io/nyxd.gpg
echo "deb [signed-by=/usr/share/keyrings/nyxd.gpg] https://pkgs.nyxd.io/apt stable main" | sudo tee /etc/apt/sources.list.d/nyxd.list
sudo apt-get update && sudo apt-get install -y nyxd

Signing key fingerprint C910 E8A2 2680 CCCB BB7E 6ED2 F0DC FE8A 242B 1E99. From then on your system's upgrades keep nyxd current.

Installer options
curl -fsSL https://pkgs.nyxd.io/install.sh | sh -s -- --version v1.0.0   # a given release
curl -fsSL https://pkgs.nyxd.io/install.sh | sh -s -- --no-start         # set up, do not start
curl -fsSL https://pkgs.nyxd.io/install.sh | sh -s -- --uninstall        # remove (add --purge for data)

Every option is in the install guide.

Next

Compose stacksRun multi-service apps from a compose.yaml.Build imagesnyx build: Dockerfiles without Docker or BuildKit.RootlessRun the daemon as your own user.HTTP APIEverything nyx does, over a Unix socket.