Skip to content

Commit

Permalink
docs: make python 3.12 and docker requirement more present
Browse files Browse the repository at this point in the history
  • Loading branch information
danielgrittner committed Sep 12, 2024
1 parent d8053fa commit bb3b408
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 16 additions & 2 deletions docs/pages/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -22,6 +22,20 @@ You can create your first workflow within less than 10 minutes:
</Callout>

<Steps>
### 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:
Expand Down

0 comments on commit bb3b408

Please sign in to comment.