Repository navigation
Expand file tree
/
Copy path.env.example
More file actions
86 lines (74 loc) · 2.99 KB
/
Copy path.env.example
File metadata and controls
86 lines (74 loc) · 2.99 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# Deployment environment example for Docker Compose and single-instance Node
# deployments.
#
# Copy this file to `.env`, then uncomment only the variables you need.
# Replace the `AUTH_SECRET` placeholder with a real 32+ character secret
# (e.g. `openssl rand -base64 32`) before you start Jant.
#
# This is the public Docker/Node template used by the deployment docs.
# Repo automation such as demo rebuild/publish uses `.env.repo.example`
# instead of this file.
# Required authentication secret. Must be at least 32 characters.
# Generate one with: openssl rand -base64 32
AUTH_SECRET=replace-me-replace-me-replace-me-replace-me-replace-me
# Docker Compose only: override the published image tag or host port.
# IMAGE=owenyoung/jant:latest
# HOST_PORT=3000
# Public site URL for canonical URLs, RSS, sitemaps, and auth callbacks.
# Leave `SITE_ORIGIN` unset to use the current request origin.
# `SITE_PATH_PREFIX` is only needed when Jant is mounted under a subpath.
# SITE_ORIGIN=https://your-jant.example
# SITE_PATH_PREFIX=/blog
# Node/Docker listener settings.
# The official Docker image already defaults to `HOST=0.0.0.0` and `PORT=3000`.
# `TRUST_PROXY=true` is recommended when the container sits behind Caddy,
# Nginx, Traefik, or another reverse proxy you control.
# HOST=0.0.0.0
# PORT=3000
# TRUST_PROXY=true
# Node runtime database and local media paths.
# The official Docker image already defaults `DATA_DIR` to `/var/lib/jant`.
# If you leave `DATABASE_URL` unset, Jant derives SQLite from `DATA_DIR`.
# DATA_DIR=/var/lib/jant
# DATABASE_URL=file:/var/lib/jant/jant.sqlite
# LOCAL_STORAGE_PATH=/var/lib/jant/media
# LOCAL_PUBLIC_URL=https://media.your-jant.example
# Use Postgres instead of SQLite.
# DATABASE_URL=postgres://USER:PASSWORD@HOST:5432/DBNAME
# Storage driver selection for Node/Docker.
# `local` is the default on Node/Docker.
# STORAGE_DRIVER=local
# S3-compatible storage for uploads and media.
# Set `STORAGE_DRIVER=s3` and then configure the options below.
# STORAGE_DRIVER=s3
# S3_ENDPOINT=https://s3.us-east-1.amazonaws.com
# S3_BUCKET=my-bucket
# S3_REGION=us-east-1
# S3_PUBLIC_URL=https://cdn.example.com
# S3_ACCESS_KEY_ID=your-access-key
# S3_SECRET_ACCESS_KEY=your-secret-key
# Optional image transformation base URL.
# Set this to the domain that serves your images, plus `/cdn-cgi/image`.
# IMAGE_TRANSFORM_URL=https://media.your-jant.example/cdn-cgi/image
# Optional site defaults. These can also be changed later in Settings.
# DEFAULT_THEME=linen
# SITE_NAME=Jant
# SITE_DESCRIPTION=
# SITE_LANGUAGE=en
# HOME_DEFAULT_VIEW=latest
# MAIN_RSS_FEED=featured
# TIME_ZONE=UTC
# SITE_FOOTER=Published with Jant
# SHOW_JANT_BRANDING_ON_HOME=false
# NOINDEX=false
# Optional pagination and feed limits.
# `SEARCH_PAGE_SIZE` and `ARCHIVE_PAGE_SIZE` fall back to `PAGE_SIZE` when unset.
# PAGE_SIZE=50
# SEARCH_PAGE_SIZE=50
# ARCHIVE_PAGE_SIZE=50
# RSS_FEED_LIMIT=50
# Optional upload, summary, and slug tuning.
# UPLOAD_MAX_FILE_SIZE_MB=500
# SUMMARY_MAX_PARAGRAPHS=5
# SUMMARY_MAX_CHARS=500
# SLUG_ID_LENGTH=5