gddo

Overview ¶

Command gddo fetches and serves documentation for Go programs.

For usage, see:

gddo --help

gddo supports running as an HTTP server, a Gemini server, or both. The --http and --gemini flags control which addresses gddo will listen on. If neither are specified, gddo will not listen for any connections.

When the --gemini flag is present, gddo will only accept requests for the hostname specified with the --hostname flag. gddo will also automatically generate TLS certificates as needed and place them in the directory specified with the --certs flag.

The --fetch-timeout flag configures the timeout for fetching documentation. If the timeout is exceeded, gddo will continue fetching the documentation in the background. The user can refresh the page to check on its progress.

The --refresh-interval and --max-age flags control background crawling of packages in the database. To enable background crawling, specify a refresh interval greater than zero. The --max-age flag configures how old a module must be before gddo will crawl it.

gddo will sometimes make HTTP requests to fetch project information or fetch packages from a Go module proxy. The --user-agent flag configures the user agent that gddo will use for HTTP requests. The --request-timeout flag configures the timeout for roundtripping an HTTP request.

gddo supports rendering documentation for multiple platforms. To configure the default platform, specify the --platform flag.

gddo can run behind a TLS-terminating reverse proxy. In order to ensure that badge URIs use the correct scheme, have the reverse proxy set the X-Forwarded-Proto HTTP header to the desired protocol (e.g. https).