Emi/kochab

An ergonomic and elegant framework for creating Gemini servers and SCGI apps without needless bloat

Go to file

Emii Tatsuo 85cbb1d6d8 Remove unused squeegee dep		2020-12-01 23:24:10 -05:00
examples	Fix ratelimiting example	2020-12-01 17:13:54 -05:00
public	Rebrand as kochab	2020-11-25 00:42:09 -05:00
src	Added in autorewrite as an option to `Server`	2020-12-01 21:59:00 -05:00
.gitignore	Added ./data to .gitignore	2020-12-01 15:15:30 -05:00
Cargo.toml	Remove unused squeegee dep	2020-12-01 23:24:10 -05:00
CHANGELOG.md	Rebrand as kochab	2020-11-25 00:42:09 -05:00
LICENSE.md	Add licenses	2020-11-25 00:53:34 -05:00
LICENSE_NORTHSTAR.md	Add licenses	2020-11-25 00:53:34 -05:00
molly-brown.conf	Completely reworked request handling to be able to serve SCGI	2020-12-01 02:31:08 -05:00
README.md	Make it clearer that kochab handles certificate generation	2020-11-30 17:48:19 -05:00

README.md

      *.          ,.-*,,..
    .`  `.   .,-'`       ````--*,,,..
  .`      ;*`                       ```''-o
 *      ,' __              __          __
  `.  ,'  / /______  _____/ /_  ____ _/ /_
    ⭐   / //_/ __ \/ ___/ __ \/ __ `/ __ \
        / ,< / /_/ / /__/ / / / /_/ / /_/ /
       /_/|_|\____/\___/_/ /_/\__,_/_.___/

kochab

Kochab is an extension & a fork of the Gemini SDK northstar. Where northstar creates an efficient and flexible foundation for Gemini projects, kochab seeks to be as ergonomic and intuitive as possible, making it possible to get straight into getting your ideas into geminispace, with no worrying about needing to build the tools to get there.

Usage

It is currently only possible to use kochab through it's git repo, although it may wind up on crates.rs someday.

kochab = { git = "https://gitlab.com/Alch_Emi/kochab.git", branch = "kochab" }

Generating a key & certificate

By default, kochab enables the certgen feature, which will automatically generate a certificate for you. All you need to do is run the program once and follow the prompts printed to stdout. You can override this behavior by disabling the feature, or by using the methods in the Builder.

If you want to generate a certificate manually, it's recommended that you temporarily enable the certgen feature to do it, and then disable it once you're done, although you can also use the openssl client tool if you wish