Kvarn

If you're looking for an executable to run your webserver with, see Mölla. Using Mölla, you can configure your host(s), add a search engine, authentication, and other parts of the Kvarn ecosystem. More info is available on the website.

See the roadmap or visit our website for more info.

Current state

A stable API is available and the crate is on crates.io. You can view the latest documentation online.

When using Mölla, you get access to all of Kvarn's extensions and most of it's features. If you need to develop custom extension (like those on icelk.dev) you need to compile Kvarn yourself. Luckily, Mölla makes it easy to add custom extensions.

To use the latest and greatest you can add Kvarn as a git dependency, though the latest version is recommended:

[dependencies]
kvarn = { git = "https://github.com/Icelk/kvarn" }

Dependencies

To increase security, build-times, reliability, and speed, I use dependencies sparingly.

The two heavy-hitters are tokio (async runtime for async networking, file access, and extensions) and rustls (for encryption, optional if you want to run a unsafe (often local) web server). brotli and flate2 are enabled by default to provide compression, but can be turned off. h2 provides optional (but strongly preferred) support for the HTTP/2 protocol.

See kvarn.org for more details.

Pushing to production

Take a look at the sample.service for how to configure systemd to use kvarnctl to manage Kvarn.

You can now use systemctl --user reload kvarn or similar to reload the server if you've changed the config or recompiled (if that's your thing). This ensures (on Unix) NO downtime. Not even a millisecond.

Installation

Mölla is the recommended way to get started with Kvarn. You can download it and other Kvarn tools (kvarnctl & chute) for Linux and macOS at the Releases page.

For Kvarn chute downloads for Linux, go here and download the artefact from the topmost job.

kvarnctl is also available as CI builds.

Documentation

Documentation of the main branch can be found at doc.kvarn.org.

To document with information on which cargo features enables the code, set the environment variable RUSTDOCFLAGS to --cfg docsrs (e.g. in Fish set -x RUSTDOCFLAGS "--cfg docsrs") and then run cargo +nightly doc.

Changelog

See the changelog.

Contributing

This library, and all other sub-projects in this repository, are distributed under the Apache License 2.0. So must all contributions also be.

All rights are reserved for images and logos unless explicitly stated otherwise. You are free to use them if reasonable credit is given. I reserve the right to order you to remove any usage at will.