From 5ce71f86e0538f763a63d9b1e19133484ae2dd3c Mon Sep 17 00:00:00 2001 From: Nathan Lakritz Date: Wed, 7 Jul 2021 09:54:37 -0700 Subject: [PATCH] docs: update twitter and switch titles to sentence case (#954) * switch twitter and sentence case * make docs site toc sentence case --- README.md | 48 ++++++++++++++++++------------------- docs/README.md | 2 +- docs/_data/docs-menu.yml | 36 ++++++++++++++-------------- docs/balanced-offset.md | 6 ++--- docs/changes.md | 6 ++--- docs/create-file.md | 8 +++---- docs/custom-validation.md | 12 +++++----- docs/file-structure.md | 6 ++--- docs/flatten-batches.md | 6 ++--- docs/intro.md | 2 +- docs/merging-files.md | 4 ++-- docs/metrics.md | 2 +- docs/returns.md | 6 ++--- docs/sec-codes-table.md | 20 ++++++++-------- docs/segment-file.md | 6 ++--- docs/usage-command-line.md | 4 ++-- docs/usage-configuration.md | 6 ++--- docs/usage-go.md | 8 +++---- 18 files changed, 94 insertions(+), 94 deletions(-) diff --git a/README.md b/README.md index 8bb141ef9..473e26371 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ [![Slack Channel](https://slack.moov.io/badge.svg?bg=e01563&fgColor=fffff)](https://slack.moov.io/) [![Docker Pulls](https://img.shields.io/docker/pulls/moov/ach)](https://hub.docker.com/r/moov/ach) [![GitHub Stars](https://img.shields.io/github/stars/moov-io/ach)](https://github.com/moov-io/ach) -[![Twitter](https://img.shields.io/twitter/follow/moov_io?style=social)](https://twitter.com/moov_io?lang=en) +[![Twitter](https://img.shields.io/twitter/follow/moov?style=social)](https://twitter.com/moov?lang=en) # moov-io/ach Moov's mission is to give developers an easy way to create and integrate bank processing into their own software products. Our open source projects are each focused on solving a single responsibility in financial services and designed around performance, scalability, and ease of use. @@ -30,27 +30,27 @@ ACH implements a reader, writer, and validator for Automated Clearing House ([AC If you're looking for a complete implementation of ACH origination (file creation), OFAC checks, micro-deposits, SFTP uploading, and other features, the [moov-io/paygate](https://github.com/moov-io/paygate) project aims to be a full system for ACH transfers. Otherwise, check out our article on [How and When to use the Moov ACH Library](https://moov.io/blog/education/how-and-when-to-use-the-moov-ach-library/). -## Table of Contents +## Table of contents -- [Project Status](#project-status) +- [Project status](#project-status) - [Usage](#usage) - As an API - [Docker](#docker) ([Config](#configuration-settings)) - [Google Cloud](#google-cloud-run-button) ([Config](#configuration-settings)) - [HTTP API](#http-api) ([Config](#configuration-settings)) - - [Data Persistence](#data-persistence) - - [As a Go Module](#go-library) - - [As a Command Line Tool](#command-line) - - [As an In-Browser Parser](##in-browser-ach-file-parser) -- [SDKs (OpenAPI)](#sdks) -- [Learn About ACH](#learn-about-ach) + - [Data persistence](#data-persistence) + - [As a Go module](#go-library) + - [As a command line tool](#command-line) + - [As an in-browser parser](##in-browser-ach-file-parser) +- [OpenAPI SDKs](#sdks) +- [Learn about ACH](#learn-about-ach) - [FAQ](#faq) -- [Getting Help](#getting-help) -- [Supported and Tested Platforms](#supported-and-tested-platforms) +- [Getting help](#getting-help) +- [Supported and tested platforms](#supported-and-tested-platforms) - [Contributing](#contributing) -- [Related Projects](#related-projects) +- [Related projects](#related-projects) -## Project Status +## Project status Moov ACH is actively used in multiple production environments. Please star the project if you are interested in its progress. The project supports generating and parsing all Standard Entry Class (SEC) codes. If you have layers above ACH to simplify tasks, perform business operations, or found bugs we would appreciate an issue or pull request. Thanks! @@ -92,7 +92,7 @@ curl http://localhost:8080/files/ {"file":{"id":"","fileHeader":{"id":"","immediateDestination":"231380104","immediateOrigin":"121042882", ... ``` -### Google Cloud Run Button +### Google Cloud Run button To get started in a hosted environment you can deploy this project to the Google Cloud Platform. @@ -212,7 +212,7 @@ Examples: [Go](examples/http/main.go) | [Ruby](https://github.com/moov-io/ruby-a - [Create an ACH file for a payment and get the raw file](https://github.com/moov-io/ruby-ach-demo) -### Configuration Settings +### Configuration settings | Environmental Variable | Description | Default | |-----|-----|-----| @@ -223,11 +223,11 @@ Examples: [Go](examples/http/main.go) | [Ruby](https://github.com/moov-io/ruby-a | `HTTPS_CERT_FILE` | Filepath containing a certificate (or intermediate chain) to be served by the HTTP server. Requires all traffic be over secure HTTP. | Empty | | `HTTPS_KEY_FILE` | Filepath of a private key matching the leaf certificate from `HTTPS_CERT_FILE`. | Empty | -### Data Persistence +### Data persistence By design ACH **does not persist** (save) any data about the files, batches, or entry details created. The only storage occurs in memory of the process and upon restart ACH will have no files, batches, or data saved. Also, no in memory encryption of the data is performed. -### Go Library +### Go library This project uses [Go Modules](https://github.com/golang/go/wiki/Modules) and Go v1.14 or higher. See [Golang's install instructions](https://golang.org/doc/install) for help in setting up Go. You can download the source code and we offer [tagged and released versions](https://github.com/moov-io/ach/releases/latest) as well. We highly recommend you use a tagged release for production. @@ -283,7 +283,7 @@ The package [`github.com/moov-io/ach`](https://pkg.go.dev/github.com/moov-io/ach -### Command Line +### Command line On each release there's an `achcli` utility released. This tool can display ACH files in a human-readable format which is easier to read than their plaintext format. It also allows masking `DFIAccountNumber` values with the `-mask` flag. @@ -309,7 +309,7 @@ Describing ACH file 'test/testdata/ppd-debit.ach' 1 1 1 100000000 0 ``` -### In-Browser ACH File Parser +### In-browser ACH file parser Using our [in-browser utility](http://oss.moov.io/ach/), you can instantly convert ACH files into JSON. Either paste in ACH file content directly or choose a file from your local machine. This tool is particulary useful if you're handling sensitive PII or want perform some quick tests, as operations are fully client-side with nothing stored in memory. ### SDKs @@ -320,7 +320,7 @@ Below are some SDKs generated from the API documentation: - TODO - OpenAPI Guide -## Learn About ACH +## Learn about ACH - [Official Nacha ACH Guide for Developers](https://dev-ach-guide.pantheonsite.io/) - [Intro to ACH](https://moov-io.github.io/ach/intro/) @@ -347,18 +347,18 @@ We support generating and parsing all Standard Entry Class (SEC) codes. You can purchase the most recent Nacha Operating Rules and Guidelines resource directly from their webstore. Additionally, Nacha has published a free ACH guide for developers. -## Getting Help +## Getting help If you have ACH-specific questions, NACHA (National Automated Clearing House Association) has their [complete specification](docs/2013-Corporate-Rules-and-Guidelines.pdf) for all file formats and message types. channel | info ------- | ------- [Project Documentation](https://moov-io.github.io/ach/) | Our project documentation available online. -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. +Twitter [@moov](https://twitter.com/moov) | 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/ach/issues/new) | 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 to have an interactive discussion about the development of the project. -## Supported and Tested Platforms +## Supported and tested platforms - 64-bit Linux (Ubuntu, Debian), macOS, and Windows - Raspberry Pi @@ -384,7 +384,7 @@ We maintain a comprehensive suite of unit tests and recommend table-driven testi We currently run fuzzing over ACH in the form of a [`moov/achfuzz`](https://hub.docker.com/r/moov/achfuzz) Docker image. You can [read more](./test/fuzz-reader/README.md) or run the image and report crasher examples to [`security@moov.io`](mailto:security@moov.io). Thanks! -## Related Projects +## Related projects As part of Moov's initiative to offer open source fintech infrastructure, we have a large collection of active projects you may find useful: - [Moov Watchman](https://github.com/moov-io/watchman) offers search functions over numerous trade sanction lists from the United States and European Union. diff --git a/docs/README.md b/docs/README.md index c5c7e5516..add0c7bcf 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,6 +13,6 @@ If you have ACH-specific questions, NACHA (National Automated Clearing House Ass channel | info ------- | ------- [Project Documentation](https://moov-io.github.io/ach/) | Our project documentation available online. -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. +Twitter [@moov](https://twitter.com/moov) | 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/ach/issues/new) | 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 to have an interactive discussion about the development of the project. diff --git a/docs/_data/docs-menu.yml b/docs/_data/docs-menu.yml index 4360a909b..a32da6410 100644 --- a/docs/_data/docs-menu.yml +++ b/docs/_data/docs-menu.yml @@ -1,4 +1,4 @@ -- label: Getting Started +- label: Getting started items: - name: Overview link: / @@ -11,44 +11,44 @@ link: /usage-docker/ - name: Google Cloud Run link: /usage-google-cloud/ - - name: API Configuration + - name: API configuration link: /usage-configuration/ - - name: Go Library + - name: Go library link: /usage-go/ - - name: Command Line + - name: Command line link: /usage-command-line/ -- label: ACH File Setup +- label: ACH file setup items: - - name: Create File + - name: Create file link: /create-file/ - - name: File Structure + - name: File structure link: /file-structure/ - - name: SEC Codes Table + - name: SEC codes table link: /sec-codes-table/ -- label: File Operations +- label: File operations items: - - name: Custom Validation + - name: Custom validation link: /custom-validation/ - - name: Balanced Offset + - name: Balanced offset link: /balanced-offset/ - - name: Flatten Batches + - name: Flatten batches link: /flatten-batches/ - - name: Merging Files + - name: Merging files link: /merging-files/ - - name: Segmenting Files + - name: Segmenting files link: /segment-file/ - - name: Return Files + - name: Return files link: /returns/ - - name: Change Files + - name: Change files link: /changes/ -- label: Production and Monitoring +- label: Production and monitoring items: - name: Kubernetes link: /deployment/ - - name: Prometheus Metrics + - name: Prometheus metrics link: /metrics/ - name: Building for AWS Lambda link: /aws/lambda/building-go-for-lambda/ diff --git a/docs/balanced-offset.md b/docs/balanced-offset.md index ad7b91740..af7f6d7d8 100644 --- a/docs/balanced-offset.md +++ b/docs/balanced-offset.md @@ -1,12 +1,12 @@ --- layout: page -title: Balanced Offset +title: Balanced offset hide_hero: true show_sidebar: false menubar: docs-menu --- -# Balanced Offsets +# Balanced offsets ACH files can have "offset records" which are [EntryDetail](https://godoc.org/github.com/moov-io/ach#EntryDetail) records that balance a file's debits and credits. This means if there are debits, there is a credit offset matching the sum of the debits. If there are credits, there is a debit offset matching the sum of the credits. They are mutually exclusive. @@ -14,7 +14,7 @@ Offset files are used to offset transactions from a single account inside of the Note: Balanced offset files (via `WithOffset`) are only in ACH v1.1.0 and later. -## Setting Offset Metadata +## Setting offset metadata An ACH [Batch](https://godoc.org/github.com/moov-io/ach#Batch) supports calling [WithOffset](https://godoc.org/github.com/moov-io/ach#Batch.WithOffset) to set offset information such as routing number, account number, account type, and a description. diff --git a/docs/changes.md b/docs/changes.md index 221fea61e..6d8c25517 100644 --- a/docs/changes.md +++ b/docs/changes.md @@ -1,12 +1,12 @@ --- layout: page -title: Change Files +title: Change files hide_hero: true show_sidebar: false menubar: docs-menu --- -# Change Files +# Change files A Notification of Change (NOC) is a non-dollar entry transmitted from a receiving depository financial institution (RDFI) to the originating depository financial institution (ODFI). These are sent in response to outdated or erroneous information in an initial entry. An NOC often occurs due to bank mergers or acquisitions that change account and/or routing numbers. If an RDFI sends an NOC, the ODFI will need to inform their originator promptly. @@ -50,7 +50,7 @@ addenda98.TraceNumber = "91012980000088" //entry.Addenda98 = addenda98 ``` -### Change Codes +### Change codes | Code | Reason | Description | |----|-----|------| diff --git a/docs/create-file.md b/docs/create-file.md index e593a15ed..abb4ffa30 100644 --- a/docs/create-file.md +++ b/docs/create-file.md @@ -1,12 +1,12 @@ --- layout: page -title: ACH File Setup +title: ACH file setup hide_hero: true show_sidebar: false menubar: docs-menu --- -# Create a File +# Create a file Creating an Automated Clearing House (ACH) file can be done several ways: @@ -14,7 +14,7 @@ Creating an Automated Clearing House (ACH) file can be done several ways: - [Uploading a JSON representation](#upload-a-json-representation) - [Uploading a raw ACH file](#upload-a-json-representation) -## Go Client +## Go client We have an example of [using our Go client and uploading the JSON representation](https://github.com/moov-io/ach/blob/master/examples/http/main.go). The basic idea follows this structure: @@ -36,7 +36,7 @@ We have [example ACH files](https://github.com/moov-io/ach/blob/master/test/test Note: The header `Content-Type: application/json` must be set to parse the file as JSON, otherwise Nacha's format will be assumed. -### Validate Options +### Validate options When creating a file the server supports query parameters for setting `ValidateOpts` values. diff --git a/docs/custom-validation.md b/docs/custom-validation.md index fc6fa9e03..faaab9ce7 100644 --- a/docs/custom-validation.md +++ b/docs/custom-validation.md @@ -1,18 +1,18 @@ --- layout: page -title: Custom Validation +title: Custom validation hide_hero: true show_sidebar: false menubar: docs-menu --- -# Custom Validation +# Custom validation ACH files can vary sometimes from the official NACHA guidelines due to vendor changes. Moov ACH defaults to NACHA guidelines, so to handle this there's an exported `ValidateWith(opts)` method on some structures (`File`, `FileHeader`, etc). The [`ValidateOpts`](https://godoc.org/github.com/moov-io/ach#ValidateOpts) struct can have fields added in minor releases without breaking API compatibility with callers. The default values in this struct match with NACHA's guidelines. -## Validation Options +## Validation options The following options can be used with `File.ValidateWith` and `File.SetValidation` to alter the default NACHA validation rules. @@ -59,11 +59,11 @@ if err != nil { } ``` -## HTTP Server +## HTTP server The ACH HTTP server can accept `ValidateOpts` when [Validating a file](https://moov-io.github.io/ach/api/#get-/files/{fileID}/validate). This will leverage the above one-off validation methods and return any errors. -**Create a File** +**Create a file** ``` curl -X POST --data-binary @test/testdata/ppd-debit.ach http://localhost:8080/files/create ``` @@ -71,7 +71,7 @@ curl -X POST --data-binary @test/testdata/ppd-debit.ach http://localhost:8080/fi {"id":"b1910446fd904abc8b2cee358ffb3673c2cb8a62","error":null} ``` -**Apply Custom Validation Rules** +**Apply custom validation rules** ``` curl -X POST --data-binary '{"requireABAOrigin": true}' http://localhost:8080/files/b1910446fd904abc8b2cee358ffb3673c2cb8a62/validate diff --git a/docs/file-structure.md b/docs/file-structure.md index 3f20a77bf..ba93063ae 100644 --- a/docs/file-structure.md +++ b/docs/file-structure.md @@ -1,12 +1,12 @@ --- layout: page -title: File Structure +title: File structure hide_hero: true show_sidebar: false menubar: docs-menu --- -## Sequence of Records and Description +## Sequence of records and description Each NACHA formatted file you originate consists of the following records: @@ -20,7 +20,7 @@ Each NACHA formatted file you originate consists of the following records: Each file begins with a File Header record. Following the File Header Record may be any number of batches. Each batch is identified by a Batch Header Record and contains one or more Entry Detail Records. At the end of each batch is a Batch Control Record. Each file is ended with a File Control Record. This [diagram](https://raw.githubusercontent.com/moov-io/ach/master/docs/ach_file_structure_shg.gif) illustrates the Sequence of Records for ACH entries. The sequence of records will always be the same, regardless of SEC code. Out-of-sequence records or lack of a mandatory record will cause all or portions of the file to reject. Padding with “9” records at the end of the file is optional. -## Input File Descriptions +## Input file descriptions ### File Header diff --git a/docs/flatten-batches.md b/docs/flatten-batches.md index b0a6186d5..95af64562 100644 --- a/docs/flatten-batches.md +++ b/docs/flatten-batches.md @@ -1,12 +1,12 @@ --- layout: page -title: Flatten Batches +title: Flatten batches hide_hero: true show_sidebar: false menubar: docs-menu --- -# Flatten Batches +# Flatten batches File creation honors the order and number of Batch's that are created by the client. This is not optimized for the smallest file size and cost, that could be sent to the Federal Reserve for processing. @@ -14,7 +14,7 @@ Flattening batches is a post file creation process that takes an input of an ACH Note: FlattenBatches (via `FlattenBatches()`) is only in ACH v1.2.0 and later. -## Creating Flattened Batches +## Creating flattened batches An ACH [File](https://godoc.org/github.com/moov-io/ach#File) supports calling [FlattenBatches](https://godoc.org/github.com/moov-io/ach#File.FlattenBatches): diff --git a/docs/intro.md b/docs/intro.md index dafc6e1c6..22192e293 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -26,7 +26,7 @@ NACHA includes Members in the process of establishing Rules for the ACH Network, [Source: ACH Network: How it Works](https://www.nacha.org/ach-network) -## Developer Overview +## Developer overview Nacha has published an [ACH Guide for Developers](https://dev-ach-guide.pantheonsite.io/) that covers the basics of ACH payment flow, entry types, and file structure. diff --git a/docs/merging-files.md b/docs/merging-files.md index b0dec6c1e..c35203dd9 100644 --- a/docs/merging-files.md +++ b/docs/merging-files.md @@ -1,12 +1,12 @@ --- layout: page -title: Merging Files +title: Merging files hide_hero: true show_sidebar: false menubar: docs-menu --- -# Merging Files +# Merging files Moov ACH supports merging an arbitrary set of ACH files together. This is useful for optimizing cost and network efficiency. NACHA files are limited to 10,000 lines (in their text format) and so Moov ACH merges valid files together where the FileHeaders match the same ABA routing numbers. diff --git a/docs/metrics.md b/docs/metrics.md index bdf22e387..16464dc23 100644 --- a/docs/metrics.md +++ b/docs/metrics.md @@ -1,6 +1,6 @@ --- layout: page -title: Prometheus Metrics +title: Prometheus metrics hide_hero: true show_sidebar: false menubar: docs-menu diff --git a/docs/returns.md b/docs/returns.md index 84e609cd0..081207136 100644 --- a/docs/returns.md +++ b/docs/returns.md @@ -1,12 +1,12 @@ --- layout: page -title: Return Files +title: Return files hide_hero: true show_sidebar: false menubar: docs-menu --- -# Return Files +# Return files ACH files and their EntryDetail records may be returned for a variety of reasons defined by "return codes". Either the originating (ODFI) or receiving (RDFI) financial institution can issue a return. Some of the most common reasons include: insufficient funds (`R01`) and account information not found (`R03`). @@ -90,7 +90,7 @@ addenda99.OriginalDFI = "9101298" | `R46` | Invalid Representative Payee Indicator (ENR Only) | The Representative Payee Indicator Code included in Field 3 of the Addenda Record has been omitted or it is not consistent with the Federal Government Agency's records. | | `R47` | Duplicate Enrollment (ENR Only) | The Entry is a duplicate of an Automated Enrollment Entry previously initiated by a DFI. | -#### Used for RCK entries only and are initiated by a RDFI +#### Used for RCK entries only and are initiated by an RDFI | Code | Reason | Description | |----|-----|------| diff --git a/docs/sec-codes-table.md b/docs/sec-codes-table.md index 33e32b277..75f15b9e2 100644 --- a/docs/sec-codes-table.md +++ b/docs/sec-codes-table.md @@ -6,34 +6,34 @@ show_sidebar: false menubar: docs-menu --- -## Picking which Standard Entry Class Code code to use +## Picking which Standard Entry Class code to use The [NACHA Corporate Rules and Guidelines](https://github.com/moov-io/ach/blob/master/docs/2013-Corporate-Rules-and-Guidelines.pdf) offer a helpful table for choosing the correct Standard Entry Class (SEC) Code to use for a given enrollment and transaction. The table has been re-written below: -### Point of Sale Transactions +### Point of sale transactions -#### Physical Enrollment +#### Physical enrollment - Customer uses their debit card at a POS terminal.

Proper SEC Code: POS

-#### Internet Enrollment +#### Internet enrollment - Customer uses their debit card at a POS terminal.

Proper SEC Code: POS

-### Internet Transactions +### Internet transactions -#### Physical Enrollment +#### Physical enrollment - Customer initiates debits via the bank’s web site or individual bill payments at a merchant web site. - Customer uses their ACH-based debit card to make a purchase at a web site.

Proper SEC Code: PPD

-#### Internet Enrollment +#### Internet enrollment - Customer authorizes a transfer of funds into a savings account. - Customer initiates bill payments at a merchant web site on their debit card. @@ -41,15 +41,15 @@ The [NACHA Corporate Rules and Guidelines](https://github.com/moov-io/ach/blob/m

Proper SEC Code: WEB

-### ATM Transactions +### ATM transactions -#### Physical Enrollment +#### Physical enrollment - Customer uses the card at an ATM to withdraw cash.

Proper SEC Code: MTE

-#### Internet Enrollment +#### Internet enrollment - Customer uses an ATM to withdraw cash: diff --git a/docs/segment-file.md b/docs/segment-file.md index 0d74a3db2..437d1476d 100644 --- a/docs/segment-file.md +++ b/docs/segment-file.md @@ -1,12 +1,12 @@ --- layout: page -title: Segmenting Files +title: Segmenting files hide_hero: true show_sidebar: false menubar: docs-menu --- -# Segmenting Files +# Segmenting files ACH File creation should default to NACHA rules by supporting both credits and debits in the same ACH file. Some legacy systems require the file to be segmented and contain only debits or only credits in a file. @@ -14,7 +14,7 @@ Segmenting files is a post file creation process that takes an input of an ACH.F Note: Segmented files (via `SegmentFile()`) are only in ACH v1.1.0 and later. -## Creating Segmented Files +## Creating segmented files An ACH [File](https://godoc.org/github.com/moov-io/ach#File) supports calling [SegmentFile](https://godoc.org/github.com/moov-io/ach#File.SegmentFile) to create a debit ach file and credit ach file from an ach file that contains mixed debits and credits. diff --git a/docs/usage-command-line.md b/docs/usage-command-line.md index 57d842d26..365fca8d3 100644 --- a/docs/usage-command-line.md +++ b/docs/usage-command-line.md @@ -1,12 +1,12 @@ --- layout: page -title: Command Line +title: Command line hide_hero: true show_sidebar: false menubar: docs-menu --- -# Command Line +# Command line On each release there's an `achcli` utility released. This tool can display ACH files in a human-readable format which is easier to read than their plaintext format. It also allows masking `DFIAccountNumber` values with the `-mask` flag. diff --git a/docs/usage-configuration.md b/docs/usage-configuration.md index a531642d3..078617380 100644 --- a/docs/usage-configuration.md +++ b/docs/usage-configuration.md @@ -1,12 +1,12 @@ --- layout: page -title: API Configuration +title: API configuration hide_hero: true show_sidebar: false menubar: docs-menu --- -# Configuration Settings +# Configuration settings | Environmental Variable | Description | Default | |-----|-----|-----| @@ -17,5 +17,5 @@ menubar: docs-menu | `HTTPS_CERT_FILE` | Filepath containing a certificate (or intermediate chain) to be served by the HTTP server. Requires all traffic be over secure HTTP. | Empty | | `HTTPS_KEY_FILE` | Filepath of a private key matching the leaf certificate from `HTTPS_CERT_FILE`. | Empty | -## Data Persistence +## Data persistence By design ACH **does not persist** (save) any data about the files, batches, or entry details created. The only storage occurs in memory of the process and upon restart ACH will have no files, batches, or data saved. Also, no in memory encryption of the data is performed. \ No newline at end of file diff --git a/docs/usage-go.md b/docs/usage-go.md index becc88f97..0153ff1a2 100644 --- a/docs/usage-go.md +++ b/docs/usage-go.md @@ -1,12 +1,12 @@ --- layout: page -title: Go Library +title: Go library hide_hero: true show_sidebar: false menubar: docs-menu --- -# Go Library +# Go library This project uses [Go Modules](https://github.com/golang/go/wiki/Modules) and Go v1.14 or higher. See [Golang's install instructions](https://golang.org/doc/install) for help in setting up Go. You can download the source code and we offer [tagged and released versions](https://github.com/moov-io/ach/releases/latest) as well. We highly recommend you use a tagged release for production. @@ -21,7 +21,7 @@ $ go doc github.com/moov-io/ach BatchHeader The package [`github.com/moov-io/ach`](https://pkg.go.dev/github.com/moov-io/ach) offers a Go-based ACH file reader and writer. To get started, check out a specific example: -### Supported Standard Entry Class (SEC) Codes +### Supported Standard Entry Class (SEC) codes | SEC Code | Description | Example | Read | Write | |----------|---------------------------------------|------------------------------------------|-----------------------------------|------------------------------------| @@ -49,7 +49,7 @@ The package [`github.com/moov-io/ach`](https://pkg.go.dev/github.com/moov-io/ach | WEB | Internet-initiated Entries | [Credit](https://github.com/moov-io/ach/blob/master/test/ach-web-read/web-credit.ach) | [WEB Read](https://pkg.go.dev/github.com/moov-io/ach/examples#example-package-WebReadCredit) | [WEB Write](https://pkg.go.dev/github.com/moov-io/ach/examples#example-package-WebWriteCredit) | | XCK | Destroyed Check Entry | [Debit](https://github.com/moov-io/ach/blob/master/test/ach-xck-read/xck-debit.ach) | [XCK Read](https://pkg.go.dev/github.com/moov-io/ach/examples#example-package-XckReadDebit) | [XCK Write](https://pkg.go.dev/github.com/moov-io/ach/examples#example-package-XckWriteDebit) | -### Segment Files +### Segment files | SEC Code | Name | Example | Read | Write | |----------|---------------------------------------|------------------------------------------|-----------------------------------|------------------------------------|