ft_install_singlebox_tenant - Fluid Topics - 3.1

Fluid Topics Installation and Administration Guide

Product
Fluid Topics
FT_Version
3.1
Platform
RHEL
Category
Reference Guide
language
English

The ft_install_singlebox_tenant script is used to fully install Fluid Topics on a single server (Single Server Tenant Setup).

This command performs the following actions:

  • Declare company into the Back Office
  • Send the required PaF configuration files into the Back Office
  • Send the required Front-End configuration files into the Back Office
  • Declare PaF environment in /usr/local/afs7/PaF
  • Declare reply environment in /usr/local/afs7/reply
  • Initialize the MongoDB database
  • Etc.

This script must be run as a non-root user.

Command template:

ft_install_singlebox_tenant -s $SERVICE_ID -S $SERVICE_STATUS [-u $TENANT_URL] [-cie $COMPANY_NAME] [-H $BACK_OFFICE_HOSTNAME] [-https] [--port $WEBSERVER_PORT] [--ws-login WS_LOGIN] [--ws-password [WS_PASSWORD]] [--api-key API_KEY] [-v] [-h]

Command example:

ft_install_singlebox_tenant -s 8 -S stable -u https://myFluidTopics.com -H Fluid_BackOffice --ws-login mylogin --ws-password mypassword --company mycompany

Command arguments:

  • -s: Expects the service ID used to identify the tenant. Can also be written --service.
  • -S: Expects the service status used to identify the tenant among the following list:
    • stable
    • rc
    • beta
    • alpha
    • sandbox
    • archive
  • -u: Expects the full URL of the Fluid Topics tenant. Can also be written --url.
  • -H: Expects the hostname of the Back Office server ("localhost" by default if the command is run on the server hosting the Back Office environment). Can also be written --host.
  • --ws-login: Expects the login of the user authorized to launch the web service (by default, "antidot").
  • --ws-password: Expects the password of the user authorized to launch the web service (by default, it is the default password of the "antidot" Back Office user).
  • -cie: Expects the name of the company (by default, the host company). Can also be written --company.
  • -https: Enables the use of HTTPS protocol. Can also be written --secure.
  • --port: Expects the port number used to access the Back Office server.
  • --api-key: Expects the API key of the Back Office user.
  • -h: Displays the help and lists all available optional arguments for the command. Can also be written --help.

  • -v: Activates the verbose mode. Can also be written --verbose.

The script is available in the antidot-fluidtopics-reply package.