Skip to content

antimony-team/antimony

Repository files navigation

Antimony Logo

Antimony

Antimony is a platform and graphical interface to design and manage containerlab networks.

Antimony

✨ Features

  • Designing Networks Easily
    Antimony offers a user friendly drag-and-drop interface to quickly and efficiently design containerlab networks.
  • Side-By-Side Editor
    The side-by-side code editor makes direct adjustments to the topology's definition more straightforward.
  • Deployment and Management of Instances
    Antimony's management interfaces grants full control over all scheduled, running and inactive containerlab instances.
  • Clabernetes Support
    Experimental support for the clabernetes backend that allows deployment on Kubernetes instances.
  • User Access Management via OpenID
    Antimony supports multi-user application through the OpenID provider of your choice.
  • Real-time Updates
    Antimony talks to containerlab and Docker and provides real-time information on containers such as deployment status, Docker stats and more!
  • Log Streaming
    The interface allows you to view containerlab and Docker logs in real-time.

🚀 How to Run

To run Antimony locally, simply clone this repository and deploy the docker containers with docker compose.

git clone https://github.com/antimony-team/antimony
cd antimony
docker compose up

By default, the server is hosted on localhost:80 and localhost:443 and the interface can be accessed with the admin:admin.

For more information about the deployment please refer to Antimony's documentation.

⚙️ Configuration

The config file config.yml is mounted into the docker container and can be used to configure the Antimony server.

For more information about the contiguration please refer to Antimony's documentation.

💼 Use cases

  • Educational Environment
    Antimony was developed with the main goal of being a platform for teachers to teach students about networking technology. The scalable architecture and external authentication make it easy to deploy Antimony in an educational environment.
  • Personal Use and Local Deployment
    The interface of Antimony aims to make designing and deploying containerlab networks easy and accesible for everyone. Deploying and using Antimony locally requires little to no experience with networks or the containerlab framework.

🖥️ Repository Setup

Antimony is separated into three main repositories.

If you encounter any issues or would like to suggest a new feature, please submit an issue to the corresponding repository.

License

Antimony and all of its assets are distributed under the MIT license.

About

A visual approach to designing and managing Containerlab networks.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •  

Languages