Go to file
Steve 694693e93c more clean up for dirpage gen 2020-02-21 16:41:16 -05:00
.gitignore Makefile, readme in markdown 2020-02-21 16:10:08 -05:00
Makefile Makefile, readme in markdown 2020-02-21 16:10:08 -05:00
README.md formatting 2020-02-21 16:13:54 -05:00
config.yaml.sample update docs 2020-02-20 17:03:34 -05:00
go.mod cleanup 2020-02-20 17:00:20 -05:00
go.sum Makefile, readme in markdown 2020-02-21 16:10:08 -05:00
gopher.go cleanup 2020-02-21 12:53:19 -05:00
main.go cleanup 2020-02-21 12:53:19 -05:00
proto.go cleanup 2020-02-21 12:53:19 -05:00
secretshop.service add sample config 2020-02-12 20:34:52 -05:00
server.go more clean up for dirpage gen 2020-02-21 16:41:16 -05:00

README.md

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:

---
active_capsules:
        - localhost
localhost:
        Hostname: "localhost"
        Port: "1965"
        RootDir: "/var/gemini"
        CGIDir: "/var/gemini/cgi"
        KeyFile: "localhost.key"
        CertFile: "localhost.crt"

Please note that CGIDir currently not used (waiting on spec clarification).

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 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