Skip to content

Quick start

Zoey cheering with both fists raised

You need a Linux machine with Docker Engine and the Compose plugin. Labs run on the same machine.

  1. Install and start Antimony. The script checks for Docker, downloads the latest release of Antimony into ./antimony, generates passwords and secrets and starts everything. The first start downloads the images.

    Terminal window
    curl -fsSL https://antimony.run/deploy.sh | bash

    Before it changes anything, the script checks that the ports it needs are free and shows what it will do. Antimony needs full access to the machine to run labs: its server is a privileged root container with access to Docker, it stores data in /srv/antimony, and it listens on ports 8080 (the web interface) and 6969 (SSH for node shells and packet capture). Ports 3000, 5432 and 8100 must be free as well, but are only used on localhost. Confirm with y, or set ANTIMONY_YES=1 to skip the question.

    The script doesn’t use sudo itself, but it needs access to Docker. If docker ps only works with sudo on your machine, run the script with sudo too. The install folder then belongs to root, so use sudo for later docker compose commands in it as well.

    Terminal window
    curl -fsSL https://antimony.run/deploy.sh | sudo bash

    When it’s done, it prints the admin password. Run the same command again later to update Antimony; your passwords are kept.

  2. Open http://localhost:8080 and sign in as admin with the printed password.

Settings and manual install

The script reads these environment variables, for example curl -fsSL https://antimony.run/deploy.sh | SB_PORT=9000 bash. With sudo, put them after it: … | sudo SB_PORT=9000 bash, because sudo drops variables set before it.

Variable Default Description
ANTIMONY_DIR ./antimony Where to install.
SB_PORT 8080 Port of the web interface.
ANTIMONY_VERSION latest The release to install, for example 0.1.0, or dev for the development version. Running the script again with another version switches to it.
ANTIMONY_YES not set Set to 1 to install without asking. Without a terminal, for example in automation, the script doesn’t ask either.

To do it by hand instead, download the deployment of the current release and start it. Without a .env file, the login is admin / admin.

Terminal window
curl -fsSL https://github.com/antimony-team/antimony/releases/download/v0.1.0/antimony-deployment.tar.gz | tar -xz
cd antimony
docker compose up -d
  1. Open the Topology editor, create a collection called playground and a topology called srl_lab.

  2. Paste this topology and save with Ctrl+S:

    name: srl_lab
    topology:
    nodes:
    srl1:
    kind: nokia_srlinux
    image: ghcr.io/nokia/srlinux:24.10
    srl2:
    kind: nokia_srlinux
    image: ghcr.io/nokia/srlinux:24.10
    links:
    - endpoints: ["srl1:ethernet-1/1", "srl2:ethernet-1/1"]
  3. Click Deploy in the toolbar, enter a Lab name such as srl-lab-1 and click Deploy in the dialog.

  4. On the Dashboard, open the lab, click srl1 and choose Open terminal.