Skip to content

EasyGemini is a super-simple gemini static site server that quickly gets you started in bringing your gemini site online.

License

Notifications You must be signed in to change notification settings

oxtyped/easygemini

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

EasyGemini

EasyGemini is a super-simple gemini static site server that quickly gets you started in bringing your gemini site online.

Opinionated

EasyGemini currently makes a lot of assumptions and defaults, such as automatically generating a self-signed certificate and loading it for you. At its core, EasyGemini is powered by adano/go-gemini.

Roadmap

  • Caddyfile-style configuration mode
  • Support for proxying requests to Cloud-based Storage Systems (S3, GCS etc)
  • CGI-BIN support (Ref: RFC3875)

Features

  • 🔐 Handles the cert generation automatically
  • 🌏 Only supports (1) site per process

Non-goal

  • This server will NOT be able to support more than 1 site per process. In order to run multiple sites in a single host, it is advisable to use a loadbalancer with SNI support (eg. Haproxy) to proxy the requests to the right process.

Quickstart

  1. Pull the entire source code
  2. Download the respective binary and put it in the project repository root
  3. Create the sites/ and certs/ directory in your project root. You may leave the contents in certs/ blank as they will be auto-generated by easygemini
  4. Put your gemini files in the sites/ directory. Replace index.gmi as necessary

Your directory structure should look something like this:

x@y:/project/gemini/# tree
.
├── certs
    └── .
├── easygemini
└── sites
    └── index.gmi
$ easygemini serve
  1. Grab a gemini browser and head on over to gemini://localhost:1965

Currently Supports

  • Local Filepath (default: sites/*)

Upcoming

  • Amazon S3
  • DigitalOcean Spaces
  • Hetzner Storage
  • GCP GCS

About

EasyGemini is a super-simple gemini static site server that quickly gets you started in bringing your gemini site online.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages