matthias
/
astronomical-theater
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Activity

Update README

This commit is contained in:
Matthias Portzel 2022-10-09 22:40:17 -04:00
parent c5f4d281d5
commit 6a412a2dec
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.gmi
View File

@ -1,7 +1,15 @@
# Astronomical Theater # Astronomical Theater
A Node.js Gemini server and proxy. A Node.js Gemini server and proxy.
Do not use. ## Do not use.
This is known to be buggy.
I use it because the promise of Gemini is that people are able to write their own software, and that's an ideal that I believe in.
And I open-source it because I believe code should be free.
### Known bugs
* It reads the certificates into memory at start up, and never again. This means that if you (like me) use Let's Encrypt and rotate certs, then after three months the server needs to be restarted.
* It suffers from a Node JS bug which causes it to allocate ~10.8GB of virtual memory (not actual memory so this theoretically doesn't matter).
* Most importantly, it sometimes drops requests that it's proxying before they've completed. I kind of suspect this is also a Node.js bug, but I don't have a minimum reproduction case.
### We require SNI! ### We require SNI!
The Gemini spec requires clients to implement SNI. This server requires SNI to connect. The Gemini spec requires clients to implement SNI. This server requires SNI to connect.