Browse Source

Update readme

Thomas Dy 8 years ago
parent
commit
26b4e18669
1 changed files with 11 additions and 8 deletions
  1. 11 8
      README.md

+ 11 - 8
README.md

@@ -9,16 +9,18 @@ webserver that handles making the actual requests to Cloudflare.
 
 
 ## Usage
 ## Usage
 
 
-After cloning the repository, copy `config.json.example` to `config.json` and
-fill it with your account details and put the domains you want to manage in the
-`whitelist` array. Afterwards, run `npm install` then `npm start` and you should
-be able to manage your domains in `localhost:8000`.
+Download the [binary][2] (only Linux x86_64 for now). Get a copy of
+`config.json.example` and name it `config.json`. Place it in the same directory
+as the binary. Fill in your account details and the domains to be whitelisted.
+Afterwards, run the binary and you should be able to manage your domains at
+`localhost:8000`.
 
 
 ## Security
 ## Security
 
 
-The server does not provide any form of authentication. It is meant to be run
-behind a reverse proxy such as nginx with basic auth, or behind something like
-[oauth2_proxy][2].
+The server only listens at 127.0.0.1. It does not provide any form of
+authentication. It is meant to be run behind a reverse proxy such as nginx with
+basic auth, or behind something like
+[oauth2_proxy][3].
 
 
 The server never exposes your username and token to the clients, all requests to
 The server never exposes your username and token to the clients, all requests to
 Cloudflare are made from the server. The server will also only allow API
 Cloudflare are made from the server. The server will also only allow API
@@ -26,4 +28,5 @@ requests to domains specified in the whitelist. Domains not listed will be
 blocked even if your account owns it.
 blocked even if your account owns it.
 
 
 [1]: https://support.cloudflare.com/hc/en-us/articles/200167846-How-do-I-add-additional-users-to-my-CloudFlare-account-
 [1]: https://support.cloudflare.com/hc/en-us/articles/200167846-How-do-I-add-additional-users-to-my-CloudFlare-account-
-[2]: https://github.com/bitly/oauth2_proxy
+[2]: https://github.com/thatsmydoing/cloudflare-webui/releases
+[3]: https://github.com/bitly/oauth2_proxy