Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Sentry configuration, README details on disabling. Also custom mailserver README. #24

Merged
merged 2 commits into from Nov 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 23 additions & 1 deletion README.md
Expand Up @@ -74,8 +74,30 @@ Upgrading to the latest version
* Build your server from the latest code you just fetched: `docker-compose build`.
* Restart the running server to pick up the changes: `systemctl restart docker-compose@central`.

Custom Configurations
---------------------

Disabling Sentry
================

By default, we enable [Sentry error logging](https://sentry.io) on the backend server, which provides with an anonymized log of unexpected programming errors that occur while your server is running. This information never includes any of your user or form data, but if you feel uncomfortable with this anyway, you can take the following steps to disable Sentry:

1. Edit the file `files/service/config.json.template` and remove the `sentry` lines, starting with `"sentry": {` through the next three lines until you remove the matching `}`.
2. Build and run. If you already had a service image built, you may need to wipe it (`docker-compose rm service`).

Using a custom Mail Server
==========================

To use a custom mail server:

1. Ensure you have an SMTP relay server available to your Central server network host.
2. Edit the file `files/service/config.json.template`:
* Under `email`, then `transportOpts`, you'll find settings for `host` and `port.
* These correspond with the network `host`name and the TCP `port`, respectively.
3. Build and run. If you already had a service image built, you may need to wipe it (`docker-compose rm service`).

Using a custom SSL certificate (advanced)
-----------------------------------------
=========================================

To use a custom SSL certificate:

Expand Down
6 changes: 6 additions & 0 deletions files/service/config.json.template
Expand Up @@ -16,6 +16,12 @@
},
"env": {
"domain": "https://${DOMAIN}"
},
"external": {
"sentry": {
"key": "3cf75f54983e473da6bd07daddf0d2ee",
"project": "1298632"
}
}
}
}