# Agate

Agate is a server for the Gemini network protocol, built with the Rust programming language. It is open source and self-hosted, installable on Unraid.

Canonical page: https://ourlocalhost.com/app/2589/agate

## Description

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.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

71/100 (Good), based on 4 of 5 factors.
- Maintained: 100 (last commit 12 days ago)
- Popular: 58 (751 GitHub stars)
- Easy to install: 20 (1 install platform, Docker image)
- Security check: 78 (no serious findings, CI, tests, OpenSSF Scorecard 4.5/10)

## Links

- Unraid: https://ca.unraid.net/apps/agate-0rm7jkr05r9w7b?q=Agate

## Common questions

### Which port should I expose when running Agate in Docker?

Use port 1965 for the host-to-container mapping shown in the Docker example. The command maps host port 1965 to container port 1965.

### What volumes should I mount so Agate content and certificates persist?

Mount one volume to /gmi for your static content and another to /certs for certificates. If the certificates directory is not persisted, newly generated certificates are lost on shutdown and visitors see certificate warnings after restarts.

### How do I set the site hostname in the Docker command?

Pass the --hostname flag with the hostname to serve. The Docker example uses --hostname example.org.

### Which Docker image tags should I use for controlled updates?

Use tags such as major, major.minor, major.minor.patch, the full version, or latest. For example, :3 tracks the latest v3.* image, :3.3 tracks the latest v3.3.* image, and :latest tracks the newest release of any version.

### Does Agate provide built-in authentication or dynamic features?

No. Agate is described as a static file server with very few features and can only serve static files.

---
Source: Our Local Host (https://ourlocalhost.com/app/2589/agate), the self-hosted and open-source app directory.
