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.
All commands are exclusive, i.e. you can only execute one command at a time.
|rips:install||Start the installation process [Installing RIPS]|
|rips:update||Pull new RIPS Docker containers and replace the old containers [Updating RIPS]|
|rips:stop||Stop RIPS Docker containers [Uninstalling RIPS]|
|rips:start||Start RIPS Docker containers|
|rips:restart||Stop and start RIPS Docker containers|
|rips:config||Modify the configuration values|
|rips:password||Change the password of RIPS users|
|rips:report||Create an archive with all log files for the customer support|
|rips:download||Download current Docker images and store them in archive|
|rips:migrate||Migrate RIPS2 to RIPS3|
|rips:status||Show status information about the RIPS Docker containers|
|rips:exec||Execute a system command in a RIPS Docker container|
|list||Show all available commands|
|help||Show help and parameters for commands|
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.
|--api-timeout||-t||600||Modify the timeout period (seconds) for requests|
|--engine-timeout||-T||14400||Modify the timeout period (seconds) for scans|
|--consumer||-C||2||Modify the amount of additional consumer containers|
|--ui-port||-p||80||Modify the user interface port|
|--api-port||-P||8080||Modify the application programming interface port|
|--ui-address||-b||0.0.0.0||Modify the bind address for the user interface|
|--api-address||-B||0.0.0.0||Modify the bind address for the application programming interface|
|--api-url||-a||:8080||Modify the URL to the application programming interface (recommended)|
|--docker-socket||-D||/var/run/docker.sock||Modify the path to the Docker socket that is used by the installer|
You can set the following environment variables for optional configuration.
Use Docker images from manually downloaded archive (see "Offline installation" in the installation example)
Use this user to authenticate
Use this password to authenticate
Use content as additional environment variables for the installer
Modify the path to custom CA certificate (PEM)
Modify the path to the Docker socket that is used by the installer
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.
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.