Skip to content

Commit 9fc91b3

Browse files
authored
Merge pull request #1873 from remingtr/enhance-README
Add more clear build instructions
2 parents c57556f + 6dd651a commit 9fc91b3

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,36 @@ Cryptographic operations in CyberChef should not be relied upon to provide secur
2020

2121
[A live demo can be found here][1] - have fun!
2222

23-
## Containers
23+
## Running Locally with Docker
2424

25-
If you would like to try out CyberChef locally you can either build it yourself:
25+
**Prerequisites**
2626

27+
- [Docker](hhttps://www.docker.com/products/docker-desktop/)
28+
- Docker Desktop must be open and running on your machine
29+
30+
31+
#### Option 1: Build the Docker Image Yourself
32+
33+
1. Build the docker image
2734
```bash
2835
docker build --tag cyberchef --ulimit nofile=10000 .
36+
```
37+
2. Run the docker container
38+
```bash
2939
docker run -it -p 8080:80 cyberchef
3040
```
41+
3. Navigate to `http://localhost:8080` in your browser
42+
43+
#### Option 2: Use the pre-built Docker Image
3144

32-
Or you can use our image directly:
45+
If you prefer to skip the build process, you can use the pre-built image
3346

3447
```bash
3548
docker run -it -p 8080:80 ghcr.io/gchq/cyberchef:latest
3649
```
3750

51+
Just like before, navigate to `http://localhost:8080` in your browser.
52+
3853
This image is built and published through our [GitHub Workflows](.github/workflows/releases.yml)
3954

4055
## How it works

0 commit comments

Comments
 (0)