levineuwirth.org/.env.example

32 lines
1.4 KiB
Plaintext

# Copy this file to .env and fill in the values, then run:
# chmod 600 .env
# so other local users cannot read your VPS path / token. .env is
# gitignored — never commit it. The auto-snapshot in `make build`
# uses an explicit pathspec under content/ to keep stray .env files
# out of the snapshot, but **/.env is also in .gitignore as a backstop.
#
# `make deploy` pushes to GitHub first, then rsyncs the built _site/
# to the VPS. The Makefile aborts with a clear error if any of
# VPS_USER / VPS_HOST / VPS_PATH is unset, if VPS_PATH points at an
# obviously dangerous parent directory, or if _site/index.html does
# not exist (a sign of a broken build).
# --- VPS deployment target -------------------------------------------------
# SSH user on the deployment VPS.
VPS_USER=
# Hostname or IP of the deployment VPS.
VPS_HOST=
# Absolute path to the document root on the VPS (e.g. /var/www/levineuwirth.org).
VPS_PATH=
# --- GitHub mirror push ----------------------------------------------------
# A GitHub fine-grained personal access token with Contents: read+write
# on the levineuwirth.org repository. Currently optional — `make deploy`
# uses your local git credential helper for `git push`, so this is only
# needed if you wire token-based push into a credential helper yourself.
# Generate at: https://github.com/settings/personal-access-tokens/new
GITHUB_TOKEN=
# The GitHub repository in owner/repo format.
GITHUB_REPO=levineuwirth/levineuwirth.org