Bunkum.Protocols.Gemini 4.5.0

dotnet add package Bunkum.Protocols.Gemini --version 4.5.0
NuGet\Install-Package Bunkum.Protocols.Gemini -Version 4.5.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Bunkum.Protocols.Gemini" Version="4.5.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Bunkum.Protocols.Gemini --version 4.5.0
#r "nuget: Bunkum.Protocols.Gemini, 4.5.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Bunkum.Protocols.Gemini as a Cake Addin
#addin nuget:?package=Bunkum.Protocols.Gemini&version=4.5.0

// Install Bunkum.Protocols.Gemini as a Cake Tool
#tool nuget:?package=Bunkum.Protocols.Gemini&version=4.5.0

Bunkum.Protocols.Gemini

Gemini protocol support for Bunkum

Usage

using Bunkum.Core;
using Bunkum.Protocols.Gemini;

BunkumServer server = new BunkumGeminiServer(null, new LoggerConfiguration
{
    Behaviour = new QueueLoggingBehaviour(),
    #if DEBUG
    MaxLevel = LogLevel.Trace,
    #else
    MaxLevel = LogLevel.Info,
    #endif
});

server.Initialize = s =>
{
    s.DiscoverEndpointsFromAssembly(Assembly.GetExecutingAssembly());
};

server.Start();
await Task.Delay(-1);

Generating an SSL/TLS certificate

Gemini does not support unencrypted transport by design. To test locally, you must create a certificate. Bunkum cannot create one for you, but common tools like OpenSSL can do this for you.

Linux

First, create a private key/certificate pair. Change "localhost" to your FQDN if you'd like to use a self-signed certificate externally.

openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes -subj "/CN=localhost"

Then, convert your pair to a .pfx file that Bunkum can use:

openssl pkcs12 -export -out cert.pfx -inkey key.pem -in cert.pem

Hopefully, you should now have a file named cert.pfx that Bunkum can use.

Windows

TODO

Configuration

The BunkumGeminiServer allows a SSL configuration in the constructor. If one is not provided, it will default to creating a json config named geminissl.json instead:

{
  "Version": 1,
  "SslCertificate": "cert.pfx",
  "CertificatePassword": "password here or null"
}

Version refers to the configuration schema version, do not modify this.

SslCertificate points to the path of your certificate.

CertificatePassword can either be the password as a string or simply null in the case of no password.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Bunkum.Protocols.Gemini:

Package Downloads
Bunkum.Serialization.GopherToGemini

Allows serialization of Gophermaps in Gemini for Bunkum servers

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.5.0 81 4/24/2024
4.4.5 104 2/19/2024
4.4.4 90 2/5/2024
4.4.3 193 12/4/2023
4.4.2 109 12/3/2023
4.4.1 118 11/26/2023
4.4.0 104 11/25/2023
4.3.3 146 10/28/2023
4.3.2 111 10/27/2023
4.3.1 128 10/22/2023
4.3.0 123 10/22/2023