Deployment
Assuming that requirements from the Introduction and Prepare your project sections are satisfied, pull the quay.io/jetbrains/qodana-installer-cli:latest Docker image. All commands running this image require the /var/run/docker.sock Docker socket file for communicating with the Docker engine and Docker Swarm.
Basic use case
Follow the steps below for installing Qodana Self-Hosted on your machine:
On your local Linux machine, configure the
/etc/hostsfile as shown below:# Added for Qodana Self-Hosted Lite Version 127.0.0.1 qodana.local 127.0.0.1 files.qodana.local 127.0.0.1 api.qodana.local 127.0.0.1 ingress.qodana.local 127.0.0.1 login.qodana.local 127.0.0.1 lintersapi.qodana.localOn your local machine, run the following Docker command:
docker run \ -v /var/run/docker.sock:/var/run/docker.sock \ -e API_ORGANIZATION_NAME="<Specify the name of your organization>" \ -e COMMON_LICENSE_KEY_SECRET="<Specify a valid license key>" \ quay.io/jetbrains/qodana-installer-cli:latest \ install-app
In your browser, navigate to http://qodana.local to receive access to Qodana Self-Hosted.
By default, Qodana Self-Hosted comes configured with local dependencies for quick Proofs Of Concepts (PoCs) or Proofs of Value (PoV). The credentials for a built-in administrator test user are as follows:
Credential | Value |
|---|---|
Username |
|
Password |
|
You can update these credentials by navigating to the http://login.qodana.local page.
Use configuration from file
Run the following Docker command to use a configuration contained in a file:
This command uses the --env-file option to specify the path to the configuration file, in this case this is the qodana-self-hosted.env file.
Persist secrets
This command lets you export and persist secrets created during installation in the ${PWD}/secrets directory:
To make the secret idempotent, this command mounts the /app/qodana-installer/secrets directory for storing secrets.