agate

Simple gemini server for static files
git clone https://github.com/mbrubeck/agate.git
Log | Files | Refs | README

commit 2b26ed91674665dc68d7e4976ad4f07de2449cd9
parent 45d2e8cf8081032b35cba9704a3665b0706b3f43
Author: Matt Brubeck <mbrubeck@limpet.net>
Date:   Wed, 20 May 2020 14:40:01 -0700

README

Diffstat:
MREADME.md | 39+++++++++++++++++++++++++++++++++++++++
Dtests/cert.pem | 30------------------------------
Dtests/key.rsa | 52----------------------------------------------------
3 files changed, 39 insertions(+), 82 deletions(-)

diff --git a/README.md b/README.md @@ -0,0 +1,39 @@ +# Agate + +## 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 + +* Home page: [gemini://gem.limpet.net/agate/][home] +* [Cargo package][crates.io] +* [Source code][source] + +## Installation and setup + +1. [Install the Rust toolchain][rustup]. + +2. Run `cargo install agate` to install agate from crates.io, 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 "/CN=example.com" +``` + +4. Run the server. The command line arguments are `agate <address:port> <content_dir> <cert_file> <key_file>`. For example, to listen on the standard Gemini port (1965) on all network interfaces: + +``` +agate 0.0.0.0:1965 path/to/content/ cert.pem key.rsa +``` + +When a client requests the URL `gemini://example.com/foo/bar`, 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. Currently, Agate sends all responses with the `text/gemini` MIME type. (Support for other MIME types may be added in the future.) + +[Gemini]: https://gemini.circumlunar.space/ +[Rust]: https://www.rust-lang.org/ +[home]: gemini://gem.limpet.net/agate/ +[rustup]: https://www.rust-lang.org/tools/install +[source]: https://github.com/mbrubeck/agate +[crates.io]: https://crates.io/crates/agate diff --git a/tests/cert.pem b/tests/cert.pem @@ -1,30 +0,0 @@ ------BEGIN CERTIFICATE----- -MIIFNTCCAx2gAwIBAgIUOrH8hHHVFo1QuRsauj1CSgzRsdcwDQYJKoZIhvcNAQEL -BQAwHDEaMBgGA1UEAwwRZ2VtaW5pLmxpbXBldC5uZXQwHhcNMjAwNTE4MDIxMTQ0 -WhcNMzAwNTE2MDIxMTQ0WjAcMRowGAYDVQQDDBFnZW1pbmkubGltcGV0Lm5ldDCC -AiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBALhcIahftwji/VeQ0c5mOATy -5JkqQXnnMnkz7GBhKRulXa3hkw4xI7dR6hjUIHuu6rNwBR6FO0zTKT4vpTgAtQ+m -BEDvO6ju/lEVm1WAAWWXsVVHb2tQi788Ab7JLkvljCuRPLJ7IIsr/M/zakq3MmD+ -lZzTnj/ocxSSag2xfi8AFOlGi495zW3nBtJO6WOUXmB85A+UwELicUZRGCeR+S9R -Gqk9wbb6jowzqFwHD26gIDNj27nzkxqataITyOADxv6F+YmoRIIQ53gOhYU3qihB -0GuAeyE0tGh/+20jd3N7TFEBxAUM5EsfzpCLxTbJw1onM3aG8tGMFo6hzV2X4Ozw -XdBRxP2UnNkZX8GjcB79bOhCzm/C2dmi1VUaKQ84ZYyFmZfrzNCph/UpLHM/PGI5 -orxZ4XIaC9ibdn+dAs/Ddygew5VdniGD/7uOCAz+84a+o2yYiqg1s7H9YOhwIHKG -/Ozso3+Gc9Wf2Q4DfZ99m/u5rwR2XPm/ooEhW99p890ZBCIyIDt7xpLmzPa+A6j5 -4Pvedc9Zlhy7eYDmQwvyZsbzpsBkMadXyN9WiU4WbVgVA0HVHXaCt+mFCFctrJWB -9N2otjc9Rc6dsLftNspodLWX63JiOmMu5E/SstOkHkx+wfo62Uaok/Rg5nJ+aj6S -jWgMK1bD8A+LuCc5NlN/AgMBAAGjbzBtMB0GA1UdDgQWBBT8SrhdUlfEJtNjSuZH -M7FZnq4zfTAfBgNVHSMEGDAWgBT8SrhdUlfEJtNjSuZHM7FZnq4zfTAPBgNVHRMB -Af8EBTADAQH/MBoGA1UdEQQTMBGCCWxvY2FsaG9zdIcEfwAAATANBgkqhkiG9w0B -AQsFAAOCAgEAZxuFLvKNywOrkiefeiyOroed/y22hRKD/RFbMQmxaXF114q29QJO -x1YlgdMoRWJM2+jAS7kYFufITy57L5eefMhmWK/euQgowQDHXilDhvONSg2Wc3zz -uB2x34guM9U8iAMbW6e4IO8VQ4Jl0NnOEiVKPurEX9LIY4ZO7sNiAS//PWlztPz2 -GPDrKerOMmGy/ky7YC+8tW2Hq1GwEs0r0kQURUISfU4tCmqmonh1ljntImjPaOEh -pT/0ES+Kug8Jw07aM6NEfUFh1oU6TrpMWtIyCAUeuSGe9xDcvGwCjveoHO+zkHEy -icYWy9uFU0tbr+jEjfnmQBxe8flm0HdpMKCAMPWhxNNrX/erLD7o8KLl/KQRlcfc -6aH/NNBUIh10FWDJbRwyq1WwA+K0eJ513epBayGJXVeGrtaf6PBfqTby4E+wZZSm -htJ3UFOh3gQe3Wfdwq3vxk4Rnfv40D51Ej2FeC5NfRLBKCYBAbFh+8N4jrEmFgyK -NYXa5ILygO+uBxWJKBt+LDqN+ydhwj5kjhfqzuEqNklHofYzOKMPLEHsjvPMaFSq -z80ASZSjYVoHuqktjJKykjPtiIOMVZigdDgynqTXp3BfqySU6hzy0pSeow6CCmRm -f24prQpTUxT1BO8d153hP71ukhWbzPNE7RkLedB0qADgZp+H09ifqYs= ------END CERTIFICATE----- diff --git a/tests/key.rsa b/tests/key.rsa @@ -1,52 +0,0 @@ ------BEGIN PRIVATE KEY----- -MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQC4XCGoX7cI4v1X -kNHOZjgE8uSZKkF55zJ5M+xgYSkbpV2t4ZMOMSO3UeoY1CB7ruqzcAUehTtM0yk+ -L6U4ALUPpgRA7zuo7v5RFZtVgAFll7FVR29rUIu/PAG+yS5L5YwrkTyyeyCLK/zP -82pKtzJg/pWc054/6HMUkmoNsX4vABTpRouPec1t5wbSTuljlF5gfOQPlMBC4nFG -URgnkfkvURqpPcG2+o6MM6hcBw9uoCAzY9u585MamrWiE8jgA8b+hfmJqESCEOd4 -DoWFN6ooQdBrgHshNLRof/ttI3dze0xRAcQFDORLH86Qi8U2ycNaJzN2hvLRjBaO -oc1dl+Ds8F3QUcT9lJzZGV/Bo3Ae/WzoQs5vwtnZotVVGikPOGWMhZmX68zQqYf1 -KSxzPzxiOaK8WeFyGgvYm3Z/nQLPw3coHsOVXZ4hg/+7jggM/vOGvqNsmIqoNbOx -/WDocCByhvzs7KN/hnPVn9kOA32ffZv7ua8Edlz5v6KBIVvfafPdGQQiMiA7e8aS -5sz2vgOo+eD73nXPWZYcu3mA5kML8mbG86bAZDGnV8jfVolOFm1YFQNB1R12grfp -hQhXLayVgfTdqLY3PUXOnbC37TbKaHS1l+tyYjpjLuRP0rLTpB5MfsH6OtlGqJP0 -YOZyfmo+ko1oDCtWw/APi7gnOTZTfwIDAQABAoICAE2wPVq3oujyxnF9DHyepKKp -PF2y6c6V97YNhGGE8A6/W7+nXBHR8UwSD8UQtvOH3U1qOi4HVNrl7O5Qo5365lHG -0uoOJiTlOXQv17pq66vFBax7It+lHI6kmdOs8X54J95AIMTRkAA1tB5pY/RCSM+I -2MEyh/BEYyJbJKfKkPL7ZNR8rtjyKfhTL5O2PzGAV1jvqCdMtsw4oiVQjQ43vDsN -QV/qL1SNNz6rkhndu8oRXiBpxzEQDIBci4fWMIL99IBTMrmol937g58a93cQ4vp9 -6XczuC9hB1k1/VybYn3eimVkihbavOVPbPuKervAwDqgZFZhPbfCActvMZxsIRLf -LKImIJINNMdblitCGOJxT5rZmsmQ2mfGVz4yRGfYFA7LGfVuQl5UB1VYIRNARcel -f3pr7ltr/jMHZ2xuYVuc6XeJ6myQWPk/9Ib8R1mx6wJbgZvhW10yKoPoAoFDvVf8 -l/PX/ggudA6CkSxXk1Y2XGkRevx2STZFE0ss6hVMdxA18NEjXY0TmZyrDhbDnRY+ -WSdVTwyPNuShF3TUwxKHVDRVuER/gQSQ1bXSxFeWRSzetJEH0iAVGfjTv5pYZeP5 -rekkERpkVeRG+GU42Bpfp2WD3uyG5YLZWGXIEB0BV7YRYxg1Hz5WKHfqDHslJszj -fzr/bJIqcZXJvt8pCVm5AoIBAQD1esHBQVf/IC4k1oW2JzwW5YajXt8iV1Sslzf9 -Jl3O1Dt76ut9BSoM2A0XNggUykmqhSQc/KDMpDzyYau04F9kXxgoV0bBhyXLc0ES -gJFYaXfx+nhyAz2VN+chB93VZPDBl/uW90Dxl4DNbY5Rq154J2Qp7OUCuGcn6QOC -YqUSiLrYnuy1iz66LpKbvQ1CEKNF3EXKSO8xe9BnkMxDpifH6B2RN8bRsflSSN+B -444Y7G3aKyKwqsgCtVUGUggVTlW6VKgpp+kkHqnW8iX4G1X7q//C47Ivm46vI6Bh -psCfrNk3tfjS3VD2F6T+TZp4hJ8xROYUpwt6QRcUaUViKWgNAoIBAQDAQs81aimy -dMrp4V8TL98uerxtJrtRK9CDDGoE1sW6GnGXY8nTJO9nKHR0a8J208x/vHCwkmXY -ZbxBmZuYb54+lacXagNVPwENNeaDS0k/u3jGTSJcK5FSoWO0AwHaAr8qINDkMeSI -Fbq3q67HCuJfJu+pThE9I+xZGlQU7W9XG/b2VJ/yaVK7GT7UUfXCjGF3/mRta4MK -YUle8shNqqnM8ErMNDQJv4As1n0FrFGhHXpkgdxXd3mWNdxFwWKlFqy4ghDTZe+l -TFPsTt556RmaZvEScAo6EqggZLqsEWm4sbaHJ4DHSmUyuUkDGPB60yqUYr7YCCGC -ZcQW5csCfhq7AoIBAQC9joh1oe7AjGn1ek4QRaXKDH12RDlLvGIfUDok2m6P2yT/ -4HztsoIxHtik9s0wuLA/48XqOE43GBAUHsXHy4b968yswhBaOvE9dIdoMS2LNw4v -JfnCGKyCQIPS5s8vDF45MBJQFifpJtOITjQa7pjpcYmQMmT5P8owcGeMVH4hnMGj -qr0gxyCuBm6hok/NlyltNdYSiVVjQbfBcXe6OWD4pk3GqGp33NWo66rkEwLUTiXZ -1XtZLtd59+prEgc55J6gXuToHcgTYzZFTAFz4C/6QmwiY09iId4BciJTpb+SzZeC -xJsawVnWXpXC5cwFimufURPWGNPtGLwov82bKlw1AoIBAEw6MO18qguXQtx3/roc -wOAsyYh9UsdcF8/dnCtO/BZNZbwgVGTiwAimgYWnM/LpBqueiw92++pQa9OWk5pc -puEpdJZT8f5afJBATqS/tMsQCVKWQolIvNWGJ4G3r4RAkoqheDEBlxpdgypPZ3yD -VD1lsp/t0+fp1kt9pNinSv2+mKwR4Vi7aZHE8KQ92rLH9d0df7PibJIxAGYk3EXu -5GPc4csU54z14FvmrqsRJ0w548z1r+b997cWo78EbZgG5XRCHWmzgNCI8r0+h/bN -9NjC99HXmjZsLzyos1qFjOUtkLEFeImLdZQm4kvYF4CbOMacYA5HKwIIVza85UCX -vwECggEBAPOMPZnSesPyBDOcH05gsM+8ntITvFARf7vtylH71dT923tLRhTJ9wJM -lth+JyABTjxR1S6qkua2EheH0F8LzsrGj/QYwdJyyOiQ0UPEgxsL2S3L0gx5i1ZT -jg1TWtJZmlFwi0xyhlB9/GWZlKFinevEj6q2haQcuZk/9DCmjrDs0bBkdEa38EJf -VAglP1kY3uqRnnebMWZJxLrPhNPETk3z6ORflijdw6pJI72cex4zbslg/iexIOPb -ZxI1T1EIiodQvG2VsNus67mhzJFSejAV2JMl2R56z8jsVk5IfQvm7zGkx0TGKQz8 -y3R+1EJF0BEfkVjr12H3BVgL9w6rlU0= ------END PRIVATE KEY-----