1# Flounder: a portal into the small web
 2
 3A lightweight server to help users build simple Gemini sites over http(s) and serve those sites over http(s) and gemini
 4
 5## Building
 6
 7Requires go 1.15 and sqlite3 development libraries.
 8
 9`go build`
10
11To run locally, you can use the example-config.toml to start a test server. Easy!
12
13`./flounder -c example-config.toml serve`
14
15## Deploying
16
17For the Http(s) server, you have two options:
18
191. Expose the flounder server to the internet directly
20
212. Route the flounder server through a reverse proxy
22
23This will determine how you set the values in flounder.toml 
24
25
26## Admin
27
28To make yourself an admin, create a user through the web browser, then run `./flounder -c [config_path] make-admin [your user]` -- this gives you access to admin tools to manage users.
29
30Backup your users' data regularly! The admin deletion commands are irreversible.
31
32Flounder comes with an admin panel accessible to users with the admin db flag set. 
33
34You can also manage users directly through the sqlite database.