git-gemini-forge-0.3.0 is not a library.

git-gemini-forge

A simple Gemini server that bridges public repositories from a Git forge onto Geminispace. Inspired by masalachai's gemini-git-browser.

Under Construction

[!WARNING] This project is under active construction, and is missing basic features. Inputs and environment variables may change at any time until v1.0.0.

Features:

Proxy a given git forge's API.
List a forge's public users.
List a given user's repositories.
List a given repository's branches.
List a given repository's tree.
Docker image

What still needs done:

Present source files.
Support other APIs than Forgejo.

Installation

Docker

Create a compose.yaml file like the following:

services:
  git-gemini-forge:
    image: git.average.name/averagehelper/git-gemini-forge:latest
    container_name: git-gemini-forge
    restart: unless-stopped
    environment:
      - PLATFORM_TYPE=forgejo
      - FORGE_URL=http://localhost:3000
    volumes:
      - "./.certs:/app/.certs:ro"
    network_mode: "host"

See also the example compose.yaml file provided here.

If your git forge is on a different network from the host, then omit network_mode and specify a ports map:

services:
  git-gemini-forge:
    # [...]
    ports:
      - "1965:1965"

Then run:

docker compose pull
docker compose up -d

Cargo

This crate is published on our own package registry. With cargo installed, run the following:

cargo install --index sparse+https://git.average.name/api/packages/AverageHelper/cargo/ git-gemini-forge

Also available from crates.io:

cargo install git-gemini-forge

Then run with:

FORGE_URL=http://localhost:3000 git-gemini-forge

Build from source

Clone this project using git. Then, with cargo installed, run the project using:

FORGE_URL=http://localhost:3000 cargo run --release

Certificates

For local development

Create TLS certificates like so:

mkdir -p .certs
cd .certs
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 1103760 -nodes -subj '/CN=localhost'

[!IMPORTANT] Change the '/CN=localhost' part to your expected domain when using in production.

Note that the -days arg in the command above sets the cert to expire sometime around the year 3024. This is sufficient for use with Gemini capsules or local development, but not much else.

The <project>/.certs directory must contain key.pem and cert.pem, or the server will panic.

Disclaimer

I am not responsible for misuse of this tool. The intent is for Forgejo admins to host this capsule alongside their own Forgejo installation, pinging the forge's API via localhost. While proxy via HTTPS is supported, proxying external git forges that you do not own is quite rude when done without permission. Be sure to obtain consent before bogging down someone else's server with proxy traffic.

git-gemini-forge 0.3.0