go-gemini/doc.go

53 lines
1.4 KiB
Go
Raw Normal View History

2021-01-09 23:16:50 -07:00
/*
2021-02-17 22:37:56 -07:00
Package gemini provides Gemini client and server implementations.
2021-01-09 23:16:50 -07:00
Client is a Gemini client.
client := &gemini.Client{}
resp, err := client.Get("gemini://example.com")
if err != nil {
// handle error
}
defer resp.Body.Close()
2021-01-09 23:16:50 -07:00
// ...
Server is a Gemini server.
server := &gemini.Server{
2021-01-09 23:21:56 -07:00
ReadTimeout: 10 * time.Second,
WriteTimeout: 10 * time.Second,
2021-01-09 23:16:50 -07:00
}
Servers should be configured with certificates:
2021-02-20 22:56:37 -07:00
certificates := &certificate.Store{}
err := certificates.Load("/var/lib/gemini/certs")
2021-01-09 23:16:50 -07:00
if err != nil {
// handle error
}
2021-02-20 22:56:37 -07:00
server.GetCertificate = certificates.GetCertificate
2021-01-09 23:16:50 -07:00
2021-02-17 22:37:56 -07:00
ServeMux is a Gemini request multiplexer.
ServeMux can handle requests for multiple hosts and schemes.
2021-01-09 23:16:50 -07:00
2021-02-17 22:37:56 -07:00
mux := &gemini.ServeMux{}
2021-02-20 22:56:37 -07:00
mux.HandleFunc("example.com", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
2021-01-09 23:16:50 -07:00
fmt.Fprint(w, "Welcome to example.com")
})
2021-02-20 22:56:37 -07:00
mux.HandleFunc("example.org/about.gmi", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
2021-02-17 22:37:56 -07:00
fmt.Fprint(w, "About example.org")
2021-01-09 23:16:50 -07:00
})
2021-02-20 22:56:37 -07:00
mux.HandleFunc("http://example.net", func(ctx context.Context, w gemini.ResponseWriter, r *gemini.Request) {
2021-01-09 23:16:50 -07:00
fmt.Fprint(w, "Proxied content from http://example.net")
})
2021-02-17 22:37:56 -07:00
server.Handler = mux
2021-01-09 23:16:50 -07:00
To start the server, call ListenAndServe:
2021-02-20 22:56:37 -07:00
err := server.ListenAndServe(context.Background())
2021-01-09 23:16:50 -07:00
if err != nil {
// handle error
}
*/
package gemini