From 77ea609056296127933ae479cf3480e72faddc53 Mon Sep 17 00:00:00 2001 From: Adam Shannon Date: Fri, 14 Aug 2020 14:20:32 -0500 Subject: [PATCH] docs: a bit more detail on customers, database sections --- docs/config.md | 40 +++++++++++++++++++++++++++------------- 1 file changed, 27 insertions(+), 13 deletions(-) diff --git a/docs/config.md b/docs/config.md index 78806f606..d5b18eb5a 100644 --- a/docs/config.md +++ b/docs/config.md @@ -44,8 +44,27 @@ admin: [ disableConfigEndpoint: | default = false ] ``` +### Customers + +Right now we support the [Moov Customers](https://github.com/moov-io/customers) service for reading Customer and Account information. We are looking to support additional services. + +```yaml +customers: + # A DNS record responsible for routing us to a Moov Customers instance. + endpoint:
+ accounts: + decryptor: + symmetric: + # Base64 encoded URI for encryption key to use + # Example: base64key:// + keyURI: + [ debug: | default = false ] +``` + ### Database +In production deployments we recommend deploying a replicated and secure MySQL cluster. + ```yaml database: # Setup a SQLite connection for the database. If using this config all fields are required. @@ -242,17 +261,12 @@ validation: [ description: ] ``` -### Customers +## Getting Help -```yaml -customers: - # A DNS record responsible for routing us to a Moov Customers instance. - endpoint:
- accounts: - decryptor: - symmetric: - # Base64 encoded URI for encryption key to use - # Example: base64key:// - keyURI: - [ debug: | default = false ] -``` + channel | info + ------- | ------- + [Project Documentation](https://moov-io.github.io/paygate/) | Our project documentation available online. + [Hosted Documentation](https://docs.moov.io/paygate/) | Hosted documentation for enterprise solutions. + Twitter [@moov_io](https://twitter.com/moov_io) | You can follow Moov.IO's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories. + [GitHub Issue](https://github.com/moov-io) | If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error. + [moov-io slack](https://slack.moov.io/) | Join our slack channel (`#paygate`) to have an interactive discussion about the development of the project.