Skip to content
This repository has been archived by the owner on Dec 2, 2019. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Dougley authored Feb 23, 2018
1 parent eb0f8f8 commit b7c273b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
Bezerk is a websocket-based server designed to remotely manage [WildBeast](https://github.com/TheSharks/WildBeast) instances by sending JavaScript instructions.

# Deployment
Bezerk requires 2 environment variables to be present, namely `BEZERK_PORT`, and `BEZERK_SECRET`.
Bezerk requires 2 environment variables to be present, namely `BEZERK_PORT`, and `BEZERK_SECRET`, please note that this program will output little to no console output.
`BEZERK_PORT` defines the port where the server should listen on, `BEZERK_SECRET` is a shared secret between listeners and WildBeast shards used for simple identification.
**It's important to choose a strong secret and keep it secure!**

# Warnings
Bezerk handles sensitive data and should be kept as secure as possible, malicious connections to Bezerk could result in arbitrary code execution in the context of your WildBeast shards.
Bezerk handles sensitive data and should be kept as secure as possible, malicious connections to Bezerk could result in arbitrary code execution in the context of your WildBeast shards.

0 comments on commit b7c273b

Please sign in to comment.