From bb3b40870bf13489d2a274e6c160f0d058008458 Mon Sep 17 00:00:00 2001 From: Daniel Grittner Date: Thu, 12 Sep 2024 21:23:03 +0200 Subject: [PATCH] docs: make python 3.12 and docker requirement more present --- README.md | 5 +++++ docs/pages/quickstart.mdx | 18 ++++++++++++++++-- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 440009fb..2dbe491e 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,11 @@ Start Admyral to access the frontend, execute workflows using Admyral's scalable $ admyral up ``` +> [!IMPORTANT] +> Admyral is built with Python 3.12 and requires Docker to be installed on your machine. \ +> If you don't have Docker installed, you can download it [here](https://docs.docker.com/get-docker/). \ +> If you don't have Python 3.12 installed, you can download it [here](https://www.python.org/downloads/) or use your favorite package manager (e.g., `brew`). + More instructions on self-hosting with Docker can be found [here](https://docs.admyral.dev/docker), and for the development setup, click [here](https://docs.admyral.dev/development_setup). ## Simple, reliable Security Engineering using Admyral's Python SDK diff --git a/docs/pages/quickstart.mdx b/docs/pages/quickstart.mdx index 73880872..dc49f38e 100644 --- a/docs/pages/quickstart.mdx +++ b/docs/pages/quickstart.mdx @@ -8,8 +8,8 @@ This quickstart helps you to create your first workflow within Admyral. The work **Prerequisites**: -- Python 3.12 -- Docker +- Python 3.12 (Download [here](https://www.python.org/downloads/) or use your favorite package manager, such as `brew`) +- [Docker](https://docs.docker.com/get-started/get-docker/) ## Getting Started @@ -22,6 +22,20 @@ You can create your first workflow within less than 10 minutes: +### Step 0: Verify your Setup + +Admyral requires Python 3.12 to be installed. You can check whether you have Python 3.12 installed by running the following: + +```bash +python --version +``` + +Additionally, Docker must be installed and should be running. You can verify that Docker is installed and the Docker daemon is running by executing the following command: + +```bash +docker ps +``` + ### Step 1: Installing and Starting Admyral To install Admyral, simply install the Admyral pip package using your favorite dependency management tool: