Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/steenzout/go-env
Library to retrieve configuration from the environment based on convention.
https://github.com/steenzout/go-env
configuration environment golang package
Last synced: 20 days ago
JSON representation
Library to retrieve configuration from the environment based on convention.
- Host: GitHub
- URL: https://github.com/steenzout/go-env
- Owner: steenzout
- License: apache-2.0
- Created: 2017-04-11T22:11:56.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-11-01T00:20:50.000Z (over 6 years ago)
- Last Synced: 2024-11-16T03:59:57.417Z (3 months ago)
- Topics: configuration, environment, golang, package
- Language: Go
- Size: 89.8 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-env
[][license]
[](https://travis-ci.org/steenzout/go-env/)
[](https://coveralls.io/github/steenzout/go-env?branch=master)
[](https://goreportcard.com/report/github.com/steenzout/go-env)
[][project]
Library that uses convention to read configuration parameters from the environment.
## environment variables
### app:InfluxDB
- **INFLUXDB_DB**: name of the InfluxDB database.
- **INFLUXDB_HOST**: host.
- **INFLUXDB_PORT**: HTTP API port.
- **INFLUXDB_ADMIN_PORT**: administrator interface port.
- **INFLUXDB_GRAPHITE_PORT**: Graphite support port.
- **INFLUXDB_ADMIN_USER**: administrator account.
- **INFLUXDB_ADMIN_PASSWORD**: administrator password.
- **INFLUXDB_USER**: read/write database account.
- **INFLUXDB_USER_PASSWORD**: password.
- **INFLUXDB_READ_USER**: database reader account.
- **INFLUXDB_READ_USER_PASSWORD**: reader password.
- **INFLUXDB_WRITE_USER**: database writer account.
- **INFLUXDB_WRITE_USER_PASSWORD**: writer password.
### app:MySQL
- **MYSQL_DATABASE**: name of the MySQL database.
- **MYSQL_HOST**: host or path to Unix domain socket (default: `/var/run/mysqld/mysqld.sock`)
- **MYSQL_PASSWORD**: password (default: `''`)
- **MYSQL_PORT**: port (default: `3306`).
- **MYSQL_PROTOCOL**: protocol to establish connection (default: `unix`)
- **MYSQL_ROOT_PASSWORD**: root password (default: `''`)
- **MYSQL_USER**: user name.
- [github.com/go-sql-driver/mysql](https://github.com/go-sql-driver/mysql)
- [hub.docker.com/_/mysql](https://hub.docker.com/_/mysql/)
### app:PostgreSQL
- **POSTGRES_DB**: name of the database.
- **POSTGRES_HOST**: host.
- **POSTGRES_PASSWORD**: password.
- **POSTGRES_PORT**: port (default: `5432`).
- **POSTGRES_USER**: user name.
### app:Redis
- **REDIS_DB**: name of the database.
- **REDIS_PASSWORD**: password.
- **REDIS_PORT**: port (default: `6379`).
- **REDIS_HOST**: host.
### app:Resque
- **RESQUE_COUNT**: number of Resque workers to be spawned (default: `1`).
- **RESQUE_INTERVAL**: polling frequency, in seconds (default: `5s`).
- **RESQUE_PIDFILE**: PID file location..
- **RESQUE_QUEUE**: name of a single Resque queue.
- **RESQUE_QUEUES**: list of Resque queue names (default: `*`).
### cloud:AWS
- **AWS_ACCESS_KEY_ID**: AWS access key ID.
- **AWS_BUCKET**: name of the bucket.
- **AWS_CA_BUNDLE**: path to the certificate bundle.
- **AWS_CONFIG_FILE**: path to the file where configuration profiles are stored.
- **AWS_PATH**: path in the bucket.
- **AWS_DEFAULT_REGION**: AWS region.
- **AWS_DEFAULT_OUTPUT**: output format (default: `json`).
- **AWS_PROFILE**: name of the profile (default: `default`).
- **AWS_SECRET_ACCESS_KEY**: the AWS access key secret.
- **AWS_SESSION_TOKEN**: temporary session token (default: ``).
- **AWS_SHARED_CREDENTIALS_FILE**: path to the file where access keys are stored.
- [AWS Documentation » AWS Command Line Interface » User Guide » Configuring the AWS CLI » Environment Variables](http://docs.aws.amazon.com/cli/latest/userguide/cli-environment.html)
[license]: https://raw.githubusercontent.com/steenzout/go-env/master/LICENSE "Apache License 2.0"
[project]: https://www.openhub.net/p/go-steenzout-env/ "OpenHub project page"