documentation + env example

PingCAP-QE · Nov 27, 2020 · 884e7b9 · 884e7b9
1 parent 98705b6
commit 884e7b9
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/.env.example b/.env.example
@@ -5,5 +5,4 @@ export MONGODB=mongodb://cla_assistant:cla_assistant@localhost:27017/cla_assista
 export GITHUB_CLIENT=
 export GITHUB_SECRET=
 
-export GITHUB_USER=
-export GITHUB_PASS=
+export GITHUB_TOKEN=
diff --git a/README.md b/README.md
@@ -121,6 +121,15 @@ Clone this repository, change into the cloned directory and install dependencies
 
 `<PROTOCOL>://<HOST>:<PORT>/auth/github/callback`.
 
+
+You can use ngrok to get a publicly accessible URL which redirects to your localhost:5000 by executing the following command 
+```sh
+/ngrok http 5000
+```  
+
+If you use ngrok, you need to update the HOST variable in your .env and set PROTOCOL to "https".
+
+
 Copy the sample configuration file `.env.example` file to `.env`.
 
 	cp .env.example .env