RIPS Installer Tool

The RIPS installer is a small Python script that helps administrators to manage their local RIPS installation. It supports command line arguments to select an action and to specify its behavior.


Commands

All commands are exclusive, i.e. you can only execute one command at a time.

CommandDescription
rips:installStart the installation process [Installing RIPS]
rips:updatePull new RIPS Docker containers and replace the old containers [Updating RIPS]
rips:stopStop RIPS Docker containers [Uninstalling RIPS]
rips:startStart RIPS Docker containers
rips:restartStop and start RIPS Docker containers
rips:configModify the configuration values
rips:passwordChange the password of RIPS users
rips:reportCreate an archive with all log files for the customer support
rips:downloadDownload current Docker images and store them in archive
rips:migrateMigrate RIPS2 to RIPS3
rips:statusShow status information about the RIPS Docker containers
rips:execExecute a system command in a RIPS Docker container
listShow all available commands
helpShow help and parameters for commands

Configuration Parameters

The RIPS configuration parameters can be specified when running rips:install or rips:migrate for the first time or in combination with rips:config. RIPS has to be restarted to load the new configuration values. Different commands have additional parameters that can be listed with help. For example, to apply configuration values directly the --restart parameter can be used in combination with rips:config.

LongShortDefaultDescription
--api-timeout-t600Modify the timeout period (seconds) for requests
--engine-timeout-T14400Modify the timeout period (seconds) for scans
--consumer-C2Modify the amount of additional consumer containers
--ui-port-p80Modify the user interface port
--api-port-P8080Modify the application programming interface port
--ui-address-b0.0.0.0Modify the bind address for the user interface
--api-address-B0.0.0.0Modify the bind address for the application programming interface
--api-url-ahttp://127.0.0.1:8080Modify the URL to the application programming interface (recommended)
--docker-socket-D/var/run/docker.sockModify the path to the Docker socket that is used by the installer

Environment

You can set the following environment variables for optional configuration.

NameDefaultDescription

RIPS_OFFLINE_IMAGES


Use Docker images from manually downloaded archive (see "Offline installation" in the installation example)

RIPS_DOWNLOAD_USER


Use this user to authenticate

RIPS_DOWNLOAD_PASSWORD


Use this password to authenticate

RIPS_ENV


Use content as additional environment variables for the installer

RIPS_CA_CERTIFICATE

/etc/docker/certs.d/docker.ripstech.com/ca.crt

Modify the path to custom CA certificate (PEM)

DOCKER_SOCKET

/var/run/docker.sock

Modify the path to the Docker socket that is used by the installer

Proxy Server

In case you are in a corporate network and can only reach the Internet through a proxy, you have to configure the Docker daemon to use said proxy. More information can be found in the official Docker documentation. Additionally, you have to specify your proxy environment variables with RIPS_ENV, for example RIPS_ENV="HTTP_PROXY=http://proxy.example.com;HTTPS_PROXY=https://proxy.example.com". Multiple variables can be separated with a semicolon.

TLS Interception

If you are intercepting TLS connections you have to place your CA certificate at /etc/docker/certs.d/docker.ripstech.com/ca.crt. The certificate has to be in PEM format.