♻️ Simple & Efficient Gemini-to-HTTP Proxy
fuwn.net
proxy
gemini-protocol
protocol
gemini
http
rust
docs(Configuration.md): Grammatical clean-up
+11
-11
+11
-11
Configuration.md
+11
-11
Configuration.md
···
1
1
# Configuration
2
2
3
-
Configuration for September is done entirely through environment variables.
3
+
The configuration for September is managed entirely through environment variables.
4
4
5
5
## `PORT`
6
6
7
-
Bind September to a custom port
7
+
Bind September to a custom port.
8
8
9
9
Generally, you shouldn't touch this option if you are deploying using Docker.
10
10
11
-
If no `PORT` is provided or the `PORT` could not be properly parsed as an
11
+
If no `PORT` is provided or the `PORT` could not be parsed appropriately as an
12
12
unsigned 16-bit integer, `PORT` will default to `80`.
13
13
14
14
```dotenv
···
39
39
40
40
## `KEEP_GEMINI`
41
41
42
-
A comma-separated list of Gemini URL fragments to keep as is when proxying
42
+
A comma-separated list of Gemini URL fragments to keep as is when proxying.
43
43
44
44
Wildcards are supported using the `*` character, and exceptions can be made
45
45
using the `!` character
···
52
52
53
53
## `HEAD`
54
54
55
-
Insert any string at the end of the HTMl `<head>`
55
+
Insert any string at the end of the HTML `<head>`
56
56
57
57
```dotenv
58
58
HEAD=<script>/* September */</script><style>/* September */</style>
···
60
60
61
61
## `PROXY_BY_DEFAULT`
62
62
63
-
Control whether or not all Gemini URLs will be proxied
63
+
Control whether all Gemini URLs are proxied.
64
64
65
65
Similar to `KEEP_GEMINI_EXACT` and `KEEP_GEMINI_DOMAIN`, but global
66
66
···
91
91
92
92
## `MATHJAX`
93
93
94
-
Enable MathJax support for rendering LaTeX within `$` and `$$` delimiters
94
+
Enable MathJax support for rendering LaTeX within `$` and `$$` delimiters.
95
95
96
96
This configuration value defaults to `false`.
97
97
···
111
111
112
112
## `EMBED_IMAGES`
113
113
114
-
Embed images in the HTML response if a link to an image is found
114
+
Embed images in the HTML response if a link to an image is found.
115
115
116
-
A value of `1` will enable this feature, while keeping link to the image.
116
+
A value of `1` will enable this feature, while keeping a link to the image.
117
117
118
118
Any non-empty value other than `1` will enable this feature, while removing the link to the image.
119
119
···
161
161
## `CONDENSE_LINKS_AT_HEADING`
162
162
163
163
This configuration option is similar to `CONDENSE_LINKS`, but only condenses
164
-
links found under certain headings.
164
+
links found under specific headings.
165
165
166
166
For instance, I condense the few links I have on my index page under the
167
167
"# Fuwn[.me]" heading, and I condense my quick links/navigation panel under the
168
168
"## Quick Links" heading.
169
169
170
-
This way, I don't accidentally condense say my entire sitemap, which could be
170
+
This way, I don't accidentally condense my entire sitemap, which could be
171
171
hundreds of links long, but I do condense my quick links on every page.
172
172
173
173
```dotenv