diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000000..ce17e0b88e --- /dev/null +++ b/Dockerfile @@ -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 diff --git a/README.md b/README.md index ac9b8174e4..6e80684568 100755 --- a/README.md +++ b/README.md @@ -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: @@ -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/).