Ubuntu Manpages

Ubuntu Manpages is a site which contains thousands of dynamically generated manuals, extracted from every support version of Ubuntu and updated on a regular basis.

Basic Usage

Assuming you have access to a bootstrapped Juju controller, you can deploy the charm with:

❯ juju deploy ubuntu-manpages

The charm accepts only one configuration option: releases, which is a comma-separated list of Ubuntu releases to include in the manpages, which you can adjust like so:

❯ juju config ubuntu-manpages releases="questing, plucky, oracular, noble"

When a new configuration is applied, the charm will automatically update the manpages to include the new releases, and purge any releases that are present on disk from a previous configuration, but no longer specified.

To update the manpages, you can use the provided Juju Action:

❯ juju run ubuntu-manpages/0 update-manpages

Integrating with an ingress / proxy

The charm supports integrations with ingress/proxy services using the ingress relation. To test this:

# Deploy the charms
❯ juju deploy ubuntu-manpages
❯ juju deploy haproxy --channel 2.8/edge --config external-hostname=manpages.internal
❯ juju deploy self-signed-certificates --channel 1/edge

# Create integrations
❯ juju integrate ubuntu-manpages haproxy
❯ juju integrate self-signed-certificates haproxy

# Test the proxy integration
❯ curl -k -H "Host: manpages.internal" https://<haproxy-ip>/<model-name>-ubuntu-manpages

For more information, see the Github Repository.