Skip to content

Commit

Permalink
docs: split dogu-agent docs with settings
Browse files Browse the repository at this point in the history
  • Loading branch information
yowpark committed Dec 5, 2023
1 parent e581a7d commit d08d943
Show file tree
Hide file tree
Showing 10 changed files with 371 additions and 252 deletions.
89 changes: 1 addition & 88 deletions docs/device-farm/host/macos/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,94 +42,7 @@ import DoguAgentInstallationCloud from '@site/src/components/device-farm/DoguAge
2. Dogu Agent checks if the necessary tools are installed and displays an installation window if any tools are missing. If there are tools that are not installed, please proceed with the installation.
3. To ensure smooth operation of Dogu Agent, the appropriate permissions for the operating system you are installing on are required. If the permissions are not granted, please allow the permissions.

### Console connection
### Connect to console

Please go to the [Host Management](/management/organization/device-farm/host-management) page to obtain the host token and enter the obtained token in Dogu Agent.

### Settings

Once connected, Dogu Agent will open the settings window where you can customize Dogu Agent's default settings.

<img src={dost_macos_setting} style={{ width: 600 }} />

- Start Dogu Agent when ayou log in
- Dogu Agent starts automatically when PC turns on.
- Theme for Dogu Agent
- Sets Dogu Agent's color theme.

### macOS Settings

<img src={dost_macos_macossettings} style={{ width: 600 }} />:

- macOS Permission

- It is only visible on macOS, and it shows the status of the
necessary permissions required for smooth streaming.

:::info

