Insight Installation For Advanced Users

JFrog Installation & Setup Documentation
Content Type
Installation & Setup
ft:sourceType
Paligo
Manual Docker Compose Installation

TO: Docker Requirements. (reuse_006) System Requirements

  1. Extract the contents of the compressed archive and go to the extracted folder.

    .env file included within the Docker-Compose archive

    This .env file is used by docker-compose and is updated during installations and upgrades.

    Notice that some operating systems do not display dot files by default. If you've made any changes to the file, remember to backup before an upgrade.

  2. Create the following folder structure under $JFROG_HOME/insight.

  3. Provide folder permissions to the folders as follows.

  4. Copy the appropriate docker-compose templates from the templates folder to the extracted folder. Rename it asdocker-compose.yaml.

    NOTE: The commands below assume you are using the template: docker-compose-postgres-es.yaml

    Requirement

    Template

    Insight with externalised databases

    docker-compose.yaml

    Insight with Elasticsearch and PostgreSQL

    docker-compose-postgres-es.yaml

    Docker for Mac

    When you use Docker Compose in Mac, /etc/localtime might not work as expected since it might not be a shared location in the docker-for-mac settings.

    You can remove the following line from the selected docker-compose.yaml file to avoid installation issues.

  5. Update the .env file

  6. Customize the product configuration.

    1. Set the Artifactory connection details.

    2. Customize the PostgreSQL Database connection details. (optional)

    3. Set any additional configurations (for example: ports, node id) using the Insight system.yaml configuration file.

      Note

      Verify that the host's ID and IP are added to the system.yaml. This is important to ensure that other products and Platform Deployments can reach this instance.

  7. For Elasticsearch to work correctly, increase the map count. For additional information, see Elasticsearch documentation.

  8. Create the necessary tables and users using the script: "createPostgresUsers.sh".

    • Start the PostgreSQL container.

  9. Start Insight using docker-compose commands.

  10. Access Insight from your browser at: http://SERVER_HOSTNAME/ui/. For example, on your local machine: http://localhost/ui/.

  11. Check the Insight log.

    Configuring the Log Rotation of the Console Log

    The console.log file can grow quickly since all services write to it. The installation scripts add a cron job to log rotate the console.log file every hour.

    This is not done for manual Docker Compose installations. Learn more on how to configure the log rotation.Logging