strava

README

commute

Getting started

Golang binary is built with static link. You can download it directly from the GitHub Release page or build it by yourself by cloning this repo and running make.

A Docker image is available for amd64, arm and arm64 platforms on Docker Hub: vibioh/commute.

You can configure app by passing CLI args or environment variables (cf. Usage section). CLI override environment variables.

You'll find a Kubernetes exemple in the infra/ folder, using my app chart

Usage

The application can be configured by passing CLI args described below or their equivalent as environment variable. CLI values take precedence over environments variables.

Be careful when using the CLI values, if someone list the processes on the system, they will appear in plain-text. Pass secrets by environment variables: it's less easily visible.

Usage of commute:
  --address             string    [server] Listen address ${COMMUTE_ADDRESS}
  --cert                string    [server] Certificate file ${COMMUTE_CERT}
  --corsCredentials               [cors] Access-Control-Allow-Credentials ${COMMUTE_CORS_CREDENTIALS} (default false)
  --corsExpose          string    [cors] Access-Control-Expose-Headers ${COMMUTE_CORS_EXPOSE}
  --corsHeaders         string    [cors] Access-Control-Allow-Headers ${COMMUTE_CORS_HEADERS} (default "Content-Type")
  --corsMethods         string    [cors] Access-Control-Allow-Methods ${COMMUTE_CORS_METHODS} (default "GET")
  --corsOrigin          string    [cors] Access-Control-Allow-Origin ${COMMUTE_CORS_ORIGIN} (default "*")
  --csp                 string    [owasp] Content-Security-Policy ${COMMUTE_CSP} (default "default-src 'self'; base-uri 'self'; script-src 'self'; style-src 'self' 'httputils-nonce'; img-src 'self' api.mapbox.com/styles/v1/mapbox/dark-v11/")
  --frameOptions        string    [owasp] X-Frame-Options ${COMMUTE_FRAME_OPTIONS} (default "deny")
  --graceDuration       duration  [http] Grace duration when signal received ${COMMUTE_GRACE_DURATION} (default 30s)
  --hsts                          [owasp] Indicate Strict Transport Security ${COMMUTE_HSTS} (default true)
  --idleTimeout         duration  [server] Idle Timeout ${COMMUTE_IDLE_TIMEOUT} (default 2m0s)
  --key                 string    [server] Key file ${COMMUTE_KEY}
  --loggerJson                    [logger] Log format as JSON ${COMMUTE_LOGGER_JSON} (default false)
  --loggerLevel         string    [logger] Logger level ${COMMUTE_LOGGER_LEVEL} (default "INFO")
  --loggerLevelKey      string    [logger] Key for level in JSON ${COMMUTE_LOGGER_LEVEL_KEY} (default "level")
  --loggerMessageKey    string    [logger] Key for message in JSON ${COMMUTE_LOGGER_MESSAGE_KEY} (default "msg")
  --loggerTimeKey       string    [logger] Key for timestamp in JSON ${COMMUTE_LOGGER_TIME_KEY} (default "time")
  --mapboxAccessToken   string    [mapbox] Mapbox Access Token ${COMMUTE_MAPBOX_ACCESS_TOKEN}
  --name                string    [server] Name ${COMMUTE_NAME} (default "http")
  --okStatus            int       [http] Healthy HTTP Status code ${COMMUTE_OK_STATUS} (default 204)
  --port                uint      [server] Listen port (0 to disable) ${COMMUTE_PORT} (default 1080)
  --publicURL           string    Public URL for redirection ${COMMUTE_PUBLIC_URL} (default "http://localhost:1080")
  --readTimeout         duration  [server] Read Timeout ${COMMUTE_READ_TIMEOUT} (default 5s)
  --shutdownTimeout     duration  [server] Shutdown Timeout ${COMMUTE_SHUTDOWN_TIMEOUT} (default 10s)
  --stravaClientID      string    [strava] App Client ID ${COMMUTE_STRAVA_CLIENT_ID}
  --stravaClientSecret  string    [strava] App Client Secret ${COMMUTE_STRAVA_CLIENT_SECRET}
  --telemetryRate       string    [telemetry] OpenTelemetry sample rate, 'always', 'never' or a float value ${COMMUTE_TELEMETRY_RATE} (default "always")
  --telemetryURL        string    [telemetry] OpenTelemetry gRPC endpoint (e.g. otel-exporter:4317) ${COMMUTE_TELEMETRY_URL}
  --telemetryUint64               [telemetry] Change OpenTelemetry Trace ID format to an unsigned int 64 ${COMMUTE_TELEMETRY_UINT64} (default true)
  --url                 string    [alcotest] URL to check ${COMMUTE_URL}
  --userAgent           string    [alcotest] User-Agent for check ${COMMUTE_USER_AGENT} (default "Alcotest")
  --writeTimeout        duration  [server] Write Timeout ${COMMUTE_WRITE_TIMEOUT} (default 10s)