---
title: Charmhub | Deploy Ubuntu Manpages using Charmhub - The Open Operator Collection
description: Deploy the latest version of Ubuntu Manpages as a Kubernetes Operator
  on any cloud. A charm for deploying the online Ubuntu manpage archive.
url: https://charmhub.io/ubuntu-manpages
---

# Ubuntu Manpages

[Skia](https://charmhub.io/publisher/hyask "View all packages from Skia")

* [Skia](https://charmhub.io/publisher/hyask "View all packages from Skia")

Platform:

stable 99dfc90

```
juju deploy ubuntu-manpages
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

---

#### Relevant links

* [Homepage](https://manpages.ubuntu.com/)

---

#### Contacts

* [Submit a bug](https://github.com/canonical/ubuntu-manpages-operator/issues)

---

Share your thoughts on this charm with the community on discourse.

[Join the discussion](https://discourse.charmhub.io/)

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](https://charmhub.io/ubuntu-manpages#p-37853-basic-usage)

Assuming you have access to a bootstrapped [Juju](https://juju.is) 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](https://documentation.ubuntu.com/juju/3.6/howto/manage-actions/):

```
❯ juju run ubuntu-manpages/0 update-manpages
```

## [Integrating with an ingress / proxy](https://charmhub.io/ubuntu-manpages#p-37853-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 traefik-k8s --trust --config external-hostname=manpages.internal

# Create integrations
❯ juju integrate ubuntu-manpages traefik-k8s

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

For more information, see the [Github Repository](https://github.com/canonical/ubuntu-manpages-charm).

---

[Help improve this document in the forum](https://discourse.charmhub.io/t/ubuntu-manpages-documentation/17965) ([guidelines](https://discourse.charmhub.io/t/how-to-write-docs-our-documentation-guidelines-for-contributors/1245)). Last updated 6 months ago.
