How to use the command agate (with examples)

Agate is a simple server for the Gemini network protocol. It allows you to run and generate a private key and certificate, run the server, and display help. This article will provide examples for each of these use cases.

Use case 1: Run and generate a private key and certificate

Code:

agate --content path/to/content/ --addr [::]:1965 --addr 0.0.0.0:1965 --hostname example.com --lang en-US

Motivation: Generating a private key and certificate is necessary to establish a secure connection between the server and clients. This use case is essential for setting up a secure Gemini server.

Explanation:

• --content path/to/content/: Specifies the path to the directory containing the content served by the server.
• --addr [::]:1965: Binds the server to the IPv6 address [::] and the port 1965 to listen for incoming connections.
• --addr 0.0.0.0:1965: Binds the server to all available network interfaces (IPv4 and IPv6) on the port 1965 to listen for incoming connections.
• --hostname example.com: Sets the hostname for the server. This is used to generate the private key and certificate.
• --lang en-US: Sets the default language for the server.

Example output: The command will run and generate a private key and certificate using the specified arguments. The generated key and certificate will be used for establishing secure connections with clients.

Use case 2: Run server

Code:

agate path/to/file

Motivation: This use case allows you to run the Agate server using a specific file or directory as the content to be served. It is useful when you want to start the server and serve a specific file or directory immediately.

Explanation:

• path/to/file: Specifies the path to the file or directory that you want to serve through the Agate server. If it is a directory, Agate will serve its contents.

Example output: The server will start running, and the specified file or directory will be accessible through the Agate server. Clients can connect to the server and request the content.

Use case 3: Display help

Code:

agate -h

Motivation: When you need guidance on available options and how to use the Agate server, this use case provides a detailed help message with explanations for each flag and their respective usage.

Explanation:

• -h: Displays the help message for the Agate server. It provides information on available command-line arguments and their respective usage.

Example output: The command will output a detailed help message including descriptions and explanations of each available command-line argument, providing clear guidance on how to use the Agate server.

Conclusion:

Agate is a versatile tool for setting up a Gemini server. Whether you need to generate a private key and certificate, run the server, or get help, Agate provides the necessary functionalities. The examples provided in this article demonstrate the use cases of Agate and provide a starting point for exploring and utilizing this powerful server for the Gemini network protocol.