Before you proceed with the installation, review the system requirements.
Operating Systems and Platform Support
The following table lists the supported operating systems and the versions.
18.04, 20.04, 22.04
Amazon Linux 2023, Amazon Linux 2
CentOS 8.x Support
CentOS 8.x reached its end-of-life in December 2021. CentOS 8.x support for JFrog products has been deprecated by the end of June 2022.
The following table lists the supported platforms.
Installation on Kubernetes environments is through Helm Charts. Supported Helm version is Helm 3+.
From version 7.41.4, Artifactory supports installation on ARM64 architecture through Helm and Docker installations. You must set up an external database as the Artifactory database since Artifactory does not support the bundled database with the ARM64 installation. Artifactory installation pulls the ARM64 image automatically when you run the Helm or Docker installation on the ARM64 platform.
ARM64 support is also available for Xray, Distribution, and Insight. ARM64 support is not available for Pipelines.
Database and Third-Party Applications in Insight
A database is required, which is fundamental to management of Insight and is also used to store cluster wide configuration files. Currently PostgreSQL is supported, and any change to configuration requires restarting all Insight nodes for changes to take effect.
Insight supports the following versions of PostgreSQL.
An Elasticsearch database is required to store the data from which Insight generates trends and charts.
Insight supports the following versions of Elasticsearch.
7.17.1 (for Insight 1.11.3 and later)
7.16.2 (for Insight 1.5.0 to 1.10.2)
7.15.1 (for Insight 1.2.3 to 1.30)
7.14.1 (for Insight 1.0.1 to 1.1.3)
Insight Network Ports
Insight uses the 8082 port by default for external communication.
Insight uses the following internal ports by default for communication with JFrog Platform microservices.
8080 for the Insight Server
8082, 8046, 8047, and 8049 for the Router
8087 for Insights
5432 for PostgreSQL (if you use the bundled Postgres database)
9200 for Elasticsearch (if you use the bundled Elasticsearch)
In addition, review the Helm Chart requirements.
Deploying Artifactory for Small, Medium or Large Installations
In the chart directory, includes three values files, one for each installation type - small/medium/large. These values files are recommendations for setting resources requests and limits for your installation. You can find the files in the corresponding chart directory:
Complete the following steps to install the product.
Add the https://charts.jfrog.io to your Helm client.
helm repo add jfrog https://charts.jfrog.io
Update the repository.
helm repo update
Initiate installation by providing a join key and JFrog url as a parameter to the Insight chart installation.
helm upgrade --install insight --set insightServer.joinKey=<YOUR_PREVIOUSLY_RETRIEVED_JOIN_KEY> \ --set insightServer.jfrogUrl=<YOUR_PREVIOUSLY_RETRIEVED_BASE_URL> --namespace insight jfrog/insight
Alternatively, you can manually create a secret containing the join key and then pass it to the template during install/upgrade. The key must be named join-key.
kubectl create secret generic my-secret --from-literal=join-key=<YOUR_PREVIOUSLY_RETIREVED_JOIN_KEY> # Pass the created secret to helm helm upgrade --install insight --set insightServer.joinKeySecretName=my-secret --namespace insight jfrog/insight
In either case, make sure to pass the same join key on all future calls to
helm upgrade! This means always passing
--set insightServer.joinKey=<YOUR_PREVIOUSLY_RETRIEVED_JOIN_KEY>. In the second, this means always passing
--set insightServer.joinKeySecretName=my-secretand ensuring the contents of the secret remain unchanged.
Customize the product configuration (optional) including database, Java Opts, and filestore.
Unlike other installations, Helm Chart configurations are made to the
values.yamland are then applied to the
Follow these steps to apply the configuration changes.
Make the changes to
Run the command.
helm upgrade --
insight --namespace insight -f values.yaml
Restart Insight to apply the changes.
Access Insight from your browser at:
Go to theDashboard tab in theApplicationmodule in the UI.
Check the status of your deployed Helm releases.
After installing and before running Insight, you may set the following configurations.
Where to find the system configurations?
You can configure all your system settings using the
system.yaml file located in the
$JFROG_HOME/insight/var/etc folder. For more information, see Insight YAML Configuration.
If you don't have a System YAML file in your folder, copy the template available in the folder and name it
For the Helm charts, the
system.yaml file is managed in the chart’s
Artifactory Connection Details
Insight requires a working Artifactory server and a suitable license. The Insight connection to Artifactory requires 2 parameters:
jfrogUrl - URL to the machine where JFrog Artifactory is deployed, or the load balancer pointing to it. We recommend that you use DNS names rather than direct IPs. For example,
Set it in the Shared Configurations section of the
join.key - This is the "secret" key required by Artifactory for registering and authenticating the Insight server.
You can fetch the Artifactory
joinKey(join Key) from the JPD UI in the Administration module | User Management | Settings | Join Key.
join.keyused by your Artifactory server in the Shared Configurations section of the
Change PostgreSQL Database Credentials
Insight comes bundled with a PostgreSQL Database out-of-the-box, which comes pre-configured with default credentials.
These commands are indicative and assume some familiarity with PostgreSQL. Do not copy and paste them. For docker-compose, you need to ssh into the PostgreSQL container before you run them.
To change the default credentials:
# Access PostgreSQL as the insight user adding the optional -W flag to invoke the password prompt $ psql -d insight -U insight -W # Securely change the password for user "mission_control". Enter and then retype the password at the prompt. \password insight # Verify the update was successful by logging in with the new credentials $ psql -d insight -U insight -W
Change Elasticsearch Credentials
Search Guard tool is used to manage authentication. To change password for the default user, Search Guard accepts a hash password to be provided in the configuration.
Obtain the username used to access Elasticsearch from $JFROG_HOME/insight/var/etc/system.yaml available at
Generate the hash password by providing the password(in text format) as input
$ELASTICSEARCH_HOME/plugins/search-guard-<major_version_number>/tools/hash.sh -p <password_in_text_format>
Update the configuration of the default user with the output from the previous step.
vi $ELASTICSEARCH_HOME/plugins/search-guard-<major_version_number>/sgconfig/sg_internal_users.yml #Scroll in the file to find an entry for the username of the default user #Update the value for "hash" with the hash content obtained from previous step <default_username>: hash: <hash_output_from_previous_step>
Run the command to initialise Search Guard.
Add certificates to connect to external Elasticsearch over SSL
To use an external Elasticsearch over an SSL connection, you must copy the certificate files to the trusted folder in the Insight installation (
$JFROG_HOME/insight/var/etc/security/keys/trusted) and restart Insight services.
Set your PostgreSQL and Elasticsearch connection details in the Shared Configurations section of the
Load a custom certificate to Elasticsearch Search Guard
If you prefer to use the custom certificates when Search Guard enabled with tls in Elasticsearch, you can use the
search-guard-tlstool to generate Search Guard certificates.
The tool to generate Search Guard certificates is available at
$JFROG_HOME/app/third-party/elasticsearch/search-guard-tlstool-1.6.tar.gz. For more information about generating certificates, see Search Guard TLS Tool.
Run the tool to generate the certificates.
tar -xvf $JFROG_HOME/app/third-party/elasticsearch/search-guard-tlstool-1.6.tar.gz cp $JFROG_HOME/app/third-party/elasticsearch/config/tlsconfig.yml $JFROG_HOME/app/third-party/elasticsearch/search-guard-tlstool-1.8/config cd $JFROG_HOME/app/third-party/elasticsearch/search-guard-tlstool-1.8/tools ./sgtlstool.sh -c ../config/tlsconfig.yml -ca -crt # folder named "out" will be created with all the required certificates, cd out
Copy the generated certificates (
sgadmin.pem) to the target location based on the installer type.
cp localhost.key localhost.pem root-ca.pem sgadmin.key sgadmin.pem /etc/elasticsearch/certs/
Configure a custom Elasticsearch role
The Search Guard tool is used to manage authentication. By default, an admin user is required to authenticate Elasticsearch. As an alternative to this, you can configure a new user to authenticate Elasticsearch by assigning a custom role with permissions for the application to work.
Add the following snippet to define a new role with custom permissions in
<role_name>: cluster_permissions: - cluster:monitor/health - cluster:monitor/main - cluster:monitor/state - "indices:admin/template/get" - "indices:admin/template/delete" - "indices:admin/template/put" - "indices:admin/aliases" - "indices:admin/create" index_permissions: - index_patterns: - "active_*" allowed_actions: - "indices:monitor/health" - "indices:monitor/stats" - "indices:monitor/settings/get" - "indices:admin/aliases/get" - "indices:admin/get" - "indices:admin/aliases" - "indices:admin/create" - "indices:admin/delete" - "indices:admin/rollover" - SGS_CRUD
Add the following snippet to add a new user in
<user_name>: hash: <Hash_password> backend_roles: - "<role_name>" //role_name defined in previous step description: "<description>"
Run the following command to generate a hash password.
$ELASTICSEARCH_HOME/plugins/search-guard-<major_version_number>/tools/hash.sh -p <clear_text_password>
Add the following snippet to map the new username to the role defined in the previous step in
<role_name>: users: - "<user_name>"
Initialize Search Guard to upload the changes made in the configuration.
Set the new credentials in
shared: elasticsearch: username: <user_name> password: <clear_text_password>
Restart Insight services.