How to access the local LXD documentation

The latest version of the LXD documentation is available at documentation.ubuntu.com/lxd (opens in a new tab).

Alternatively, you can access a local version of the LXD documentation that is embedded in the LXD snap. This version of the documentation exactly matches the version of your LXD deployment, but might be missing additions, fixes, or clarifications that were added after the release of the snap.

Complete the following steps to access the local LXD documentation:

1. Expose the LXD server

Make sure that your LXD server is exposed to the network.
You can expose the server during initialization, or afterwards by setting the core.https_address server configuration option.

2. Open the documentation in your browser

Access the documentation in your browser by entering the server address followed by /documentation/.
For example:

[https://192.0.2.10:8443/documentation/](https://192.0.2.10:8443/documentation/)

Note
If you have not set up a secure TLS server certificate,
LXD uses a self-signed certificate, which will cause a security warning in your browser.
Use your browser’s mechanism to continue despite the security warning.