# Release Notes Hub

## Feature Ideas

- Publish release notes on the hub
- Slick UI for release notes page
- Subscribe to release events
  - On version level: new patch/minor/major version release
  - On modification level: new security fix, bugfix, deprecation, etc.
  - Receive notifications through slack, email, etc.
- Serving release notes on custom domain
- Private release notes, ACL, AUTH

# 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

Add quick info about installation & configuration.
Add quick info about installation & configuration.
