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
 5Flounder is in ALPHA -- development and features are changing frequently, especially as the Gemini spec and ecosystem remains relatively unstable.
 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 -c example-config.toml 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
30To 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.
31
32Backup your users' data regularly! The admin deletion commands are irreversible.
33
34Flounder comes with an admin panel accessible to users with the admin db flag set. Admins can also impersonate users if you need to take actions like moderating their content, deleting their account, changing their password, etc.
35
36You can also manage users directly through the sqlite database.