> For the complete documentation index, see [llms.txt](https://docs-lunar.earthly.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs-lunar.earthly.dev/install.md).

# Install Lunar

Overview of Lunar installation, covering Hub, CLI, CI Tracer for self-hosted and managed runners, and AI skills for building plugins.

Welcome to the Lunar installation guide.

This section contains step-by-step instructions for installing Lunar. Install these pieces, in this order:

1. **Lunar CLI** – an admin and development CLI. Install this first: the Hub install walkthrough uses `lunar licence` to derive your GHCR image-pull secret from your licence JWT before `helm install`.
   * [Install the Lunar CLI](/install/cli.md)
2. **Lunar Hub** – the central coordination service. Decide how you will run it before the next step, because the Git platform setup differs between the two.
   * **Self hosted** – you operate the Hub on your own Kubernetes:
     * [Overview](/install/lunar-hub/self-hosted/overview.md) – the lay of the land: services, dependencies, ports.
     * [Prerequisites](/install/lunar-hub/self-hosted/prerequisites.md) – what to have in place before `helm install`.
     * [Install walkthrough](/install/lunar-hub/self-hosted/install-walkthrough.md) – step-by-step from zero to a working Hub.
     * [Day-2 operations](/install/lunar-hub/self-hosted/day-2-operations.md) – upgrades, secret rotation, observability, uninstall.
   * [**Lunar Dedicated**](/install/lunar-hub/dedicated.md) – Earthly provisions, operates, and upgrades a single-tenant install in a dedicated AWS account:
     * [Overview](/install/lunar-hub/dedicated/overview.md) – how it works, how you reach it, and how it handles your data.
     * [Setup](/install/lunar-hub/dedicated/setup.md) – what your side does: the questionnaire, the depositor account, and the secret deposit.
     * [PrivateLink to your hub](/install/lunar-hub/dedicated/privatelink-inbound.md) – the recommended way for your CI and browsers to reach the install, where your CI runs in a network you control.
     * [PrivateLink to your systems](/install/lunar-hub/dedicated/privatelink-outbound.md) – only if Lunar's collectors must reach systems that aren't on the public internet. Longest lead time in onboarding, so start it first.
3. **Git platform** – the credential the Hub reads repositories and posts results with. The Hub will not start without one, so create it before you finish the install above: before `helm install` when self-hosted, or before kickoff on Dedicated.
   * [GitHub](/install/git-platforms/github.md) for a GitHub App on your org, or [GitLab](/install/git-platforms/gitlab.md) for a group access token per top-level group.
   * [Git Platforms](/install/git-platforms.md) – what differs between the two, if you are choosing or running both.
4. **CI integration** – how Lunar gets build-time data, via the [Lunar CI Tracer](/install/ci-tracer.md). This step depends on your CI:
   * **GitHub Actions** – install the tracer on [self-hosted runners](/install/ci-tracer/github-actions-self-hosted.md), or use the [action](/install/ci-tracer/github-actions-managed.md) on GitHub-hosted ones.
   * **Buildkite** – an agent hook plus a webhook; see [Buildkite](/install/ci-tracer/buildkite.md).
   * **GitLab CI** – nothing to install; tracing support is [coming soon](/install/ci-tracer/gitlab-ci.md). Lunar collects from source events instead — see [GitLab](/install/git-platforms/gitlab.md).
5. **Sync Config** – strongly recommended. Push your config repo to Lunar Hub on every push, via the GitHub Action or a GitLab CI job, so the Hub's copy of your configuration never drifts from what's in git.
   * [Set up config sync](/install/lunar-hub/self-hosted/sync-config.md)

Optional:

* [AI Skills](/install/skills.md) – agent skills for building collectors and policies.

Want to try Lunar without installing anything? Get in touch for a guided demo or preview.

<a href="https://earthly.dev/earthly-lunar/demo" class="button primary" data-icon="calendar">Request a demo</a>

Before diving in, browse the [200+ pre-built guardrails](https://earthly.dev/lunar/guardrails/) and [60+ integrations](https://earthly.dev/lunar/integrations/) available out of the box.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs-lunar.earthly.dev/install.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
