On-Premises Private

Installing CARTO On-Premises Builder

Single Host Installation

The CARTO installer artifact can be used to setup CARTO in a fresh, installed Red Hat server or to upgrade from a previous compatible running version.

1) Unpack the tar.gz file of the Builder installer

1
tar xfz carto-builder-<version>-rhel-7-x86_64.tar.gz

Where version is the version of the file provided.

2) Initialize the configuration database and install the license

1
2
cd carto-builder-<version>-rhel-7-x86_64
sudo ./cartoctl init --license license1.lic

3) Perform the installation with sudo (or as root):

1
sudo ./cartoctl nodes install

4) If the installation was successful, you will see the message below, otherwise please check ~/carto.log looking for errors.

1
2
The installation has been successfully completed
==> Ready for mapping? Enter the URL "https://carto.lan" into your favourite browser

Pre-Configuration

CARTO installer has some default parameters that will help run all of the components correctly. However, it is recommended to review these parameters and change them before running the installer. Some of the initial configurations cannot be modified once the product is installed.

The config code below is a fragment of the default config for BUILDER stored in ~/.carto/config.yml (see Configuration options for a complete reference) and it is created after executing cartoctl init command (step number (2) in the installation instructions). Prior to execute cartoctl install, any additional configuration option can be added under the env section.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
nodes:
- hostname: node01.carto.lan
  user:
    privileges: true
    ssh_key: id_rsa
    command: /bin/sudo
  role:
  - name: postgresql
    release: ""
    installed: true
    env:
    - name: CARTO_POSTGRES_ADDRESS
      value: 127.0.0.1
    - name: CARTO_POSTGRES_BIND
      value: 127.0.0.1
    - name: CARTO_POSTGRES_PORT
      value: "5432"
    package: []
    task: []

Installation configuration option keys reference

CARTO BUILDER is highly configurable on installation time. The different sections of the documentation mention many option keys that modify the behaviour of the product. The following table contains a reference of the keys that can be found in ~/.carto/config.yml setup file and whether they’re modifiable or not.