agate 1.1.0

Very simple server for the Gemini hypertext protocol
agate-1.1.0 is not a library.


Simple Gemini server for static files

Agate is a server for the Gemini network protocol, built with the Rust programming language. Agate has very few features, and can only serve static files. It uses async I/O, and should be quite efficient even when running on low-end hardware and serving many concurrent requests.

Learn more

Installation and setup

  1. Install the Rust toolchain.

  2. Run cargo install agate to install agate from, or clone the source, run cargo build --release, and then copy the compiled binary from target/release/agate to any location you want. (You can also use cargo run --release <args> to run Agate from within the source directory.)

  3. Generate a self-signed TLS certificate and private key. For example, if you have OpenSSL 1.1 installed, you can use a command like the following. (Replace the hostname with the address of your Gemini server.)

openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \
    -days 3650 -nodes -subj "/"
  1. Run the server. The command line arguments are agate <host:port> <content_dir> <cert_file> <key_file>. For example, to listen on the standard Gemini port (1965) on localhost:
agate localhost:1965 path/to/content/ cert.pem key.rsa

When a client requests the URL gemini://, Agate will respond with the file at path/to/content/foo/bar. If there is a directory at that path, Agate will look for a file named index.gemini inside that directory.