> For the complete documentation index, see [llms.txt](https://docs.hex-rays.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hex-rays.com/ida-9.5/add-ons/lumina/admin/lumina-server/lumina-server-checklist.md). # Installation Checklist ## New Lumina server * [ ] Create the Lumina server in the portal. See: [Add servers](/ida-9.5/getting-started/licensing.md#add-servers) ## Download the required files * [ ] Have the **Lumina server license** and **certificate bundle** issued for this deployment ready. * [ ] In the [Download Center](https://my.hex-rays.com/dashboard/download-center), select the appropriate release channel, open **ida-lumina-server**, choose the release, and download the Linux x64 or arm64 archive. Download **IDA Pro** separately if needed. ## Choose the storage backend * [ ] **Embedded database (default).** Nothing to prepare — skip to the next section. * [ ] **MariaDB**, for a multi-user or production deployment: create the database and a user for it, and have the host, port, user and password ready for setup. ## Choose how IDA users authenticate Decide now: the choice is recorded in the database at setup time and cannot be changed later without starting from an empty one. Most deployments use Lumina setup; choose Teams setup only if you already run a Hex-Rays Vault (Teams) server. * [ ] **Lumina setup (default)** — the Lumina server manages user authentication. * [ ] **Teams setup** — only if you already run a Vault (Teams) server. The Teams server manages user authentication; have its host and port ready. Note that the **Git backend is now the recommended option for Teams**, and it needs no dedicated Vault server — a Git-based team uses Lumina setup above. The legacy Vault backend is planned for deprecation; see [Migrating from Vault to Git](/ida-9.5/add-ons/teams/how-tos/migrating-from-vault-to-git.md). ## Installation * [ ] Unzip the download. It contains one folder with the server, the admin client and a README. * [ ] Decide how it will run, because it decides where the folder goes: * to try it out or run it yourself, anywhere will do; * for a system service that starts at boot, put it where the service account can read it. ``` >sudo mv lumina-- /opt/lumina-server >cd /opt/lumina-server ``` * [ ] Run setup, giving it the two files you downloaded. ### Lumina setup ``` >sudo ./lumina-server setup --defaults \ --cert-bundle .zip \ --license .hexlic ``` ### Teams setup ``` >sudo ./lumina-server setup --defaults --no-service \ --db sqlite --auth-mode vault \ --vault-host :65433 \ --cert-bundle .zip \ --license .hexlic ``` * [ ] For a Teams setup, approve the vault's certificate — after checking the fingerprint against the vault itself — then register and start the service: ``` >sudo ./lumina-server vault-trust >sudo ./lumina-server service register ``` * [ ] **Save the administrator password from the closing summary.** It is shown once and never written to a log. If it is lost: `./lumina-server admin reset-password`. ## Testing and starting the server * [ ] Check the server is up: ``` # installed as a service >sudo ./lumina-server service status # running it yourself >./lumina-server start ``` * [ ] Check it answers on the admin port (8080 unless you changed it): ``` >curl http://:8080/api/health ``` * [ ] Check it answers a client on the Lumina port (7443 by default): ``` >./lumina-client -h :7443 -u info ``` In case of startup problems, check the [troubleshooting](/ida-9.5/add-ons/lumina/admin/lumina-server.md#troubleshooting) section. ## Creating the users * [ ] Sign in to the administration console at `http://:8080/admin` with the account setup created. * [ ] **Lumina setup:** add one account per analyst, on the console's Users page or with `./lumina-server admin create --username --no-admin`. Nothing registers itself over the network. * [ ] **Teams setup:** nothing to do — an account works here as soon as it works in Teams. {% hint style="info" %} The first user to log in no longer becomes the administrator: `setup` creates that account and prints its password once. {% endhint %} ## Connecting IDA * [ ] Configure the Lumina server host, port and user name in IDA's Lumina options. * [ ] Load a binary and confirm the connection in the server log (`./lumina-server service logs`). --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.hex-rays.com/ida-9.5/add-ons/lumina/admin/lumina-server/lumina-server-checklist.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.