Configuration for September is done entirely through environment variables.
Bind September to a custom port
Generally, you shouldn't touch this option if you are deploying using Docker.
If no PORT
is provided or the PORT
could not be properly parsed as an
unsigned 16-bit integer, PORT
will default to 80
.
PORT=1337
Root Gemini capsule to proxy when not visiting a "/proxy" route
If no ROOT
is provided, ROOT
will default to "gemini://fuwn.me"
.
ROOT=gemini://fuwn.me
A comma-separated list of external CSS files to apply to the HTML response
If no CSS_EXTERNAL
value is provided, a default stylesheet of
LaTeX.css and the styles within
default.css
will be applied.
CSS_EXTERNAL=https://cdnjs.cloudflare.com/ajax/libs/mini.css/3.0.1/mini-default.min.css
A comma-separated list of Gemini URIs to keep as is when proxying.
# These two URIs will be kept pointing to their original Gemini URIs when
# proxied instead of being replaced with their proxied equivalents.
KEEP_GEMINI_EXACT=gemini://fuwn.me/something,gemini://fuwn.me/another
Insert any string at the end of the HTMl <head>
HEAD=<script>/* September */</script><style>/* September */</style>
Similar to KEEP_GEMINI_EXACT
, except matches based on entire domain or domains
instead of exact URIs
KEEP_GEMINI_DOMAIN=fuwn.me,example.com
Control whether or not all Gemini URLs will be proxied
Similar to KEEP_GEMINI_EXACT
and KEEP_GEMINI_DOMAIN
, but global
This configuration value defaults to true
.
PROXY_BY_DEFAULT=false
An external favicon file to apply to the HTML response
FAVICON_EXTERNAL=https://example.com/favicon.ico
A comma-separated list of paths to treat as plain text routes
These patterns do not support regular expressions, but do support the use of *
as a wildcard.
PLAIN_TEXT_ROUTE=/robots.txt,/license.txt,*.xml
Enable MathJax support for rendering LaTeX within $
and $$
delimiters
This configuration value defaults to false
.
MATHJAX=true
Adds a large text header to the top of a proxy page
Only available in styled routes
HEADER="This string will show up at the top of my proxied capsule."
Embed images in the HTML response if a link to an image is found
A value of 1
will enable this feature, while keeping link to the image.
Any non-empty value other than 1
will enable this feature, while removing the link to the image.
EMBED_IMAGES=2
Condense adjacent links to a single line
A value of *
will condense all adjacent links to a single line.
A comma-separated list of paths will condense adjacent links to a single line only on those paths.
<!-- Not condensed -->
<p><a href="/">Link</a></p>
<p><a href="/">Link</a></p>
<p><a href="/">Link</a></p>
<!-- Condensed -->
<p><a href="/">Link</a> | <a href="/">Link</a> | <a href="/">Link</a></p>
Set the primary colour of elements in the default stylesheet. This field controls the colour of items such as links and highlights.
Popular choices are var(--base0D)
for a blue, or var(--base09)
for an
amber colour.
PRIMARY_COLOUR=var(--base09)
PRIMARY_COLOUR=red
PRIMARY_COLOUR=#ff0000
This configuration option is similar to CONDENSE_LINKS
, but only condenses
links found under certain headings.
For instance, I condense the few links I have on my index page under the "# Fuwn[.me]" heading, and I condense my quick links/navigation panel under the "## Quick Links" heading.
This way, I don't accidentally condense say my entire sitemap, which could be hundreds of links long, but I do condense my quick links on every page.
CONDENSE_LINKS_AT_HEADINGS="## Quick Links,# Fuwn[.me]"