Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migration of Open Source docs #375

Merged
merged 1 commit into from
Mar 12, 2024
Merged

Migration of Open Source docs #375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
170 changes: 170 additions & 0 deletions src/pages/docs/open-source-docs/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
---
title: "Testsigma Docker Setup"
page_title: "Testsigma Community Edition Docker Setup"
metadesc: "Learn how to set up Testsigma Server and MySQL as docker containers using Docker Compose | Easiest way to set up Testsigma on your local machines"
noindex: false
order: 28.3
page_id: "Testsigma Docker Setup"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisites"
url: "#prerequisites"
- type: link
name: "Setting up Testsigma Community Edition with Docker"
url: "#setting-up-testsigma-community-edition-with-docker"
- type: link
name: "Verifying the installation"
url: "#verifying-the-installation"
- type: link
name: "Connecting to External MySQL"
url: "#connecting-to-external-mysql"
- type: link
name: "Update to new Version(Testsigma Server)"
url: "#update-to-new-versiontestsigma-server"
- type: link
name: "Update to new Version(Testsigma Agent)"
url: "#update-to-new-versiontestsigma-agent"
- type: link
name: "Troubleshooting"
url: "#troubleshooting"
- type: link
name: "Next Steps"
url: "#next-steps"
---

---

This guide will help you setup [Testsigma Server](https://github.com/testsigmahq/testsigma) and MySQL as docker containers using **Docker Compose**. This is the easiest way to set up Testsigma on your local machines.

---

## **Prerequisites**
* [Docker](https://docs.docker.com/install/)
* [Docker Compose](https://docs.docker.com/compose/install/)

---

## **Setting up Testsigma Community Edition with Docker**

Create a folder called **Testsigma** where you would like to install Testsigma and store the logs and runtime data.

**cd** cmd into this installation folder (Testsigma)

---

## **Step 1: Download docker-compose.yml file**

Download docker-compose.yml file into the Testsigma installation folder from [here](https://github.com/testsigmahq/testsigma/tree/dev/deploy/docker). Download the appropriate file based on your OS.


[[info | NOTE:]]
| - If you are using Apple M1 machines then you should replace the testsigmahq/server image version in docker-compose.yml with the M1 docker image tag. For example if the version is v1.0.0 then you should add "-m1" and make it v1.0.0-m1. So the final image name looks like this "testsigmahq/server:v1.0.0-m1"

---

## **Step 2: Run Testsigma Server**

The following command will run Testsigma along with a MySQL database to store data.

```
$ docker-compose up -d
```
<br><br>
Check if the containers are running using the following commands


```
$docker ps

CONTAINER ID IMAGE … STATUS PORTS Names
580db1ec9ad1 testsigmahq/server:m1 … …. 443->443/tcp, 9090->9090/tcp, 9090/tcp testsigma\_server
318c46259b15 mysql:5.7 … …. 33060/tcp, 55581->3306/tcp testsigma\_mysql
```

You should see a message: “Testsigma is Running!” once the container is ready.


Your Testsigma server should be up and running now. Testsigma server will be accessible at https://local.testsigmaos.com/ui

---

## **Verifying the installation**

By default folders db\_data, ts\_data will be created in the installation folder to store the application data and MySQL data. If you want to change this folder path you can open **docker-compose.yml** and change the db\_data volume path under mysql service and ts\_data path under testsigma_server.

---

## **Connecting to External MySQL**

If you want to connect to an external/existing MySQL database, add the below environment variables

MYSQL\_HOST\_NAME = < mysql \_host\_name> where mysql\_host\_name is your database url<br>
MYSQL\_PORT = < port\_number> where mysql is running<br>
MYSQL\_DB\_NAME = < db\_name> where you want to save data<br>
MYSQL\_USER = < username><br>
MYSQL\_PASSWORD = < password><br>

---

## **Step 3: Install and configure Testsigma Agent**

When we run the Testsigma server using Docker it runs in a separate container(child process), where it cannot access the applications installed in the host machine. But in order to automate Web and Mobile Apps the Testsigma Server (running in docker) has to access Browsers and Mobile Devices connected to the host machine.

To achieve this we use Testsigma Agent that connects the Testsigma Server with the host machine to access the browsers and mobile devices connected.

### **Download and Install Testsigma Agent**

Login to https://local.testsigmaos.com/ui and follow the steps mentioned here([Setup: Windows, Mac, Linux](https://testsigma.com/docs//agent/setup-on-windows-mac-linux/)) to Install and configure the the Agent

---

## **Update to new Version(Testsigma Server)**

1. Stop the Docker images/container with name Testsigma in Docker Desktop, alternatively you can use the below commands to kill the processes<br>
&nbsp;a. `sudo su`<br>
&nbsp;b. `docker container kill $(docker ps -q)`
2. Download the latest version of docker-compose.yml file into the Testsigma installation folder from [here](https://github.com/testsigmahq/testsigma/tree/dev/deploy/docker).
3. Run
`
$ docker-compose up -d
`
4. Verify the status by running `$docker ps` command
5. Now login to check the updated version of Testsigma Server here https://local.testsigmaos.com/ui

---

## **Update to new Version(Testsigma Agent)**

1. Stop the running agent by executing the stop.sh
2. Delete the TestsigmaAgent folder
3. Login to https://local.testsigmaos.com/ui
4. Go to Agents menu to download the latest version of Testsigma Agent
5. Now start the Agent by executing start.sh

[[info | NOTE:]]
|- If you are facing any issues after updating Testsigma Agent refer to [Agent - Startup and Registration Errors](https://testsigma.com/docs/agent/troubleshooting/setup-issues/) .
|- If you are still facing the issue, delete the [agent manually](https://testsigma.com/docs/agent/force-delete/) and install again.

---

## **Troubleshooting**

- If you encounter any errors during this process, check out our guide on [debugging deployment errors](https://testsigma.com/docs/troubleshooting/setup/server-docker-deployment-errors/) and for [logs](https://testsigma.com/docs/troubleshooting/setup/server-docker-deployment-errors/#checking-logs)
- If you are still facing any issue, please reach out to [[email protected]](mailto:[email protected]) or join our [Discord Server](https://discord.com/invite/5caWS7R6QX) to speak to the Testsigma team directly!

---

## **Next Steps**

1. [Get Started with Automating Web Applications](https://testsigma.com/tutorials/getting-started/automate-web-applications/)
2. [Get Started with Automating Mobile Web Applications](https://testsigma.com/tutorials/getting-started/automate-mobile-web-applications/)
3. [Get Started with Automating Android Apps](https://testsigma.com/tutorials/getting-started/automate-android-applications/)
4. [Get Started with Automating iOS Apps](https://testsigma.com/tutorials/getting-started/automate-ios-applications/)
5. [How to automate tests for Android Apps using local devices](https://testsigma.com/tutorials/test-cases/mobile-apps/build-tests-using-local-android-devices/)
6. [How to automate tests for iOS Apps using local devices](https://testsigma.com/tutorials/test-cases/mobile-apps/build-tests-using-local-ios-devices/)


---
56 changes: 56 additions & 0 deletions src/pages/docs/open-source-docs/introduction-community.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: "Intro: Testsigma Community Edition"
metadesc: "Testsigma Community Edition is an open-source automation platform | This article discusses installing Testsigma on your workstation & start test automation"
noindex: false
order: 28.1
page_id: "Introduction to Testsigma Community Edition"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Introduction"
url: "#introduction"
- type: link
name: "Setup Testsigma Community Edition"
url: "#setup-testsigma-community-edition"
- type: link
name: "Getting help"
url: "#getting-help"
- type: link
name: "Telemetry Opt-In"
url: "#telemetry-opt-in"

---

---


Testsigma Community Edition is an open-source end-to-end test automation platform. It packages libraries, APIs, classes, and more that you can install on your workstation and use to start test automation without building a test framework from scratch.

<iframe src="https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/testsigma_overview.mp4" width="600" height="400"></iframe>

---

## **Setup Testsigma Community Edition**

- [Deploy Testsigma on my workstation](https://testsigma.com/docs/getting-started/setup/overview/)


---

## **Getting help**
- Learn how to use, build, and extend the platform. Visit [documentation](https://testsigma.com/docs/).
- Connect with product experts on the team and in the Community on our [Discord](https://discord.com/invite/5caWS7R6QX).
- Troubleshooting problems? Report bugs as [Github issues](https://github.com/testsigmahq/testsigma/issues).
- Refer to our [FAQs](https://testsigma.com/docs/getting-started/faqs/) section for answers to commonly asked questions.
- Reach out to us at [[email protected]](mailto:[email protected]).


---

## **Telemetry Opt-In**

As a standard practice, we collect anonymous telemetry data during and after Testsigma is installed on your local machine. You can learn more about Telemetry data and opt-in [here](https://testsigma.com/docs/getting-started/telemetry/).

---
98 changes: 98 additions & 0 deletions src/pages/docs/open-source-docs/reset-password.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
---
title: "Reset Password"
page_title: "How to reset password in Testsigma Community Edition"
order: 28.4
page_id: "Reset password"
metadesc: "Learn steps in detail on how to reset username and password in Testsigma Community Edition. Follow these steps to reset username and password."
search_keyword: "Reset password"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Prerequisite (zip)"
url: "#zip-prerequisite"
- type: link
name: "Reset password (zip)"
url: "#zip-reset-passwrod"
- type: link
name: "Reset User Name (zip)"
url: "#zip-reset-user-name"
- type: link
name: "Prerequisite (Docker)"
url: "#docker-prerequisite"
- type: link
name: "Reset password (Docker)"
url: "#docker-reset-passwrod"
- type: link
name: "Reset User Name (Docker)"
url: "#docker-reset-user-name"
---

---

## [(I). Via Downloadable package](#)

---

## [Prerequisite](#zip-prerequisite)
1. Download the testsigma_opensource latest build [click here](https://testsigma.com/docs/getting-started/setup/downloadable-package/)
2. Run nginx server
3. Run testsigma server
4. Register with username and password

---

## [If you want to reset the password follow the steps below:](#zip-reset-passwrod)

1. Stop all the servers currently running.(i.e, nginx and testsigma server)
2. Navigate to testsigma server folder from downloads
3. Go to authentication properties
4. And Change the password (authentication.form.password = type your new password)
5. Save the file
6. Start the nginx
7. Testsigma servers and login with new credentials.

---

## [If you want to reset the username :](#zip-reset-user-name)

1. Stop all the servers currently running.(i.e, nginx and testsigma server)
2. Navigate to testsigma server folder from downloads
3. Go to authentication properties
4. Change the username (authentication.form.username = enter new user name)
5. Save the file

<iframe src="https://docs.testsigma.com/videos/Troubleshooting/Setup/ResetPassword/first.mp4" width="300" height="200"></iframe>


## [(II). Downloaded Via Docker](#)

---

## [Prerequisite](#docker-prerequisite)
1. Download the docker [click here](https://testsigma.com/docs/getting-started/setup/docker/)
2. Register with username and password

---

## [If you want to reset the password follow the steps below:](#docker-reset-passwrod)
1. Go to docker the folder
2. Go to the ts-data folder
3. Edit the Authentication properties file
4. Change the password (authentication.form.password = type your new password)
5. Save the file

---

## [If you want to reset the username :](#zip-reset-user-name)

1. Go to docker the folder
2. Go to the ts-data folder
3. Edit the Authentication properties file
4. change the username (authentication.form.username = enter new user name)
5. Save the file

<iframe src="https://docs.testsigma.com/videos/Troubleshooting/Setup/ResetPassword/second.mp4" width="300" height="200"></iframe>

---
37 changes: 37 additions & 0 deletions src/pages/docs/open-source-docs/testsigma-community-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: "Testsigma Community Cloud"
metadesc: "Integrate self-hosted open-source platform with Testsigma Community Cloud. This will provide free access to test labs, addons, visual testing, our discord, etc."
noindex: false
order: 28.2
page_id: "Testsigma Community Cloud"
warning: false
contextual_links:
- type: section
name: "Contents"
- type: link
name: "Registering for Testsigma Community Cloud"
url: "#registering-for-testsigma-community-cloud"
---

---

As a Testsigma CE user, you can integrate your self-hosted open-source platform with our Community Cloud and get free access to:
- **Test Lab**: Up to 200 minutes/month access to 800+ browsers/OS and real Android and iOS devices.
- **Storage**: Store up to 5GB of your data on the cloud monthly, including your apps, attachments, screenshots, video recordings, logs, and more.
- **Visual Testing**: Compare up to 1000 application screens per month to ensure the pixel-level quality of your UI by saving baseline visuals and comparing all future app versions against it.
- **iOS App Testing**: You can create a Provisioning Profile in Testsigma cloud and run your automated iOS app tests on your physical device.
- **Add-ons Marketplace**: Cover a wide range of automation and test scenarios by installing a comprehensive set of custom add-ons built and tested by the Testsigma community and engineering team.
- **Testsigma Discord Community**: Connect with some of the most experienced and creative test automation practitioners worldwide.

---

## **Registering for Testsigma Community Cloud**

On your Testsigma application,
- Go to **Settings**.
- Click on **Testsigma Cloud (CE)** option.
- Register using one of the options provided.

You’re now connected to the Cloud!

---
Loading