Skip to content

CLI wrapper to only run commands on banking days

Notifications You must be signed in to change notification settings

moov-io/bankcron

Repository files navigation

Moov Banner Logo

Community · Blog

Build Status Go Report Card Repo Size Apache 2 License Slack Channel Docker Pulls GitHub Stars Twitter

moov-io/bankcron

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.

bankcron is a wrapper around typical bash/shell commands to only run them on banking days. This is useful for processes which should only run on days when federal banks are open.

Table of contents

Project status

bankcron is used in production at Moov. Please star the project if you are interested in its progress. If you have questions, issues or feature requests please open an issue or contact us.

Usage

bankcron is designed to be used in server environments such as Kubernetes or cronjobs.

Docker

We publish a public Docker image moov/bankcron from Docker Hub and OpenShift published as quay.io/moov/bankcron.

Pull & start the Docker image:

docker run moov/bankcron:latest -- curl -v -L https://moov.io

<!doctype html>
...

Command Line

You can download the latest release for your platform.

$ bankcron curl -v -L https://moov.io

<!doctype html>
...

Configuration settings

Environmental Variable Description Default
LOG_FORMAT Format for logging lines to be written as. Options: json, plain - Default: plain
TZ IANA timezone location for determining banking day. Example: America/New_York

Getting help

channel info
Twitter @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 If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error.
moov-io slack Join our slack channel (#infra) to have an interactive discussion about the development of the project.

Supported and tested platforms

  • 64-bit Linux (Ubuntu, Debian), macOS, and Windows
  • Raspberry Pi

Note: 32-bit platforms have known issues and are not supported.

Contributing

Yes please! Please review our Contributing guide and Code of Conduct to get started! Check out our issues for first time contributors for something to help out with.

This project uses Go Modules and Go v1.18 or newer. See Golang's install instructions for help setting up Go. You can download the source code and we offer tagged and released versions as well. We highly recommend you use a tagged release for production.

License

Apache License 2.0 - See LICENSE for details.