Documentation
¶
Index ¶
- func AthensMaxConcurrency() int
- func CDNEndpointWithDefault(value *url.URL) *url.URL
- func CloudRuntime() string
- func DiskRoot() (string, error)
- func EnableCSRFProtection() bool
- func GcpBucketName() (string, error)
- func GoBinPath() string
- func GoEnvironmentWithDefault(value string) string
- func GoPath() (string, error)
- func IncludeExcludeFileName() string
- func LogLevel() string
- func MinioAccessKeyID() (string, error)
- func MinioBucketNameWithDefault(value string) string
- func MinioEndpoint() (string, error)
- func MinioSSLWithDefault(value string) string
- func MinioSecretAccessKey() (string, error)
- func MongoConnectionTimeoutWithDefault(value string) string
- func MongoHost() (string, error)
- func MongoPassword() (string, error)
- func MongoPort() (string, error)
- func MongoSSLWithDefault(value string) string
- func MongoURI() (string, error)
- func MongoUser() (string, error)
- func OlympusGlobalEndpointWithDefault(value string) string
- func OlympusRedisQueuePortWithDefault(value string) string
- func Port(value string) string
- func RdbmsName() (string, error)
- func RedisQueuePortWithDefault(value string) string
- func StorageType() (string, error)
- func StorageTypeWithDefault(value string) string
- func Timeout() time.Duration
- func WorkerMaxFails() uint
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AthensMaxConcurrency ¶
func AthensMaxConcurrency() int
AthensMaxConcurrency retrieves maximal level of concurrency based on ATHENS_MAX_CONCURRENCY. Defaults to number of cores if env is not set.
func CDNEndpointWithDefault ¶
CDNEndpointWithDefault returns CDN endpoint if set if not it should default to clouds default blob storage endpoint e.g
func CloudRuntime ¶
func CloudRuntime() string
CloudRuntime returns the Cloud Provider underneath which the Proxy/Registry is running.
func EnableCSRFProtection ¶
func EnableCSRFProtection() bool
EnableCSRFProtection determines whether to enable CSRF protection
func GcpBucketName ¶
GcpBucketName returns Google Cloud Storage bucket name defined by ATHENS_STORAGE_GCP_BUCKET
func GoBinPath ¶
func GoBinPath() string
GoBinPath returns the path to the go binary to use, defined by GO_BINARY_PATH. This value can be a name on the PATH, or the full path
func GoEnvironmentWithDefault ¶
GoEnvironmentWithDefault returns environment used. Supported values are: 'development' and 'production'
func IncludeExcludeFileName ¶
func IncludeExcludeFileName() string
IncludeExcludeFileName specifies file name for include exclude filter If no filename is specified it fallbacks to 'filter.conf'
func LogLevel ¶
func LogLevel() string
LogLevel returns the system's exposure to internal logs. Defaults to debug.
func MinioAccessKeyID ¶
MinioAccessKeyID returns Minio access key ID defined by ATHENS_MINIO_ACCESS_KEY_ID.
func MinioBucketNameWithDefault ¶
MinioBucketNameWithDefault returns bucket name used with Minio. Defined by ATHENS_MINIO_BUCKET_NAME.
func MinioEndpoint ¶
MinioEndpoint returns Minio endpoing URI defined by ATHENS_MINIO_ENDPOINT.
func MinioSSLWithDefault ¶
MinioSSLWithDefault returns flag whether or not SSL should be used with Minio. Defined by ATHENS_MINIO_USE_SSL.
func MinioSecretAccessKey ¶
MinioSecretAccessKey returns Minio secret access key defined by ATHENS_MINIO_SECRET_ACCESS_KEY.
func MongoConnectionTimeoutWithDefault ¶
MongoConnectionTimeoutWithDefault returns Athens Mongo Storage connection timeout defined by MONGO_CONN_TIMEOUT_SEC. Values are in seconds.
func MongoPassword ¶
MongoPassword returns Athens Mongo Storage user password defined by MONGO_PASSWORD
func MongoSSLWithDefault ¶
MongoSSLWithDefault returns Athens Mongo Storage SSL flag defined by MONGO_SSL. Defines whether or not SSL should be used.
func OlympusGlobalEndpointWithDefault ¶
OlympusGlobalEndpointWithDefault returns Olympus global endpoint defined by OLYMPUS_GLOBAL_ENDPOINT.
func OlympusRedisQueuePortWithDefault ¶
OlympusRedisQueuePortWithDefault returns Redis queue port used by workers defined by ATHENS_REDIS_QUEUE_PORT. Standard port is 6379
func Port ¶
Port returns the PORT env var that a server (Olympus/Zeus) should run on. Buffalo uses the PORT environment so this keeps it consistent but can also be used directly as a Buffalo service option
func RedisQueuePortWithDefault ¶
RedisQueuePortWithDefault returns Redis queue port used by workers defined by ATHENS_REDIS_QUEUE_PORT. Standard port is 6379
func StorageType ¶
StorageType returns storage type used by Athens with error if env is not set. Possible values are memory, disk, mongo, postgres, sqlite, cockroach, mysql
func StorageTypeWithDefault ¶
StorageTypeWithDefault returns storage type used by Athens with default value if env is not set. Possible values are memory, disk, mongo, postgres, sqlite, cockroach, mysql
func WorkerMaxFails ¶
func WorkerMaxFails() uint
WorkerMaxFails retrieves maximal level of concurrency based on ATHENS_WORKER_MAX_FAILS. Defaults to 5.
Types ¶
This section is empty.
Source Files