-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
7 changed files
with
70 additions
and
21 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...mise setup/post-installation-checklist.md → ...mise-setup/post-installation-checklist.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 28 additions & 6 deletions
34
...es/docs/on-premise setup/prerequisites.md → ...es/docs/on-premise-setup/prerequisites.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,49 @@ | ||
--- | ||
title: "On-premise setup prerequisites" | ||
title: "On-Premise Setup Prerequisites" | ||
order: 26.1 | ||
page_id: "On-premise setup prerequisites" | ||
metadesc: "This detailed guide will help you understand the prerequisites for Testsigma On-premise setup | Know these details before installing Testsigma On-premise setup" | ||
noindex: false | ||
search_keyword: "" | ||
warning: false | ||
contextual_links: | ||
- type: section | ||
name: "Contents" | ||
- type: link | ||
name: "Software, Hardware, and other Requirements" | ||
url: "#software-hardware-and-other-requirements" | ||
--- | ||
|
||
--- | ||
|
||
<br> | ||
|
||
This article outlines the essential steps and requirements for a successful on-premise setup. Understanding these prerequisites before installing the software is important to ensure a smooth installation process. So, follow the recommendations and requirements given in this document to avoid any issues during the installation process. | ||
|
||
|
||
--- | ||
|
||
|
||
|
||
## **Software, Hardware, and other Requirements** | ||
|
||
|
||
|**Requirements**|**Details**| | ||
|---|---| | ||
|**Server Configuration**|<li> OS: Ubuntu(22.04 LTS) or higher<br> <li> CPU: 24 core<br> <li> RAM: 64 GB<br> <li> DISK: 1 TB - 2 TB (Depending on usage)| | ||
|**Software Requirements**|<li> Internet connectivity on server<br> <li>Docker installation capability on server<br> <li>Root privileges on server<br> <li>Permissions to install/Start the following libraries/executables on customer employee machines:<br> - Java/JVM<br> - Appium <br> - ADB from android<br> - Ability to run xcrun on mac os machines<br> - Ability to run xattr on mac os machines| | ||
|**Network Requirements**|Allow incoming connections from outside to server <br> *.sengrid.com <br> *.messagebird.com <br> *.twilio.com| | ||
|**Server Configuration**|<li> **OS**: Ubuntu (22.04 LTS) or higher<br> <li> **CPU**: 24 core<br> <li> **RAM**: 64 GB<br> <li> **DISK**: 1 TB - 2 TB (Depending on usage)| | ||
|**Software Requirements**|<li> Internet connectivity on server<br> <li>Docker installation capability on server<br> <li>Root privileges on server<br> <li>Permissions to install/Start the following libraries/executables on customer employee machines:<br> - Java/JVM<br> - Appium <br> - ADB from android<br> - Ability to run xcrun on mac os machines<br> - Ability to run xattr on mac os machines| | ||
|**Machine Configuration**|<li> It is recommended to install Ubuntu at the root with a 256GB machine.<br> <li> Additionally, it is advised to mount a 2TB and above (based on the usage) hard disk for storage.<br> <li> All required software will be installed at the root, and storage configurations will be set to utilize the mounted disk.| | ||
|**Network Requirements**| <li> If the firewall enabled, *.docker.com, *.amazon.com, *.amazonaws.com, *.maven.org, these should be whitelisted.<br> <li> If they wanted to use the Testsigma mail service, *.sendgrid.com needs to be whitelisted. | | ||
|**Database Requirements**|<li>MySQL database would be installed by default.<br> <li> The user must use only MySQL version 5.7<br> <li> If the customer is going to use a MySQL installation, then we need to install the following commands to setup DB: <br> <br>*CREATE DATABASE IF NOT EXISTS tstmp;* <br>*CREATE DATABASE IF NOT EXISTS identity;* <br> *CREATE DATABASE IF NOT EXISTS master;* <br> *CREATE DATABASE IF NOT EXISTS tenant1;* <br> *CREATE DATABASE IF NOT EXISTS kibbutz;* <br> <br>*SET session sql_mode='STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION';* <br> <br> *SET global sql_mode='STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION';*<br> <br> <li>For cloud databases like AWS RDS if the setting of sql_mode is not allowed the provider-specific option can be used like AWS RDS parameter groups. <br> <li> For external databases we would be encouraged to have disk space of 512GB - 1TB depending on customer usage.| | ||
|**Backup information**|Customers would be responsible for taking backup of the Database.| | ||
|**SMTP Requirements**|Customers need to produce their SMTP settings in case they desire to use their internal SMTP instead of Testsigma SMTP servers.| | ||
|**Additional Requirements**|<li> Depending on user preference, the agent can run on Linux, Windows, or Mac machines.<br> <li> The final storage location for screenshots, apps, and other permanent files is the host server where Testsigma containers run.<br> <li> Temporary files like screenshots may need periodic cleaning depending on usage and disk space availability.<br> <li> The server operation does not require any Windows machines.<br> <li> Customer IT teams must regularly perform data backups through regular disk or specific data folder backups.<br> <li> Testsigma On-Prem Server is not a hypervisor-based installation.<br> <li> By default, the customer would be provided URLs ending with testsigmaprivate.com (like https://cutomername.testsigmaprivate.com)<br> <li> If the customer desires to have these pointed to their domain name (like customername.com), then we need the following:<br> - Inform Testsigma before the Onprem build is generated.<br> - Get the SSL certificates of the domain in interest and copy them to the server where installation would happen.<br> <li>For installing Testsigma Recorder on chrome browsers,<br> - We need the ability to enable developer mode.<br> - We need the ability to install the Testsigma recorder in unpacked mode.| | ||
|**Additional Checks**| <li> Check the internet connection to the server machine.<br> <li> Please unblock the ports if blocked. Ports: 3306, 7010, 8080, 8082, 8084, 9090, 9095, 9096, 9097, 4200, 4201, 4203, 4210, 4211, 4220, 4230.| | ||
|
||
[[info | **NOTE**:]] | ||
|Admin access is necessary for On-Prem installation. | ||
| - Testsigma will provide a MySQL docker container; if you want to use the hosted MySQL, please acquire one with the above specification. | ||
| - It is recommended to have a scheduled image backup. | ||
| - Admin access is necessary for On-Prem installation. | ||
|
||
|
||
|
||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.