Expose the full LXD documentation website as part of a LXD deployment

LXD Specifications
21

What is the proposed URL for these docs btw?

22

Yes, this sounds right for the LXD UI. The UI doesn’t need authentication, it is always served. We use the certificate type “client” for the API. We can use the same cert type for the docs. Though not sure if that fits users that want to give access to the docs but not the API.

A previous concern was, the docs are only visible to authorized users and as we add new ways to authorize in the API, the docs have to stay in sync with those methods. So a user coming from the UI authenticated with OIDC will not see an auth error on the locally linked docs path.

23

@edlerd would you be ok with /documentation as the URL endpoint?

24

Yes, that works for me.

1 Like
25

Thanks for implementing this feature - it’s nice to have the documentation available locally

2 Likes