Automatic Swarm Nginx Loadbalancer
752
This container has its own environment variables, AS WELL AS scanning for some environment variables associated with your services. These should not be confused.
| Key | Default | Options | Behaviour |
|---|---|---|---|
| DOCKER_HOST | false | Define a http endpoint representing your docker socket. If this is null, it connects to /var/lib/docker.sock | |
| GLOBAL_CERT | false | Contents of an ssl certificate | If you want to provide a single cert for all endpoints, perhaps with a catch-all that may be later overriden, you can provide the whole contents of a certificates file here. |
| GLOBAL_CERT_KEY | false | Contents of an ssl certificates private key | The private key related to GLOBAL CERT. These must be provided in tandem. |
| BOUNCER_FORCED_UPDATE_INTERVAL_SECONDS | false | positive numbers | To force the bouncer to update on a schedule even if no changes are detected, measured in seconds |
| Key | Default | Options | Behaviour |
|---|---|---|---|
| BOUNCER_LETSENCRYPT_MODE | 'staging' | 'staging' or 'production' | Determine if this is going to connect to a production or staging Lets Encrypt server |
| BOUNCER_LETSENCRYPT_EMAIL | '[email protected]' | Email address to associate with lets encrypt |
| Key | Default | Options | Behaviour |
|---|---|---|---|
| BOUNCER_S3_BUCKET | false | enable S3 behaviour to store lets-encrypt generated certs | |
| BOUNCER_S3_ENDPOINT | false | define s3 endpoint to override default AWS s3 implementation, for example, with minio | |
| BOUNCER_S3_KEY_ID | false | S3 API Key ID | |
| BOUNCER_s3_KEY_SECRET | false | S3 API Key Secret | |
| BOUNCER_S3_REGION | false | S3 API Region | |
| BOUNCER_S3_USE_PATH_STYLE_ENDPOINT | false | true or false | Needed for minio |
| BOUNCER_S3_PREFIX | false | Prefix file path in s3 bucket |
These environment variables need to be applied to the CONSUMING SERVICE and not the loadbalancer container itself.
| Key | Example | Behaviour |
|---|---|---|
| BOUNCER_DOMAIN | "a.example.com" | The domain that should be directed to this container |
| BOUNCER_LETSENCRYPT | Values are "yes" or "true", anything else is false | To enable, or disable Lets Encrypt service for this hostname |
| BOUNCER_TARGET_PORT | 9000 | Explicitly define the port you want to hit the service on, in case of ambiguity |
| BOUNCER_ALLOW_NON_SSL | Defaults to enabled. Values are "yes" or "true", anything else is false | Should HTTP only traffic be allowed to hit this service? If disabled, http traffic is forwarded towards https |
| BOUNCER_ALLOW_WEBSOCKETS | Defaults to enabled. Values are "yes" or "true", anything else is false | Enable websocket behaviour |
| BOUNCER_ALLOW_LARGE_PAYLOADS | Defaults to disabled. | Allows overriding the default nginx payload size. Related to BOUNCER_MAX_PAYLOADS_MEGABYTES |
| BOUNCER_MAX_PAYLOADS_MEGABYTES | numbers | Size of max payload to allow, in megabytes. Requires BOUNCER_ALLOW_LARGE_PAYLOADS to be enabled |
If you're putting this behind access control to the docker socket, it will need access to the /swarm /services and /containers endpoints of the docker api.
Content type
Image
Digest
sha256:26d551979…
Size
151.3 MB
Last updated
over 2 years ago
docker pull benzine/bouncer