Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions env.sample
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# =============================================================================
# PAIKKA sample environment configuration
#
# Copy this file to `.env` in the repository root and fill in the values:
#
# cp env.sample .env
#
# Loading behaviour:
# - scripts/update.sh sources `.env` from its working directory
# (the repository root)
# - scripts/update-h3.sh sources `./scripts/.env` by default, or the
# file given via --env-file
#
# Values in .env override the script defaults; command-line flags passed to
# the scripts override values from .env. NEVER commit a filled-in .env
# (`.env` is gitignored).
#
# The boundary import itself (scripts/import-boundaries.sh, running inside
# the docker container) needs no credentials; it is configured through the
# pipeline scripts below.
# =============================================================================

# -----------------------------------------------------------------------------
# Import pipeline (scripts/update.sh)
# -----------------------------------------------------------------------------
# Where the planet PBF is downloaded to and intermediate files are kept
DOWNLOAD_DIR=""
# Where the import bundle is built
IMPORT_DATA_DIR=""
# Heap size (Xmx/Xms) for the paikka import java process
IMPORT_MEMORY="16G"
# Number of import threads
IMPORT_THREADS="10"
# Optional: use a local PBF file instead of downloading planet-latest.osm.pbf
# (same as the --pbf-file flag)
#PBF_INPUT_PATH=""

# --- Advanced overrides (rarely needed) ---
#PLANET_URL="https://planet.osm.org/pbf/planet-latest.osm.pbf"
#DOCKER_IMAGE="dedicatedcode/paikka:latest"

# -----------------------------------------------------------------------------
# Deployment target (scripts/update.sh)
# The server that receives the new import bundle via rsync.
# -----------------------------------------------------------------------------
REMOTE_USER=""
REMOTE_HOST=""
# Admin API token of the geocoder running on the remote host
GEOCODER_API_TOKEN=""

# -----------------------------------------------------------------------------
# Cloudflare cache invalidation (scripts/update.sh, optional)
# Enable via the --purge-cache flag or PURGE_CLOUDFLARE_CACHE=true
# -----------------------------------------------------------------------------
PURGE_CLOUDFLARE_CACHE="false"
# Token with "Zone.Cache Purge" permission
CLOUDFLARE_API_TOKEN=""
CLOUDFLARE_ZONE_ID=""
# Optional: comma-separated list of exact https:// URLs to purge instead of
# the entire zone cache (at most 30 URLs per request)
CLOUDFLARE_PURGE_PATTERN=""

# -----------------------------------------------------------------------------
# GitHub import statistics (scripts/update.sh, optional, see issue #63)
# Enable via the --post-stats flag or POST_IMPORT_STATS=true.
# Requires GitHub Discussions to be enabled on the target repository.
# -----------------------------------------------------------------------------
# Fine-grained GitHub token with "Discussions: Read & write" permission
# for the repository below
GITHUB_TOKEN=""
# Number of the discussion that receives one comment per successful import
# (taken from the discussion URL: github.com/OWNER/REPO/discussions/NUMBER)
GH_DISCUSSION_NUMBER=""
# Repository to post to (only needs changing when posting from a fork)
GH_STATS_REPO="dedicatedcode/paikka"

# -----------------------------------------------------------------------------
# Boundaries / H3 pipeline (scripts/update-h3.sh -> import-boundaries.sh,
# create-h3-bundle.sh, upload-h3-bundle.sh)
# -----------------------------------------------------------------------------
# Where the boundaries PBF is downloaded to and filtered
DOWNLOAD_DIR=""
# Where the boundary data and bundles are built
DATA_DIR=""
IMPORT_MEMORY="16g"
IMPORT_THREADS="10"
# Version tag for the created bundle
VERSION=""
# Base URL under which the bundle will be published
DOWNLOAD_BASE_URL="https://h3-osm.dedicatedcode.com"
# Local output directory for the bundle
BUNDLE_OUTPUT_DIR=""

# --- R2 upload credentials (scripts/update-h3.sh / scripts/upload-h3-bundle.sh) ---
R2_ACCOUNT_ID=""
R2_ACCESS_KEY_ID=""
R2_SECRET_ACCESS_KEY=""
R2_BUCKET=""
# Optional subfolder inside the bucket (leave empty for bucket root)
R2_PATH=""
Loading
Loading