Skip to content

Commit

Permalink
Add more clear build instructions
Browse files Browse the repository at this point in the history
Added more clear build instructions to the README.
  • Loading branch information
remingtr committed Aug 9, 2024
1 parent a477f47 commit 77c2b79
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,36 @@ Cryptographic operations in CyberChef should not be relied upon to provide secur

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

## Containers
## Running Locally with Docker

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

- [Docker](hhttps://www.docker.com/products/docker-desktop/)
- Docker Desktop must be open and running on your machine


#### Option 1: Build the Docker Image Yourself

1. Build the docker image
```bash
docker build --tag cyberchef --ulimit nofile=10000 .
```
2. Run the docker container
```bash
docker run -it -p 8080:80 cyberchef
```
3. Navigate to `http://localhost:8080` in your browser

#### Option 2: Use the pre-built Docker Image

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

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

Just like before, navigate to `http://localhost:8080` in your browser.

This image is built and published through our [GitHub Workflows](.github/workflows/releases.yml)

## How it works
Expand Down

0 comments on commit 77c2b79

Please sign in to comment.