2. Cerebro Server Components Installer¶
Cerebro server components installer allows you to automatically install or update all the server components that are required for Cerebro to function properly.
The following installation options are supported:
- STUDIO – the file storage service and the Cerebro network client will be installed.
- FACTORY – database services, the file storage service and the Cerebro network client will be installed.
Windows, Linux and Mas OS X are supported.
Setup.cmd allows you to run the installer in Windows. Setup.sh is a command to run the installer in Linux and Mac OS X.
The installation files are universal, so they are suitable for both initial installation and upgrade. You can choose the installation option after the installer starts.
2.1. Getting Ready for Installation¶
If your target server does not have access to the Internet, you need to pre-download the installation packages and save them in the Downloads directory. If an Internet connection is available, then no additional actions are required.
The following installation packages are required:
- cerebro-all-in-one.zip is the Cerebro client for all operating systems (https://cerebrohq. com/distribs/cerebro-all-in-one.zip)
- PostgreSQL 9.3 is the PostgreSQL. database. Please select an installation package for your operating system (ftp://cerebrohq.com/cerebro.distrib/postgres/)
- For Windows only: Visual C++ for Visual Studio 2013 installation packages. Please select an installation package for your operating system (ftp://cerebrohq.com/cerebro. distrib/vcredist/)
Connect to FTP using the following account:
- Username: files
- Password: cerber
If you want to save files on a third-party server (for example, a network storage or a file server), you need to create a directory in the file storage and share it using the tools of the OS on your server before running the installer. You should grant the read-only access to this directory to all users on your network. In addition, in this case, you must run the service on behalf of a user who has write permissions for this directory. Create such a user or use an existing one. The installer will ask you to specify the Username and Password for this user.
The FACTORY installation option has the following features:
- If you want to perform an update, you need to disconnect all active Cerebro users from the database beforehand using your OS or PostgreSQL. You cannot update a database with active users connected to it.
- An update is only possible for PostgreSQL 9.3. If you need to update from an older version of PostgreSQL, you need to do this manually or contact technical support.
- To make the database accessible from outside your local network, you will need an external static IP address. The installer will ask you to specify an external IP address during the installation. Also, you will need to perform TCP port forwarding on your router or proxy server (see the “After Installation” section).
- Your own mailbox will be used to send notifications. You need to create a mailbox for Cerebro newsletters (for example, firstname.lastname@example.org). During installation, the installer will request the following data: SMTP URL, SMTP port, POP URL, Username and Password, user email, and administrator email for sending error messages.
The installation must be launched on behalf of a user who holds administrative rights. If the installer detects previously installed a Memoria database or file storage service, it will perform an update. Database and configuration files will be backed up.
2.2.1. Studio Installation Option¶
This installation option includes the following items:
Choose setup language – here you should select the language for the installer. The installer supports Russian and English languages.
Choose installation option – FACTORY and STUDIO installation options are supported.
The root directory for installing Cerebro – the Cargador service will be installed in this directory. This directory will also contain log files.
Shared client directory – enter “y” to specify the network directory of the Cerebro client for all operating systems.
Samba is missing. Do you want to try installing Samba (only for Linux OS) – Samba is used to share resources (Cerebro client and storage files). Type “y” to install Samba.
Path to the directory that will be shared by Cerebro clients. In most cases, the file storage and network client directories are located side by side for user convenience. You need to select a shared directory to install the Cerebro network client for all operating systems. All users will have read-only access to this directory.
Location of Cargador file storage. The possible options are as follows: (L) Local – HDD, RAID; (N) Network – NAS, remote file server. Locally – the storage will be located on the server where the software is installed. Network – the storage will be located on a remote server (network storage or a separate file server).
Cargador Network path – it is recommended that you always specify network paths according to Windows UNC notation (i.e. \servershare…).
Local Path (by default this is a directory that is accessible to clients + “\files”) and Cargador Network Path must point to the same directory (for example, Local Path: “C:\cerebro\cerebro. files\files”, Nework Path: “\server\cerebro.files\files “).
In most cases, you can use the following setting for a local installation: “<auto>”.
Using this approach:
Windows clients gain access directly through the UNC path.
Linux users should place the network resource in the following directory: \server\share.. (this means the path will be the same as UNC).
MAC users will use a special built-in mechanism to gain access through \Volumes\share.. (an SMB connection is required).
You must ensure a reliable mechanism for recognizing the <server> network name
Cargador service user. (For Windows only) – the Cargador service will be launched on behalf of this user.
If you selected the Local installation option, you can select the Local System user (by default). This user has all the necessary access privileges.
If you selected the Network installation option, you need to specify a user who has write permissions for the Cargador Network Directory.
For Linux and Mac OS X, a Cargador user will be created automatically. If you selected the Network installation option, you need to ensure that the Cargador user has write permissions for the Cargador Network Directory.
2.2.2. Factory Installation Option¶
This option includes all items of the STUDIO installation option, as well as the following additional items:
- PostgreSQL installation path – PostgreSQL 9.3 database will be installed to this directory.
- PostgreSQL data directory path – database files and configuration files will be located in this directory.
- PostgreSQL port is a network port that will be used to connect to the PostgreSQL database.
- PostgreSQL administrator username is a PostgreSQL user name that will be created and will become the database administrator.
- PostgreSQL administrator password is the PostgreSQL administrator password.
- Name of your universe – please specify the name of your universe in Cerebro (for example, “MyCompany”). It is recommended that the given name coincide with the name of the universe specified upon registration at http://cerebrohq.com.
- Description of your universe – please provide a description of your universe in Cerebro (for example, “My Company’s Universe”).
- Local IP address or DNS name – this is the local DNS name or IP address of the server, on which the software is installed.
- External IP address or DNS name – please specify your external static IP address or DNS name.
- Storage name – this name will be used to register the Cerebro file storage in the database.
- Configure the Mailer – Cerebro Mailer is used to send notifications by email. Type “y” if you want to configure the Mailer.
- <Mail from> in notifications from Cerebro – users will see this string in the names of incoming notifications. Use the following format: “Cerebro <email@example.com>”
- SMTP to send Cerebro notifications is an SMTP server address that is used to send notifications.
- SMTP port is the port that is used by the SMTP server. The default values are as follows: 25 (regular) and 465 (SSL). Port 587 should be used for Exchange.
- Username, if SMTP authorization is needed is the username for the SMTP server. Leave this field blank if authorization is not needed.
- SMTP user password – please specify an SMTP user password.
- TLS stands for the TLS security protocol that is used for Google SMTP.
- Mailer log file is the path to the Mailer log file.
- Administrator email – diagnostic and error messages will be sent to this address.
- Replier – Replier is used to send messages to Cerebro via email. Replier allows users to respond to email notifications; responses are posted to Cerebro. Type “y” to configure Replier.
- Email for Replier – this email address will be used to reply to messages. Please use a format like “Cerebro reply <firstname.lastname@example.org>”.
- POP server for Replier – this POP server address will be used to receive messages in Cerebro.
- Use SSL for Replier – type “T” if you want to use SSL.
- Username for POP authorization is the username for the POP server.
2.3. Possible Errors¶
- Administrative rights are required. Please run the console as administrator – the installation must be performed on behalf of a user who holds administrative rights. Run the console as an OS administrator.
- ERROR: Unable to decode stdout to Unicode. Verify that the console code page is properly configured. (Windows only) – the console uses wrong encoding. Set the correct encoding in the console.
- Error downloading Visual Studio Redistributable 2013! (Windows only); Error downloading the client!; Error downloading PostgreSQL! – these errors are most likely caused by a missing Internet connection. You can download the installation packages for the OS of the server on which the software is installed. Downloaded files should be copied to the Downloads directory (see the “Getting Ready for Installation” section).
- Error installing PostgreSQL! – an error occurred while installing PostgreSQL. Try installing PostgreSQL yourself. You can download PostgreSQL for your OS from ftp://cerebrohq.com/cerebro.distrib/postgres/
- Attention! This path is not available – the specified path was not found. The directory may have been deleted or moved. Make sure that the specified directory exists.
- Attention! The directory is not writable – the current access privileges do not allow writing to the directory. Verify the configured access privileges.
- Attention! The directory is not readable – the directory is corrupted. Verify the contents of the directory.
- No SMTP connection – no connection is possible to the SMTP server. Check your Internet connection, as well as the address and port of the SMTP server.
- No POP connection – no connection is possible to the POP server. Check your Internet connection, as well as the address and port of the POP server.
- File does not exist – the specified file was not found. Verify the path to the file.
- “chkconfig” “insserv” “update-rc.d” are not available – the utility for managing services cannot be determined. This message in most cases indicates that you are trying to install on an unsupported version of the OS.
- Value may not be empty – this is a mandatory field; please enter a non-empty value.
- Please enter a valid value (one Latin letter) – the combination you entered is not supported. Please enter a valid value (there must be one Latin letter).
- Unsupported platform – the OS you are trying to use to install Cerebro services is not supported.
- The system utility terminated with an error – see the description of the error of the system utility.
- … failed to share the directory; you can try to share the directory later. Please check main.conf! – the directory could not be shared. You can do this later yourself using the tools of your OS. Check the main.conf file which should contain a valid network directory.
- Samba configuration script search failed – the Samba configuration file could not be found. You can share the directory later yourself using the tools of your OS. Check the main.conf file which should contain a valid network directory.
- FAILED! Restoring the previously saved config – a valid configuration file could not be created and the original file was saved. You can share the directory later yourself using the tools of your OS. Check the main.conf file which should contain a valid network directory.
- Cargador service test FAILED – the Cargador service could not be started correctly. Check the log file for errors.
- Admin account was not found – admin is required to register a new or update the current file storage in the Cerebro database. This user may have been deleted or renamed. The storage will not be registered automatically. You can do this later through the Cerebro client interface.
- Universe ID was not found – universe ID is required to register a new or update the current file storage in the Cerebro database. The storage will not be registered automatically. You can do this later through the Cerebro client interface.
- Error copying Malosol – the Malosol plugin could not be copied. Make sure that the source and destination directories exist. This error may also be a result of you trying to install on an unsupported OS.
- Error configuring config.py – config.py could not be configured. Make sure that the directory is writable. This error may also be a result of you trying to install on an unsupported OS.
- PostgreSQL not found – PostgreSQL could not be found. Download the PostgreSQL installer for your OS and copy it to the Downloads directory.
- ERROR: Restarting PostgreSQL failed – PostgreSQL could not be restarted. Make sure that the user on whose behalf you are trying to install holds the rights to restart the service.
- Wrong PostgreSQL version detected – PostgreSQL 9.3 is required. Delete the current version of PostgreSQL and restart the installation.
- Error: Automatic configuration of Postgres failed – the automatic configuration of PostgreSQL could not be completed. You will have to configure it manually.
- ERROR: Database installation failed – the automatic installation of the database could not be completed. You will have to install it manually.
2.4. After Installation¶
To make Cerebro accessible from outside your local network, for the STUDIO installation option you need to configure port forwarding on your router or proxy server to transfer data from external TCP ports 45431 and 4080 to the server where the Cargador service is installed inside your network. If you selected the FACTORY installation option, you should also configure forwarding for the database port (5432 is the default port).
If the installer could not obtain the ID of the universe automatically, contact technical support and request the ID of your universe. After receiving the ID, you can register it using the following scripts from the package: setid.cmd (Windows) or setid.sh (Linux and Mac OS X). A correctly specified ID of the universe subsequently guarantees proper migration and merging of universes, as well as, if necessary, proper migration of the database to the cloud.