https://github.com/mk270/blizanci

A Gemini protocol server
https://github.com/mk270/blizanci

Last synced: 26 days ago
JSON representation

A Gemini protocol server

• Host: GitHub
• URL: https://github.com/mk270/blizanci
• Owner: mk270
• License: apache-2.0
• Created: 2020-05-18T21:56:38.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-01T20:21:48.000Z (12 months ago)
• Last Synced: 2024-08-03T17:09:30.183Z (4 months ago)
• Language: Erlang
• Size: 265 KB
• Stars: 29
• Watchers: 6
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-gemini - blizanci - server designed primarily for robustness and security. (Servers / Graphical)

README

        
blizanci

========

Blizanci is a [Gemini protocol](https://gemini.circumlunar.space/) server.

It is designed primarily for robustness and security.

Features:

* [TLS client certificate](https://en.wikipedia.org/wiki/Public_key_certificate#TLS/SSL_client_certificate) support

* single-user [CGI](https://en.wikipedia.org/wiki/Common_Gateway_Interface)

* distributed PKI: authorisation by subject or *issuer* of certificates

* Titan protocol uploads

* servlet interface for in-process dynamic page generation

Prerequisites

-------------

You'll need Erlang and Rebar. On a Debian-derived system like Ubuntu, this means installing the rebar3 executable from the rebar3 website, and installing the deb package erlang:

* [Rebar3 installation instructions](https://www.rebar3.org/docs/getting-started#installing-binary)

* `apt-get install erlang`

Config

------

Currently, a config file is required. In due course, this will become optional.

Create an appropriate `sys.config` and `vm.args` file in the `config/`

directory in the format suggested in the examples in that directory.

You'll also need to put TLS certificates in `ssl/certificate.pem` and

`ssl/key.pem`; these locations can be reconfigured, but blizanci will

fail on startup with a `badmatch` / `couldnt_open_pem_file` message if

the certificates cannot be read.

Build

-----

    $ rebar3 release

Run

---

    $ ./manage.sh start-daemon

Trivia

------

"blizanci" / "близанци" is Serbo-Croatian for "twins" (i.e., Gemini).

Documentation

-------------

A work in progress at [https://mk270.github.io/blizanci/](https://mk270.github.io/blizanci/).

Status

------

The source code of Blizanci is largely "finished". There are no plans to add new features.

But software is more than just programs. There is already some documentation of blizanci's internal APIs - eventually a manual will be produced and some installation advice and packaging / tooling.