Skip to content

Commit 65b3338

Browse files
author
Ilya Radchenko
committed
Merge pull request #35 from reiven/master
Updated Readme with more complete information on setting custom hostname and port
2 parents 647eeef + 502ea4b commit 65b3338

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,23 @@ your projects. It registers webhooks and sets up ssh keys (if you so choose).
1010

1111
If you are running on `localhost:3000` the default settings should work just fine.
1212

13-
### Custom hostname
13+
### Use custom hostname and port
1414

15-
if you are *not* using localhost:3000 as your hostname:
15+
To use a custom hostname and port:
1616

17-
- you need to register your own github app, with the authentication URL set to your server's hostname + `/auth/github/callback`, e.g. 'https://strider.example.com/auth/github/callback'. This can be done [here](https://github.com/settings/applications/new).
18-
- set the env variables `PLUGIN_GITHUB_APP_ID` and `PLUGIN_GITHUB_APP_SECRET` to those of your app
19-
- you need to set the ENV variable `PLUGIN_GITHUB_HOSTNAME` to your server's hostname (including `http://` or `https://`)
17+
- set this environment variables with you hosname/port information
18+
19+
```
20+
PORT=9999
21+
SERVER_NAME="http://your.strider.hostname:9999"
22+
PLUGIN_GITHUB_APP_ID="hereComesTheId"
23+
PLUGIN_GITHUB_APP_SECRET="theSecretFromGithub"
24+
```
25+
26+
- register your own github app [here](https://github.com/settings/applications/new) and set authentication URL your server's hostname:port + `/auth/github/callback`, for example:
27+
28+
```
29+
http://your.strider.hostname:9999/auth/github/callback
30+
```
31+
32+
- also make sure your github profile has a public email set

0 commit comments

Comments
 (0)