-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(readme): enhance documentation with detailed overview and usage …
…instructions This commit improves the README file by adding a comprehensive overview of CyberChef, clarifying its purpose and features. It also updates the usage instructions for running CyberChef in a Docker container, and includes information on building from source and deploying on Kubernetes. Additionally, the commit refines badge descriptions for clarity and updates the license section. These changes aim to provide better guidance for users and contributors, enhancing the overall usability of the project documentation.
- Loading branch information
Showing
1 changed file
with
37 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,50 @@ | ||
# CyberChef | ||
|
||
[![Build and push](https://github.com/obeone/cyberchef-docker/actions/workflows/build-and-publish.yaml/badge.svg)](https://github.com/obeone/cyberchef-docker/actions/workflows/build-and-publish.yaml) | ||
[![Build and Push Workflow](https://github.com/obeone/cyberchef-docker/actions/workflows/build-and-publish.yaml/badge.svg)](https://github.com/obeone/cyberchef-docker/actions/workflows/build-and-publish.yaml) | ||
![Version](https://img.shields.io/github/v/tag/obeone/cyberchef-docker?label=version&style=plastic) | ||
![Date](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/obeone/876a9aed55cffad6054360c99ecf4093/raw/date.json) | ||
![Last Updated](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/obeone/876a9aed55cffad6054360c99ecf4093/raw/date.json) | ||
|
||
## Overview | ||
|
||
The Cyber Swiss Army Knife - a web app for encryption, encoding, compression and data analysis | ||
**CyberChef** is a web app known as the "Cyber Swiss Army Knife" for its wide array of operations including encryption, encoding, compression, and data analysis. This versatile tool is invaluable for cybersecurity professionals, developers, and data analysts alike. | ||
|
||
This package is rebuilt everyday to stay up-to-date and always use latest upstream version of CyberChef (there are tags using CyberChef version) | ||
This package is automatically rebuilt every day to make sure that it utilizes the latest upstream version of [CyberChef](https://github.com/gchq/CyberChef). The Docker image embeds CyberChef in an unprivileged NGINX container, providing a robust and secure environment for your operations. | ||
|
||
This docker image embbed [GCHQ CyberChef](https://github.com/gchq/CyberChef) in an unprivileged nginx. | ||
## Getting Started | ||
|
||
## Usage | ||
```sh | ||
docker run -d -p 8000:8000 ghcr.io/obeone/cyberchef:latest | ||
### Running CyberChef | ||
|
||
Run the next command to start CyberChef in a Docker container: | ||
|
||
```bash | ||
docker run -d -p 8000:8000 ghcr.io/obeone/cyberchef:latest | ||
``` | ||
|
||
And go to [http://localhost:8000](http://localhost:8000) | ||
Then, open your web browser and navigate to [http://localhost:8000](http://localhost:8000) to start using CyberChef. | ||
|
||
### Building from Source | ||
|
||
If you need to customize the build, edit `build.sh` script as needed and execute it to build your container. | ||
|
||
### Kubernetes Deployment | ||
|
||
A Helm chart is available for deploying CyberChef on Kubernetes. You can find the files and instructions [here](https://github.com/obeone/charts). | ||
|
||
## Features | ||
|
||
- **Encryption/Decryption**: Do cryptographic operations using a variety of algorithms. | ||
- **Encoding/Decoding**: Encode or decode data in formats such as Base64, URL encoding, and more. | ||
- **Data Analysis**: Conduct extensive data manipulation and analysis tasks. | ||
- **Compression/Decompression**: Easily compress and decompress data. | ||
|
||
This project follows continuous integration practices, ensuring the software remains up-to-date with the latest features and security patches from the main CyberChef repository. | ||
|
||
## Community and Support | ||
|
||
Feel free to contribute to the project by opening issues or pull requests on [GitHub](https://github.com/obeone/cyberchef-docker). | ||
|
||
## Building | ||
Customize `build.sh` if you need, and run it! | ||
For user community and support, check out the CyberChef user forum, or connect with other users and developers through relevant online platforms. | ||
|
||
## License | ||
|
||
### Kubernetes (Helm) | ||
A helm chart exists, just follow [documentation](https://github.com/obeone/charts) | ||
This project is licensed under the terms of the [MIT License](LICENSE). |