1# Flounder: a portal into the small web
 2
 3A lightweight server to help users build simple Gemini sites over http(s)
 4
 5Designed to help make the Gemini ecosystem more accessible.
 6
 7## Building
 8
 9Requires go 1.15 and sqlite3 development libraries.
10
11`go build`
12
13To run locally, you can use the example-config.toml to start a test server. Easy!
14
15`./flounder serve`
16
17## Deploying
18
19For the Http(s) server, you have two options:
20
211. Expose the flounder server to the internet directly
22
232. Route the flounder server through a reverse proxy
24
25This will determine how you set the values in flounder.toml
26
27
28## Admin
29
30Flounder comes with an admin panel acessible to users with the admin db flag set.