Admyral Repository · Docs · Discord

Admyral Quickstart

Prerequisites:

• Python 3.12 (Recommended to install via pyenv)
• Poetry (Recommended installation via pipx: pipx install poetry)
• Docker

Getting Started

1. Clone this repository:

git clone git@github.com:Admyral-Security/admyral-quickstart.git
cd admyral-quickstart

2. Install the required Python packages in the admyral-quickstart repo:

poetry install

Optionally, specify custom ports for the needed services

Copy the content of .env.example to a new file called .env:

cp .env.example .env

Open the .env file and change ports as needed.

Afterwards, source the .env file to load the environment variables:

source .env

3. Start Admyral (Hint: you can also use poetry shell then you can omit poetry run in the following commands):

poetry run admyral up

4. Open the Admyral UI by visiting http://localhost:3000 in your browser. If a custom port was defined using ADMYRAL_WEB_PORT, use the defined port number instead of 3000.

5. Go to workflows/analyze_url.py to check out the workflow defined in code.

6. The workflow uses VirusTotal to analyze a URL. You will need to provide your VirusTotal API key. You can get a free API key by signing up at VirusTotal and then store it using the Admyral CLI (Note: replace your_api_key with the VirusTotal API key):

poetry run admyral secret set virustotal_api_key --value api_key=your_api_key

7. You can use the admyral CLI to push your first workflow:

poetry run admyral workflow push analyze_url -f workflows/analyze_url.py --activate

8. You can now run the workflow from the Admyral UI or using the admyral CLI:

poetry run admyral workflow trigger analyze_url -p '{"url": "https://www.google.com"}'

9. You can inspect the steps of the workflow run in the Admyral UI by entering the workflow and then clicking on Run History.

More Examples

You can find more examples here.