flounder

A simple gemini site builder
Log | Files | Refs | README | LICENSE

commit 1965dde80fb769aa66e447897c6dd9b62bbc6780
parent 1795602c78ccfa1a222d1bf706bc6dd0256fe274
Author: alex wennerberg <alex@alexwennerberg.com>
Date:   Sun, 31 Jan 2021 12:19:15 -0800

Cleanup README

Diffstat:
MREADME.md | 14+++++++-------
Mexample-config.toml | 8++++----
2 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md @@ -6,10 +6,10 @@ Flounder is in ALPHA -- development and features are changing frequently, especi See the flagship instance at https://flounder.online and gemini://flounder.online -## Building +## Building and running locally Requirements: -go >= 1.15 -sqlite dev libraries +* go >= 1.15 +* sqlite dev libraries To run locally, copy example-config.toml to flounder.toml, then run: @@ -21,15 +21,17 @@ Add the following to `/etc/hosts` (include any other users you want to create): 127.0.0.1 flounder.local admin.flounder.local proxy.flounder.local ``` +Then open `flounder.local:8165` in your browser. + ## TLS Certs and Reverse Proxy -Gemini TLS certs are handled for you. For HTTP, you'll need a reverse proxy that does the following for you: +Gemini TLS certs are handled for you. For HTTP, when deploying your site, you'll need a reverse proxy that does the following for you: 1. Cert for yourdomain.whatever 1. Wildcard cert for \*.yourdomain.whatever 2. On Demand cert for custom user domains -If you have a very small deployment of say, <100 users, for example, you can use on demand cert for all domains, and you can skip step 2. +If you have a very small deployment of say, <100 users, for example, you can use on demand certificates for all domains, and you can skip step 2. However, for a larger deployment, you'll have to set up a wildcard cert. Wildcard certs are a bit of a pain and difficult to do automatically, depending on your DNS provider. For information on doing this via Caddy, you can follow this guide: https://caddy.community/t/how-to-use-dns-provider-modules-in-caddy-2/8148. @@ -39,8 +41,6 @@ An example simple Caddyfile using on-demand certs is available in Caddyfile.exam If you want to host using a server other than Caddy, there's no reason you can't, but it may be more cumbersome to setup the http certs. -You can run this locally by removing the port from the Host config - ## Development Patches are welcome! diff --git a/example-config.toml b/example-config.toml @@ -1,14 +1,14 @@ # Used in HTML templates and titles SiteTitle="demoflounder" +# Port to run server on +HttpPort=8165 + # Include port if running locally Host="flounder.local:8165" # Running through reverse proxy # Host="flounder.local" -# Port to run on -HttpPort=8165 - # Folder containing subfolders for each user's files FilesDirectory="./files" LogFile="./flounder.log" @@ -30,4 +30,4 @@ MaxFileBytes=128000 # 128 KB MaxUserBytes=10000000 # 10 MB OkExtensions=[".gmi", ".txt", ".jpg", ".jpeg", ".gif", ".png", ".svg", ".webp", ".midi", ".json", ".csv", ".gemini", ".mp3", ".css", ".ttf", ".otf", ".woff", ".woff2"] - +BannedNames=["