sample.env

# Save a copy of this file as .env in this directory, and then update that.
# DO NOT MODIFY sample.env IN PLACE, as it will be ignored.

# This file will be used for deploying to a remote server, and configuring the instance there.
# See also sample.env in the root directory of the repository (for configuring local development).

# The Strava details can be accessed at https://www.strava.com/settings/api
# Note that these do not have to be the same between local development and the deployed server,
# as a different Strava account can be used for each.
STRAVA_CLIENT_ID=
STRAVA_CLIENT_SECRET=

# MAPBOX_TOKEN is the token for using Mapbox.
MAPBOX_TOKEN=

# MAPBOX_STYLE is the default style to use. This can be one of:
# - STANDARD
# - LIGHT
# - DARK
# - light-dark
# - OUTDOOR
# - STRAVA
# - HYBRID
# - SATELLITE
MAPBOX_STYLE=light-dark

# USE_STRAVA_ICONS: set to true to use Strava icons for activity types
USE_STRAVA_ICONS=false

# VALIDATE_USER_BEFORE_CACHE: set to true to check with the backend that the user exists before showing data
VALIDATE_USER_BEFORE_CACHE=false

# The name of the app, as used in the HTML title and logo
VITE_APP_NAME="Heatmapper"

# PORT is the port used for hosting the server. By default 8080
SERVER_PORT=8080

# SERVER_DOMAIN is the address for serving the client on. This is required unless the deployed
# instance is only going to be accessed from a browser on the same computer.
#
# If a domain is provided, it should contain everything before the first slash of the path,
# including the port (unless it is accessible through the default port, i.e. 80 for http or
# 443 for https), e.g. one of:
#   SERVER_DOMAIN=https://heatmapper.charding.dev
#   SERVER_DOMAIN=http://192.168.1.2:345
#
# If a SERVER_DOMAIN is provided, it must match the callback domain specified at
# https://www.strava.com/settings/api
SERVER_DOMAIN=

# The following items are used for deploying to a remote server (`./deploy`).
# The host should be an IP address/domain name that accepts ssh connections, or the name of a host
# as specified in ~/.ssh/config .
# All the other parameters are optional. You must wrap any values containing dollars, spaces or
# other special character in single quotes, as these options will be interpreted by bash directly.
# If DEPLOY_KEYPAIR is a relative path, it should be given relative to the parent directory, the
# root of the repository.
DEPLOY_HOST=
DEPLOY_USER=
DEPLOY_KEYPAIR=
DEPLOY_DIR='heatmapper'