# Flounder: a portal into the small web 

A lightweight server to help users build simple Gemini sites over http(s) and serve those sites over http(s) and Gemini

Flounder is in ALPHA -- development and features are changing frequently, especially as the Gemini spec and ecosystem remains relatively unstable.

See the flagship instance at https://flounder.online and gemini://flounder.online

## Building

Requires go >= 1.15 and sqlite3 development libraries.

`go build`

To run locally, you can use the example-config.toml to start a test server. 

`./flounder -c example-config.toml serve`

After creating an account, you can activate it at the command line with:

./flounder -c example-config.toml activate-user [your-username]

## Deploying

Gemini TLS certs are handled for you. For HTTP, you'll need a reverse proxy that does the following for you:

1. Wildcard for \*.yourdomain.whatever
2. On Demand cert for custom user domains

If you have a very small deployment <20 users, for example, you can use on demand cert for all domains, and don't have to setup a wildcard cert, for simplicity.

I'm using Caddy. I haven't tested any other servers.

I have not extensively tested the self-hosting capabilities, but making it easy to self-host Flounder for either a single or multi-user instance is a goal of mine. There may be minor issues where "flounder.online" is hardcoded, but I'm trying to fix them. Email me if you encounter issues or would like guidance.

## Admin

To 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.

Backup your users' data regularly! The admin deletion commands are irreversible.

Flounder 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.

## Development

Patches are welcome!

* [Ticket tracker](https://todo.sr.ht/~alexwennerberg/flounder)
* [Mailing list](https://lists.sr.ht/~alexwennerberg/flounder-discuss)