# Release Notes Hub

## Installation

The recommended way of hacking the release notes hub is by using the
docker compose based [dev env][ReleaseNotesHubDevEnv].
Run the dev env installation and setup steps.

This will launch the hub on localhost:8080.

## Environment Variables

The app is aware of the following environment variables:

| Variable | Description | Default |
|----------|-------------|---------|
| PORT | The http port the express server will listen to. | 8080 |
| MONGODB_HOST | Hostname of the mongodb backend | 'release-notes-mongo' |
| MONGODB_PORT | Port of the mongodb backend | 27017 |
| MONGODB_USER | Mongodb user | _empty_ |
| MONGODB_PASSWORD | Passoword of the mongodb user | _empty_ |
| MONGODB_DATABASE | The db to use | 'release-notes' |

[ReleaseNotesHubDevEnv]: https://github.com/release-notes/release-notes-hub-dev-env

---

### LICENSE

The files in this archive are released under MIT license.
You can find a copy of this license in [LICENSE](LICENSE).

# Release Notes Hub

## Installation

The recommended way of hacking the release notes hub is by using the
docker compose based [dev env][ReleaseNotesHubDevEnv].
Run the dev env installation and setup steps.

This will launch the hub on localhost:8080.

## Environment Variables

The app is aware of the following environment variables:

| Variable | Description | Default |
|----------|-------------|---------|
| PORT | The http port the express server will listen to. | 8080 |
| MONGODB_HOST | Hostname of the mongodb backend | 'release-notes-mongo' |
| MONGODB_PORT | Port of the mongodb backend | 27017 |
| MONGODB_USER | Mongodb user | _empty_ |
| MONGODB_PASSWORD | Passoword of the mongodb user | _empty_ |
| MONGODB_DATABASE | The db to use | 'release-notes' |
| SPARK_POST_API_KEY | Api key for sending transactional email | _empty_ |
| EMAIL_DEFAULT_REPLY_TO | Default reply-to email address | 'Release Notes <hello@release-notes.com>' |

[ReleaseNotesHubDevEnv]: https://github.com/release-notes/release-notes-hub-dev-env

---

### LICENSE

The files in this archive are released under MIT license.
You can find a copy of this license in [LICENSE](LICENSE).

Add description of new configuration variables.
Add description of new configuration variables.
