Quick start
You need a Linux machine with Docker Engine and the Compose plugin. Labs run on the same machine.
-
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 | bashBefore 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 onlocalhost. Confirm with y, or setANTIMONY_YES=1to skip the question.The script doesn’t use
sudoitself, but it needs access to Docker. Ifdocker psonly works withsudoon your machine, run the script withsudotoo. The install folder then belongs to root, so usesudofor laterdocker composecommands in it as well.Terminal window curl -fsSL https://antimony.run/deploy.sh | sudo bashWhen it’s done, it prints the admin password. Run the same command again later to update Antimony; your passwords are kept.
-
Open http://localhost:8080 and sign in as
adminwith 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.
curl -fsSL https://github.com/antimony-team/antimony/releases/download/v0.1.0/antimony-deployment.tar.gz | tar -xzcd antimonydocker compose up -dYour first lab
Section titled “Your first lab”-
Open the Topology editor, create a collection called
playgroundand a topology calledsrl_lab. -
Paste this topology and save with Ctrl+S:
name: srl_labtopology:nodes:srl1:kind: nokia_srlinuximage: ghcr.io/nokia/srlinux:24.10srl2:kind: nokia_srlinuximage: ghcr.io/nokia/srlinux:24.10links:- endpoints: ["srl1:ethernet-1/1", "srl2:ethernet-1/1"] -
Click Deploy in the toolbar, enter a Lab name such as
srl-lab-1and click Deploy in the dialog. -
On the Dashboard, open the lab, click
srl1and choose Open terminal.
Next steps
Section titled “Next steps”- Concepts: collections, topologies and labs
- Topology editor and lab view
- Capture traffic in Wireshark