Skip to content
This repository has been archived by the owner on Dec 9, 2021. It is now read-only.

Commit

Permalink
docs: a bit more detail on customers, database sections
Browse files Browse the repository at this point in the history
  • Loading branch information
adamdecaf committed Aug 14, 2020
1 parent a971fa8 commit 77ea609
Showing 1 changed file with 27 additions and 13 deletions.
40 changes: 27 additions & 13 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,27 @@ admin:
[ disableConfigEndpoint: <boolean> | 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: <address>
accounts:
decryptor:
symmetric:
# Base64 encoded URI for encryption key to use
# Example: base64key://<base64-string>
keyURI: <string>
[ debug: <boolean> | 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.
Expand Down Expand Up @@ -242,17 +261,12 @@ validation:
[ description: <string> ]
```
### Customers
## Getting Help
```yaml
customers:
# A DNS record responsible for routing us to a Moov Customers instance.
endpoint: <address>
accounts:
decryptor:
symmetric:
# Base64 encoded URI for encryption key to use
# Example: base64key://<base64-string>
keyURI: <string>
[ debug: <boolean> | 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.

0 comments on commit 77ea609

Please sign in to comment.