stryan/secretshop
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

formatting

Browse Source
This commit is contained in:
Steve 2020-02-21 16:13:54 -05:00
parent afb0e72a2c
commit 5c6e304701
1 changed files with 23 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,12 +1,12 @@
SecretShop: a small Gemini server.
# SecretShop: a small Gemini server.
# Features
## Features
* Multi-site hosting
* Also supports simple Gopher hosting
* Fully compliant with Jetforce diagnostics
* Probably won't kill your computer
# Configuration
## 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:
@ -24,13 +24,19 @@ localhost:
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 service" will install to /usr/local/bin and also install the systemd service file
# Uninstall
Simply run "make uninstall"
## Uninstall
Simply run "make uninstall".
# Running
## Running
Either run the executable directly or use the SystemD unit file