Anvil Web

Anvil Web is a web interface for Anvil Projects. It is capable of starting tests and analysing the results in realtime or after the test is finished.

Supported Projects

Currently Anvil Web supports only the following application specific implementations of Anvil Core:

• TLS-Anvil

Quick Start

To run quickly run Anvil-Web to analyze a report or start a test, download the docker-compose.yml file from the root of this project and run docker compose up -d. After that you should be able to go to http://localhost:5001/ to see the web interface.

Building

Docker (recommanded)

This project is easiest built by using the supplied Dockerfile. To build Anvil Web simply run

docker build -t anvil-web .

The resulting docker container can be run separately, but we recommand using the supplied docker compose file, since it needs a mongodb and an environment variable PRODUCTION=1 so it also serves the frontend. More information can be found under "Running".

Manualy

You will need:

• Node.js

Build steps

1. Build the frontend
   1. cd frontend
   2. npm install
   3. npm run build
2. Build the backend
   1. cd backend
   2. npm install
   3. npm run build
3. copy the frontend into the backend folder
   • cp -r frontend/dist backend/static

Running

Docker Compose (recommanded)

Anvil Web comes with a compose file, that has the web ui, mongodb and a TLS-Anvil worker ready to go. To use it you can run:

docker compose up -d

After starting, the web interface is acessible via http://localhost:5001/

The normal compose file grabs the pre-built image from our registry. If you want to run your locally built image use docker-compose-dev.yml. You can comment out or delete the worker client if you don't need that functionallity.

Docker

Anvil Web needs a mongodb database to run. The create the database using docker you can use the commands

docker network create tlsanvil
docker run --network tlsanvil mongo

To start anvil web using docker you can then run

docker run -network tlsanvil -e PRODUCTION=1 -p 5001:5001 anvil-web

After starting, the web interface is acessible via http://localhost:5001/ The backend runs on the same port.

Manually / Development environment

Starting the app manually will need a mongo db instance running. You can start the frontend and backend seperatly. The backend is started by running npm run start, but only if you built it beforehand. The frontend is started in develpment mode using npm run dev. The backend is started on port 5001 per default. The frontend will run on port 5173.

Adding a worker client

To add a worker client connected to the backend, you can run your anvil project in worker mode. As an example, here is how you would start TLS-Anvil:

java -jar TLS-Testsuite.jar worker -connect [hostname-of-backend]:[port-of-backend]