formatting

This commit is contained in:
Steve 2020-02-21 16:13:54 -05:00
parent afb0e72a2c
commit 5c6e304701

View File

@ -1,36 +1,42 @@
SecretShop: a small Gemini server. # SecretShop: a small Gemini server.
# Features ## Features
* Multi-site hosting * Multi-site hosting
* Also supports simple Gopher hosting * Also supports simple Gopher hosting
* Fully compliant with Jetforce diagnostics * Fully compliant with Jetforce diagnostics
* Probably won't kill your computer * Probably won't kill your computer
# Configuration ## Configuration
SecretShop looks in it's current running directory and /etc/secretshop for it's config file. 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 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: but a standard file looks like such:
--- ---
active_capsules: active_capsules:
- localhost - localhost
localhost: localhost:
Hostname: "localhost" Hostname: "localhost"
Port: "1965" Port: "1965"
RootDir: "/var/gemini" RootDir: "/var/gemini"
CGIDir: "/var/gemini/cgi" CGIDir: "/var/gemini/cgi"
KeyFile: "localhost.key" KeyFile: "localhost.key"
CertFile: "localhost.crt" CertFile: "localhost.crt"
Please note that CGIDir currently not used (waiting on spec clarification). Please note that CGIDir currently not used (waiting on spec clarification).
# Installation ## Building
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 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 Running "make service" will install to /usr/local/bin and also install the systemd service file
# Uninstall ## Uninstall
Simply run "make uninstall" Simply run "make uninstall".
# Running ## Running
Either run the executable directly or use the SystemD unit file Either run the executable directly or use the SystemD unit file