51 lines
1.5 KiB
Markdown
51 lines
1.5 KiB
Markdown
# SecretShop: a small Gemini server.
|
|
|
|
## Features
|
|
* Multi-site hosting
|
|
* Also supports simple Gopher hosting
|
|
* 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:
|
|
|
|
---
|
|
port: 1965
|
|
active_capsules:
|
|
- localhost
|
|
localhost:
|
|
Hostname: "localhost"
|
|
Port: "1965"
|
|
RootDir: "/var/gemini"
|
|
CGIDir: "/var/gemini/cgi"
|
|
KeyFile: "localhost.key"
|
|
CertFile: "localhost.crt"
|
|
|
|
Where each "active_capsule" is a virtual Gemini capsule. SecretShop supports virtual Gemini capsules all listening on port 1965
|
|
as well as multiple Gopher servers runnning (though not virtual Gopher hosts due to protocol limitations)
|
|
|
|
## Building
|
|
Build Dependencies: go1.14
|
|
|
|
Running "make" should work for any given x86 machine.
|
|
|
|
If you're planning on running this on a Raspberry Pi or other ARM machine try
|
|
env GOOS=linux GOARCH=arm GOARM=5 make
|
|
|
|
## Installation
|
|
Running "make install" will install to /usr/local/bin by default.
|
|
|
|
Running "make service" will install to /usr/local/bin and also install the systemd service file
|
|
|
|
## Uninstall
|
|
Simply run "make uninstall".
|
|
|
|
## Running
|
|
Either run the executable directly or use the SystemD unit file
|
|
|
|
## Caveats
|
|
Currently does not support transient certificates
|
|
Only handles whitelisting for certificate authorization
|