♻️ Simple & Efficient Gemini-to-HTTP Proxy
fuwn.net
proxy
gemini-protocol
protocol
gemini
http
rust
1# September
2
3[](https://github.com/gemrest/september/actions/workflows/check.yaml)
4
5September is a simple and efficient Gemini-to-HTTP proxy written in [Rust](https://www.rust-lang.org/).
6
7September remains simple, but packs more features than you could imagine, all configurable via environment variables.
8
9## Usage
10
11A production deployment of September can be found at <https://fuwn.me>, with the root capsule set as [gemini://fuwn.me](gemini://fuwn.me).
12
13You can try proxying any external capsule through the `/proxy/` route: <https://fuwn.me/proxy/geminiprotocol.net/>.
14
15### Docker
16
17`docker run` allows you to pass environment variables via the `-e` flag.
18
19```shell
20# September with a custom root, listening on port 8080
21docker run -d \
22 -e ROOT="gemini://fuwn.me" \
23 -p 8080:80 \
24 fuwn/september:latest
25
26# September with a custom root, port, and external stylesheet, listening on port 80
27docker run -d \
28 -e ROOT="gemini://fuwn.me" \
29 -e PORT="8080" \
30 -e CSS_EXTERNAL="https://example.com/style.css" \
31 -p 80:80 \
32 fuwn/september:latest
33```
34
35You may start to find this way of passing configuration cumbersome for many options, so a Docker management tool like [Portainer](https://www.portainer.io/) or a Docker Compose file might come in handy.
36
37### Docker Compose
38
39Docker Compose is a file-configurable Docker utility to make deploying exact container configuration and configuration sets simple. This repository provides a sample Docker Compose file, [`./docker-compose.yaml`](./docker-compose.yaml), with some examples configuration values that you can modify to your liking.
40
41After editing the file, you can bring up the composition using `docker-compose` command.
42
43```shell
44docker-compose up -d
45```
46
47### Executable
48
49While generally discouraged, you can run the September executable by itself and configure it through environment variables.
50
51```shell
52ROOT="gemini://fuwn.me" PORT="8080" CSS_EXTERNAL="https://example.com/style.css" ./september
53```
54
55If available, September will use the relative directory's `.env` file for populating its configuration. Here is an example `.env` file with a few values added.
56
57```dotenv
58# .env
59
60ROOT=gemini://fuwn.me
61PORT=8080
62CSS_EXTERNAL=https://example.com/style.css
63HEAD=<script>/* This will appear in the head of the HTML document. */</script>
64```
65
66## Configuration
67
68All configuration options with examples can be found in the [Configuration.md](./Configuration.md) file. Regardless of deployment method, these options remain present in each case.
69
70## Styling
71
72Want to give your website a shiny new look? Try using one of these sources to find a stylish and **minimal** (!!) CSS theme/ framework!
73
74- [dohliam/dropin-minimal-css](https://github.com/dohliam/dropin-minimal-css): Drop-in switcher for previewing minimal CSS frameworks
75- [dbohdan/classless-css](https://github.com/dbohdan/classless-css): A list of classless CSS themes/frameworks with screenshots
76
77## Origins
78
79The story of September starts with a simple request to add environment variable-configurable options to a pre-existing Gemini proxy.
80
81The proxy in question already had options, just that they were command-line flag configurable options. Apparently, containerising a networked application is not a "valid use-case", and everyone should prefer running raw binaries on their systems and servers. Also, finicky command-line arguments reign superior to the industry standard environment variable, or at least that's what I gather from this author's response to adding a few extra lines of code that I already wrote out for environment variable support.
82
83Anyway, I forked the proxy. Somewhere down the line, I realised that this proxy just isn't cutting it and was poorly designed to begin with, so I threw it in the figurative trash, and wrote September from scratch.
84
85In the end, it all worked out, since September has become the easiest to configure, most feature-packed, quickest to understand (and quickest in general) Gemini-to-HTTP proxy of the bunch.
86
87## License
88
89This project is licensed with the [GNU General Public License v3.0](./LICENSE).