🍁 A very simple static Gemini server, now with Titan support!
cpp
gemini
titan
gemini-protocol
titan-protocol
docs(readme): update instructions and description
+42
-3
+42
-3
README.md
+42
-3
README.md
···
1
1
# Maple
2
2
3
-
A very simple static Gemini server; written within a single file and liberally
4
-
spanning 159 lines-of-code.
3
+
A very simple static Gemini server, now with Titan support!
4
+
5
+
### Lines-of-code
6
+
This codebase is now 351 lines of lines-of-code!
7
+
8
+
The statement "... written within a single file and liberally
9
+
spanning 159 lines-of-code." has been removed.
10
+
11
+
If you would still like the minimal 159-LOC experience, checkout
12
+
[49ce0f8](https://github.com/gemrest/maple/tree/49ce0f83b8abd1af4760e56c1673c6997ef8a2c4)!
13
+
(Docker tag `0.1.4`) Do note, that version of this project is outdated and only
14
+
has Gemini support.
5
15
6
16
## Usage
7
17
···
24
34
Docker Compose file or executable -- named [`.maple/gmi`](.maple/gmi) and
25
35
ending with the file extension `.gmi`.
26
36
37
+
### Environment Variables
38
+
39
+
Maple can be configured with three optional environment variables:
40
+
41
+
#### `TITAN`
42
+
43
+
Enable Titan support.
44
+
45
+
Takes a value of either `true` or `1`, case-insensitive.
46
+
47
+
Defaults to off.
48
+
49
+
#### `TITAN_TOKEN`
50
+
51
+
Set a token to restrict Titan access.
52
+
53
+
Takes a string value, case-sensitive.
54
+
55
+
Defaults to no token, **anyone can upload!**
56
+
57
+
#### `TITAN_MAX_SIZE`
58
+
59
+
The maximum size in bytes which a Titan upload is permitted to perform.
60
+
61
+
Takes an integer.
62
+
63
+
Default to `1024`.
64
+
27
65
### Docker Compose
28
66
29
67
A Docker Compose file is already setup [here](./docker-compose.yaml). The only
···
35
73
### Executable
36
74
37
75
1. Build: `ninja` (requires [Ninja](https://ninja-build.org/))
38
-
2. Run: `out/maple`
76
+
2. Run: `out/maple`, or
77
+
`TITAN=1 TITAN_TOKEN=secret TITAN_MAX_SIZE=2048 out/maple`
39
78
40
79
## Capsules using Maple
41
80