macOS needs [Screen recording](https://support.apple.com/guide/mac-help/mchld6aa7d23/mac), [Accessibility](https://support.apple.com/guide/mac-help/mh43185/mac).

:::

### iOS Settings

<img src={dost_macos_manual_setup} style={{ width: 600 }} />

iOS requires special setup to install on devices inside the organization, as installation is limited unless the app has been uploaded to the AppStore. One of these special settings is Manual Setup. At this time, I will explain below based on [Automatic signing](https://developer.apple.com/documentation/xcode/distributing-your-app-to-registered-devices#Register-devices-automatically-in-Xcode) among the methods of installing certified apps on iOS devices. If you are using manual signing, you can use the organization's internal certificate and provisioning profile.

- Xcode

- It is the basic tool you need when controlling connected iOS devices from macOS. It can be installed from [AppStore](https://apps.apple.com/us/app/xcode/id497799835?mt=12).
- After installation, please log in as below. At this time, the Apple account must be an account within the organization that has joined the [Apple Developer Program](https://developer.apple.com/programs/).

<img src={xcode_login_0} style={{ width: 200 }} /> <br></br>
<img src={xcode_login_1} style={{ width: 400 }} /> <br></br>
<img src={xcode_login_2} style={{ width: 400 }} /> <br></br>

- WebDriverAgent
- This is a necessary app for iOS test automation..
- Open the project by pressing the `WebDriverAgent Project` button.
- Signing of WebDriverAgentRunner by pressing the button in the red box from the left as shown in the picture below.
- Please select Team. Please select the name of the organization that has joined the [Apple Developer Program](https://developer.apple.com/programs/).
- Afterwards, if the warning message or error message disappears, return to Dogu Agent and click the `Click here to build` button..
- When the build is complete, press the ‘Check’ button to make a green check mark appear..
<img src={xcode_webdriveragent} style={{ width: 700 }} /> <br></br>
- iOSDeviceAgent
- This app is necessary for real-time screen transmission and input..
- Open the project by pressing the ‘iOSDeviceAgent Project’ button.
- Signing of DoguDev by pressing the button in the red box from the left as shown in the picture below.
- Please select Team. Please select the name of the organization that has joined the [Apple Developer Program](https://developer.apple.com/programs/).
- Afterwards, check if the warning message or error message has disappeared..
- Please do the same for DoguDevRunner, DoguRunner, and DoguScreen as well as DoguDev..
- Go back to Dogu Agent and hit the 'Click here to build' button.
- When the build is complete, press the ‘Check’ button to make a green check mark appear..
<img src={xcode_iosdeviceagent} style={{ width: 700 }} /> <br></br>

:::caution
WebDriverAgent and iOSDeviceAgent can be installed and executed only on iOS devices registered in [Apple Developer Console](https://developer.apple.com/account/resources/devices/list). Refer to [Register devices in your developer account](https://developer.apple.com/documentation/xcode/distributing-your-app-to-registered-devices#Register-devices-in-your-developer-account) and ask the organization manager to register the device..

:::

<br></br>
<br></br>

:::info

Dogu Agent installation has been completed? Try adding devices through [Device configuration](/device-farm/device/settings).

:::

### TroubleShoot

<img src={dost_macos_troubleshoot} style={{ width: 600 }} />

- Diagnose packages
- Check the installation status of the packages necessary for normal
Dogu Agent execution..
- Documents
- Open the documentation for Dogu Agent in your browser.
- Network
- This configuration is used when there is a network related problem.
- Report
- This button is used to report a problem to Dogu.
113 changes: 113 additions & 0 deletions docs/device-farm/host/macos/settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
---
sidebar_position: 2
title: Settings
locale: en
---

import {
getBrowserPlatform,
BrowserPlatform,
} from '@site/src/platform/platform.ts';

import dost_macos_setting from '@site/static/img/dost/dost_macos_setting.png';
import dost_macos_troubleshoot from '@site/static/img/dost/dost_macos_troubleshoot.png';
import dost_macos_manual_setup from '@site/static/img/dost/dost_macos_manual_setup.png';
import dost_macos_macossettings from '@site/static/img/dost/dost_macos_macossettings.png';
import xcode_login_0 from '@site/static/img/dost/xcode_login_0.png';
import xcode_login_1 from '@site/static/img/dost/xcode_login_1.png';
import xcode_login_2 from '@site/static/img/dost/xcode_login_2.png';
import xcode_iosdeviceagent from '@site/static/img/dost/xcode_iosdeviceagent.png';
import xcode_webdriveragent from '@site/static/img/dost/xcode_webdriveragent.png';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Admonition from '@theme/Admonition';
import XcodeSettings from '@site/src/components/device-farm/XcodeSettings.mdx';
import DoguAgentInstallationCloud from '@site/src/components/device-farm/DoguAgentInstallationMacOSCloud.mdx';

### Settings

You can customize Dogu Agent's default settings.

<img src={dost_macos_setting} style={{ width: 600 }} />

- Start Dogu Agent when ayou log in
- Dogu Agent starts automatically when PC turns on.
- Theme for Dogu Agent
- Sets Dogu Agent's color theme.

### macOS Settings

<img src={dost_macos_macossettings} style={{ width: 600 }} />:

- macOS Permission

- It is only visible on macOS, and it shows the status of the
necessary permissions required for smooth streaming.

:::info

macOS needs [Screen recording](https://support.apple.com/guide/mac-help/mchld6aa7d23/mac), [Accessibility](https://support.apple.com/guide/mac-help/mh43185/mac).

:::

### iOS Settings

<img src={dost_macos_manual_setup} style={{ width: 600 }} />

iOS requires special setup to install on devices inside the organization, as installation is limited unless the app has been uploaded to the AppStore. One of these special settings is Manual Setup. At this time, I will explain below based on [Automatic signing](https://developer.apple.com/documentation/xcode/distributing-your-app-to-registered-devices#Register-devices-automatically-in-Xcode) among the methods of installing certified apps on iOS devices. If you are using manual signing, you can use the organization's internal certificate and provisioning profile.

- Xcode

- It is the basic tool you need when controlling connected iOS devices from macOS. It can be installed from [AppStore](https://apps.apple.com/us/app/xcode/id497799835?mt=12).
- After installation, please log in as below. At this time, the Apple account must be an account within the organization that has joined the [Apple Developer Program](https://developer.apple.com/programs/).

<img src={xcode_login_0} style={{ width: 200 }} /> <br></br>
<img src={xcode_login_1} style={{ width: 400 }} /> <br></br>
<img src={xcode_login_2} style={{ width: 400 }} /> <br></br>

- WebDriverAgent
- This is a necessary app for iOS test automation..
- Open the project by pressing the `WebDriverAgent Project` button.
- Signing of WebDriverAgentRunner by pressing the button in the red box from the left as shown in the picture below.
- Please select Team. Please select the name of the organization that has joined the [Apple Developer Program](https://developer.apple.com/programs/).
- Afterwards, if the warning message or error message disappears, return to Dogu Agent and click the `Click here to build` button..
- When the build is complete, press the ‘Check’ button to make a green check mark appear..
<img src={xcode_webdriveragent} style={{ width: 700 }} /> <br></br>
- iOSDeviceAgent
- This app is necessary for real-time screen transmission and input..
- Open the project by pressing the ‘iOSDeviceAgent Project’ button.
- Signing of DoguDev by pressing the button in the red box from the left as shown in the picture below.
- Please select Team. Please select the name of the organization that has joined the [Apple Developer Program](https://developer.apple.com/programs/).
- Afterwards, check if the warning message or error message has disappeared..
- Please do the same for DoguDevRunner, DoguRunner, and DoguScreen as well as DoguDev..
- Go back to Dogu Agent and hit the 'Click here to build' button.
- When the build is complete, press the ‘Check’ button to make a green check mark appear..
<img src={xcode_iosdeviceagent} style={{ width: 700 }} /> <br></br>

:::caution
WebDriverAgent and iOSDeviceAgent can be installed and executed only on iOS devices registered in [Apple Developer Console](https://developer.apple.com/account/resources/devices/list). Refer to [Register devices in your developer account](https://developer.apple.com/documentation/xcode/distributing-your-app-to-registered-devices#Register-devices-in-your-developer-account) and ask the organization manager to register the device..

:::

<br></br>
<br></br>

:::info

Dogu Agent installation has been completed? Try adding devices through [Device configuration](/device-farm/device/settings).

:::

### TroubleShoot

<img src={dost_macos_troubleshoot} style={{ width: 600 }} />

- Diagnose packages
- Check the installation status of the packages necessary for normal
Dogu Agent execution..
- Documents
- Open the documentation for Dogu Agent in your browser.
- Network
- This configuration is used when there is a network related problem.
- Report
- This button is used to report a problem to Dogu.
34 changes: 1 addition & 33 deletions docs/device-farm/host/windows/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,39 +36,7 @@ import DoguAgentInstallationCloud from '@site/src/components/device-farm/DoguAge
2. Dogu Agent checks if the necessary tools are installed and displays an installation window if any tools are missing. If there are tools that are not installed, please proceed with the installation.
3. To ensure smooth operation of Dogu Agent, the appropriate permissions for the operating system you are installing on are required. If the permissions are not granted, please allow the permissions.

### Console connection
### Connect to console

Please go to the [Host Management](/management/organization/device-farm/host-management) page to obtain the host token and enter the obtained token in Dogu Agent.

### Settings

Once connected, Dogu Agent will open the settings window where you can customize Dogu Agent's default settings.

#### General

<img src={dost_windows_setting} style={{ width: 600 }} />

- Start Dogu Agent when you log in
- Dogu Agent starts automatically when PC turns on.
- Theme for Dogu Agent
- Sets Dogu Agent's color theme.

#### TroubleShoot

<img src={dost_windows_troubleshoot} style={{ width: 600 }} />

- Diagnose packages
- Check the installation status of the packages necessary for normal
Dogu Agent execution..
- Open Docs

- Open documents website.

<br></br>
<br></br>

:::info

Dogu Agent installation has been completed? Try adding devices through [Device configuration](/device-farm/device/settings).

:::
54 changes: 54 additions & 0 deletions docs/device-farm/host/windows/settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
sidebar_position: 2
title: Settings
locale: en
---

import {
getBrowserPlatform,
BrowserPlatform,
} from '@site/src/platform/platform.ts';
import dost_windows_setting from '@site/static/img/dost/dost_windows_setting.png';
import dost_windows_troubleshoot from '@site/static/img/dost/dost_windows_troubleshoot.png';
import xcode_login_0 from '@site/static/img/dost/xcode_login_0.png';
import xcode_login_1 from '@site/static/img/dost/xcode_login_1.png';
import xcode_login_2 from '@site/static/img/dost/xcode_login_2.png';
import xcode_iosdeviceagent from '@site/static/img/dost/xcode_iosdeviceagent.png';
import xcode_webdriveragent from '@site/static/img/dost/xcode_webdriveragent.png';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Admonition from '@theme/Admonition';
import DoguAgentInstallationCloud from '@site/src/components/device-farm/DoguAgentInstallationWindowsCloud.mdx';

### Settings

You can customize Dogu Agent's default settings.

#### General

<img src={dost_windows_setting} style={{ width: 600 }} />

- Start Dogu Agent when you log in
- Dogu Agent starts automatically when PC turns on.
- Theme for Dogu Agent
- Sets Dogu Agent's color theme.

#### TroubleShoot

<img src={dost_windows_troubleshoot} style={{ width: 600 }} />

- Diagnose packages
- Check the installation status of the packages necessary for normal
Dogu Agent execution..
- Open Docs

- Open documents website.

<br></br>
<br></br>

:::info

Dogu Agent installation has been completed? Try adding devices through [Device configuration](/device-farm/device/settings).

:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
sidebar_position: 3
title: Advanced Configuration
locale: en
---

# Advanced Configuration

## Routine

### Environment Variable

`zsh`를 셸로 사용하는 경우 `~/.zshrc` 또는 `~/.zprofile` 대신 `~/.zshenv`에 변수를 추가해야 합니다.

:::tip 사용중인 쉘 확인

터미널에서 `echo $SHELL`을 실행하여 쉘을 확인할 수 있습니다.

:::

## Safari Browser Automation

### Enable safaridriver

Safaridriver를 활성화하려면 터미널에 다음 명령을 입력하십시오.

```shell
sudo /usr/bin/safaridriver --enable
```

:::tip 공식 문서

[Safari에서 WebDriver로 테스트](https://developer.apple.com/documentation/webkit/testing_with_webdriver_in_safari)를 참조하세요.

:::
Loading

0 comments on commit d08d943

Please sign in to comment.