Updated Readme and workflow

Author: Haroun AL MOUNAYAR

.github/workflows/python-package.yml

@@ -0,0 +1,27 @@
+name: release
+
+on:
+  push:
+    tags: ["v[0-9]+.[0-9]+.[0-9]+"]
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ github.ref_name }}
+          release_name: Release ${{ github.ref_name }}
+          draft: false
+          prerelease: false

.github/workflows/release.yml

@@ -1,4 +1,5 @@
 FROM node:19.5.0-slim
+gin docker 
 
 WORKDIR /usr/src/app
 

Dockerfile

@@ -12,8 +12,17 @@ server except those made to the **/logs** page and the **/craft** page.
 The logs can be foung in JSON format to be exported by doing a GET request to
 **/api/logs**
 
+Example:
+
+![image](./a_ciphered_request.png "An example")
+
+![image](./a_deciphered_request.png "An example")
+
+![image](./a_crafted_response.png "An example")
+
 In the **/craft** page you can craft responses to GET requests at a specific URL.
 You can even specify the Content Type of the response.
+
 For example for the crafted response in the below image, when you do a GET
 to **/test** you will get an empty JSON as a response.
 
@@ -33,18 +42,17 @@ EXPLOIT_SERVER_KEY=mushokutensei npm start
 
 EXPLOIT_SERVER_KEY is the password that we will generate a symmetric key from that will be used to encrypt the logs.
 
-In `test/requester.sh` there is a small script that will assess the performance by sending a lotf of request to the exploit server locally.
-
-If you want to develop, fork this repo, do your stuff in your fork in development branch, then do a PR to development. Then on each new release, the development branch will be merged with master.
-
-PR from fork should not be made to master.
+In `test/requester.sh` there is a small script that will assess the performance by sending a lot of request to the exploit server locally.
 
 ## Deployment
 
 It was designed to be deployed internally in a Kubernetes or Openshift Cluster to aid internal pentest engagement.
 
+A Docker image is available.
 
+```
 
-The link to the image:
-TODO
+docker run -it -e "EXPLOIT_SERVER_KEY=mushokutensei" -p 3000:3000 h4r0r/exploit-server:1.0
+
+```