add readme

This commit is contained in:
Steve 2020-02-12 20:29:32 -05:00
parent 4103e14aec
commit b211b7edb1
1 changed files with 28 additions and 0 deletions

28
README Normal file
View File

@ -0,0 +1,28 @@
SecretShop: a small Gemini server.
# Features
- Multi-site hosting (WIP)
- CGI (WIP)
- Fully compliant with Jetforce diagnostics
- Probably won't kill your computer
# Configuration
SecretShop looks in it's current running directory and /etc/secretshop for it's config file.
Configuration is in config/yaml in one of the above directories. See the sample config for more details
but a standard file looks like such:
---
active_capsules:
- localhost
localhost:
Hostname: "localhost"
Port: "1965"
RootDir: "/var/gemini"
CGIDir: "/var/gemini/cgi"
KeyFile: "localhost.key"
CertFile: "localhost.crt"
# Running
Either run the executable directly or use the SystemD unit file