diff --git a/README.md b/README.md index decaa21..55a2638 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ __Note:__ If you discovered any issue with the extension registry or have an ide The key should be in `certificate.key` and the cert should be in `certificate.cert`. 4. Register a GitHub API [client app](https://github.com/settings/applications). The callback URL must match the hostname of your server. For testing, you could enter `https://localhost:4040/auth/github/callback`. -4. Also in the `config` folder, create a `config.json` file that contains: +4. Also in the `config` folder, copy the `config.json.example` file to `config.json` and make sure it contains: * `sessionSecret` - key to use for session hashing (required) * `githubClientId` - client id for registered GitHub app (required) * `githubClientSecret` - client secret for registered GitHub app (required) diff --git a/config.json.example b/config.json.example new file mode 100644 index 0000000..f84ae73 --- /dev/null +++ b/config.json.example @@ -0,0 +1,17 @@ +{ + "sessionSecret": "sessionsecret", + "githubClientId": "clientid", + "githubClientSecret": "clientsecret", + "hostname": localhost, + "securePort": 4040, + "redirectPort": 4000, + "rss.title": "", + "rss.description": "", + "rss.feedURL": "", + "rss.siteURL": "", + "admins": "github:username", + "aws.accesskey": "AWS accesskey", + "aws.secretkey": "AWS secretkey", + "s3.bucket": "S3 bucket", + "sns.topic": "" +}