ARTEMIS is built as a multi-container Docker application.
The following instructions will get you a containerized
copy of the ARTEMIS tool up and running on your local machine using the
For instructions on how to set up ARTEMIS
in a Kubernetes environment, please check the related docs page.
Minimum Technical Requirements
- CPU: 4 cores (note that needed CPU cores depend on the number of separate processes, e.g., detectors or database modules you spawn)
- RAM: 4+ GB (note that needed memory depends on the number of configured prefixes/rules/asns and load of incoming BGP updates, see here for more details)
- HDD: 50 GB (less may suffice, depending on the use case for storing BGP updates and hijack alerts)
- NETWORK: 1 public-facing network interface (optionally: one internal interface for connection with local route collectors)
- OS: Ubuntu Linux 16.04+ (other Linux distributions will work too)
- SW PACKAGES:
docker-composeshould be pre-installed (see instructions later) and
dockershould have sudo privileges, if only non-sudo user is allowed
Moreover, one may optionally configure firewall rules related to the server/VM. We recommend using ufw for this task. Please check the comments in the respective script we provide and set the corresponding <> fields in the file before running:
How to Install and Setup
To download and install the required software packages, please follow steps 1 through 6 described in this docs section.
To setup the tool (as well as https access to it via the web application), please follow steps 1 through 5 described in this docs section.
Note that specifically for testing purposes, we now support
VirtualBox VM automation; please check out this docs page for simple instructions on how to spin up a fully functioning ARTEMIS VM, running all needed microservices, within a minute.
How to Run and Configure
docker-compose up -d
Please consult this docs section if you need to activate additional services.
Visit web UI and configure ARTEMIS:
By visiting the system page:
- edit the basic configuration file of ARTEMIS that serves as the ground truth for detecting BGP hijacks (consult this docs section first)
- control the monitoring, detection and mitigation modules.
Stop ARTEMIS (optional)
Note: We highly recommend going through the detailed docs instructions before using ARTEMIS for the first time. You can further use several other microservices orthogonal to ARTEMIS (like
routinator) by using the main ARTEMIS
docker-compose yaml plus the additional yamls:
docker-compose -f docker-compose.yaml -f docker-compose.<other_service>.yaml -... <up>/<down>/...
A running demo of ARTEMIS based on the configuration of our home institute (FORTH) can be found here.
You can access the demo as a guest (non-admin) user by using the following credentials:
username: "guest" password: "guest@artemis"
Please do not request new accounts on the demo portal. Use the given credentials to browse ARTEMIS as a guest user. In case you need admin access, simply clone ARTEMIS locally and use the given configuration file.