mirror of
https://github.com/gchq/CyberChef.git
synced 2025-05-09 07:45:00 -04:00
commit
ca7c4377eb
2 changed files with 20 additions and 1 deletions
12
README.md
12
README.md
|
@ -20,7 +20,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:
|
||||
|
@ -102,6 +101,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/uk-government-licensing-framework/crown-copyright/).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue