Merge pull request #10 from RuiSiang/dockerize

Dockerize

.dockerignore

@@ -0,0 +1,4 @@
+dist
+node_modules
+npm-debug.log
+npm-error.log

.env.example

@@ -1,6 +1,7 @@
-SESSION_KEY='abcdefghijklmnop'
+PORT=3000
+SESSION_KEY="abcdefghijklmnop"
 WAF=on
 POW=on
 NONCE_VALIDITY=60000
 INITIAL_DIFFICULTY=13
-BACKEND_URL='http://example.com'
+BACKEND_URL="http://example.com"

.gitignore

@@ -1,3 +1,5 @@
+# Compose File
+docker-compose.yaml
 # Logs
 logs
 *.log

Dockerfile

@@ -0,0 +1,8 @@
+FROM node:12
+WORKDIR /usr/src/pow-shield
+COPY package*.json ./
+RUN npm ci
+COPY . .
+RUN npm run build
+EXPOSE ${PORT}
+CMD [ "node", "dist/bin/server.js" ]

README.md

@@ -16,30 +16,38 @@ github repo
 ```
 # clone repo first
 npm install
-cp .env.example .env
+cp -n .env.example .env
 # edit .env
 npm run build
 npm start
 ```
-dockerhub (work in progress)
+docker run
+```
+docker run -p 3000:3000 -e BACKEND_URL="http://example.com" -d ruisiang/pow-shield
+```
+docker-compose
+```
+see docker-compose.example.yaml
+```
 
 ## Configuration
++ PORT: port that PoW Shield listens to
 + SESSION_KEY: secret key for cookie signatures, use a unique one for security reasons, or anyone can forge your signed cookies
 + WAF: toggles waf functionality on/off (waf is a work in progress)
 + POW: toggles PoW functionality on/off (if not temporary switched off, why use this project at all?)
 + NONCE_VALIDITY: specifies the maximum time a nonce has to be submitted to the server after generation(used to enforce difficulty change and filter out stale nonces)
 + INITIAL_DIFFICULTY: initial difficulty, number of leading 0-bits in produced hash (0:extremely easy ~ 256:impossible, 13(default):takes about 5 seconds for the browser to calculate)
-+ BACKEND_URL: location to proxy authenticated traffic to, IP and URLs are both accepted
++ BACKEND_URL: location to proxy authenticated traffic to, IP and URLs are both accepted(accepts protocol://url(:port) or protocol://ip(:port))
 
 ## TODOs
 - [x] Web Service Structure
 - [x] Proxy Functionality
 - [x] PoW Implementation
+- [x] Dockerization
 - [ ] WAF Implementation
 - [ ] IP Blacklisting
 - [ ] Dynamic Difficulty
 - [ ] Unit Testing
-- [ ] Dockerization
 - [ ] Multi-Instance Syncing
 
 ## License

docker-compose.example.yaml

@@ -0,0 +1,17 @@
+version: '3.4'
+
+services:
+  pow-shield:
+    image: ruisiang/pow-shield
+    environment:
+      - PORT=3000
+      - SESSION_KEY="abcdefghijklmnop"
+      - WAF=on
+      - POW=on
+      - NONCE_VALIDITY=60000
+      - INITIAL_DIFFICULTY=13
+      - BACKEND_URL="http://example.com"
+    expose:
+      - '3000'
+    ports:
+      - '3000:3000'