Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dockerfile and instructions #1215

Closed
wants to merge 3 commits into from
Closed

Add dockerfile and instructions #1215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
012b54d
adding a dockerfile
d4v3y0rk Jun 20, 2021
0668a9d
update readme with docker instructions
d4v3y0rk Jun 20, 2021
f3abb05
update readme per suggestion
d4v3y0rk Jul 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
FROM node:dubnium-buster-slim
RUN apt-get update && apt-get install -y build-essential && rm -rf /var/lib/apt/lists/*

COPY . /
ENV NODE_OPTIONS="--max_old_space_size=2048"
RUN npm install node-sass
RUN npm install -g grunt-cli
RUN npm i
CMD grunt dev
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ Cryptographic operations in CyberChef should not be relied upon to provide secur

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


## How it works

There are four main areas in CyberChef:
Expand Down Expand Up @@ -104,6 +103,17 @@ An installation walkthrough, how-to guides for adding new operations and themes,
- Submit a pull request. If you are doing this for the first time, you will be prompted to sign the [GCHQ Contributor Licence Agreement](https://cla-assistant.io/gchq/CyberChef) via the CLA assistant on the pull request. This will also ask whether you are happy for GCHQ to contact you about a token of thanks for your contribution, or about job opportunities at GCHQ.


## Running in Docker

If you would like to run the app locally in docker please follow the steps below:

```
git clone https://github.com/gchq/CyberChef.git
cd CyberChef
docker build --tag cyberchef .
docker run --rm --name cyberchef -it -p 8080:8080 cyberchef
```

## Licencing

CyberChef is released under the [Apache 2.0 Licence](https://www.apache.org/licenses/LICENSE-2.0) and is covered by [Crown Copyright](https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/copyright-and-re-use/crown-copyright/).
Expand Down