# README
CFUTIL
This package provides a number of convenience functions for apps running in Cloudfoundry In case the app is started outside of Cloudfoundry an attempt is made to simulate the Cloudfoundry environment
Simulating Cloudfoundry Services
When running locally the app looks for the following environment variables
- CF_LOCAL_POSTGRES
- CF_LOCAL_SMTP
- CF_LOCAL_RABBITMQ
Services are setup using the variable values as the URI. This allows you to use local Postgres, SMTP and RabbitMQ services just as you would in an actual Cloudfoundry deployment
License
MIT
# Functions
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ForceHTTP() returns true if the environment variable `FORCE_HTTP` contains `true`.
GetAppIndex() returns the app index when running in Cloudfoundry.
GetApplicationName() returns the name of the app within Cloudfoundry.
Getenv(name) returns the environment variable value of ENV `name`.
GetHostname() returns the (first) hostname designated to your app within Cloudfoundry.
IsFirstInstance() returns true if the instance calling it is the first running instance of the app within Cloudfoundry.
No description provided by the author
ListenString() returns the listen string based on the `PORT` environment variable value.
No description provided by the author
Migrate() starts a database migration for the given database specified in `connectString`.
NewConnection opens a new database connection given the driver and CF service name.
NewConsulClient() returns a new consul client which you can use to access the Consul cluster HTTP API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Constants
TODO: get rid of this magic.
# Structs
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Interfaces
No description provided by the author
# Type aliases
No description provided by the author