DWService

https://docs.dwservice.net/
Admin
DWService is a free and open-source remote access service that allows users to securely connect to...
Tokens:63,443
Snippets:537
Trust Score:9.6
Update:1 month ago
Show doc for...
Tokens:
Raw
### install.json example with topimage and install mode

Source: https://docs.dwservice.net/docs/api/customize-the-installer/example-configuration

Alternative install.json configuration that shows a logo on the top panel using 'topimage', sets mode to 'install', and enables installputcode.

```json
{
"name": "MySoft",
"mainurl": "https://www.apiremoteaccess.com/",
"listenport": 7956,
"title": "My Title",
"logo": "logo.ico",
"topimage": "image.bmp”",
"mode": "install",
"installputcode": true
}
```

--------------------------------

### install.json example with topinfo and run mode

Source: https://docs.dwservice.net/docs/api/customize-the-installer/example-configuration

Example install.json configuration that sets the installer name, main URL, listen port, title, logo, top info text, mode to 'run', and enables runputcode with runtoptext.

```json
{
"name": "MySoft",
"mainurl": "https://www.apiremoteaccess.com/",
"listenport": 7956,
"title": "My Title",
"logo": "logo.ico",
"topinfo": "My Company\nMy Address",
"mode": "run",
"runputcode": true,
"runtoptext": "info line 1\ninfo line 2"
}
```

--------------------------------

### config.json example with all users enabled

Source: https://docs.dwservice.net/docs/site/remote-access/how-to-use-the-shell-application

Example configuration requiring authentication where all users are enabled for the shell.

```json
{
 "shell.enable_authentication": true,
 "shell.users_allowed": [{"name": "*", "enable": true}],
 "enabled": true,
 "key": "<AGENT KEY>",
 "listen_port": 7950,
 "password": "<AGENT PASSWORD>",
 "url_primary": "https://www.dwservice.net/"
}
```

--------------------------------

### Install Xorg dummy driver on Linux

Source: https://docs.dwservice.net/docs/site/troubleshootfaq/set-up-a-device-without-a-monitor-headless

Install the xserver-xorg-video-dummy package to enable virtual display support on Linux systems.

```bash
sudo apt-get install xserver-xorg-video-dummy
```

--------------------------------

### config.json example without authentication

Source: https://docs.dwservice.net/docs/site/remote-access/how-to-use-the-shell-application

Example configuration where no username or password is required for the shell.

```json
{
  "shell.enable_authentication": false,
  "enabled": true,
  "key": "<AGENT KEY>",
  "listen_port": 7950,
  "password": "<AGENT PASSWORD>",
  "url_primary": "https://www.dwservice.net/"
}
```

--------------------------------

### Windows Group Policy Deployment Script

Source: https://docs.dwservice.net/docs/site/dwservice-installation/how-do-i-install-the-agent-silently

Example script for deploying the agent via Group Policy, which copies the installer to a temporary location, executes it silently, and cleans up the installer file.

```batch
IF NOT EXIST "C:\Program Files\DWAgent\agent.py" copy \\xxx.xxx.xxx.xxx\log$\software\dwservice\dwagent.exe c:\temp\ & c:\temp\dwagent.exe -silent user=xxxxxx password=xxxxxx group=xxxxxx & DEL /F /S /Q /A "c:\temp\dwagent.exe"
```

--------------------------------

### config.json example with only root user enabled

Source: https://docs.dwservice.net/docs/site/remote-access/how-to-use-the-shell-application

Example configuration requiring authentication where only the root user is enabled.

```json
{
  "shell.enable_authentication": true,
  "shell.users_allowed": [{"name": "root", "enable": true}, {"name": "*", "enable": false}],
  "enabled": true,
  "key": "<AGENT KEY>",
  "listen_port": 7950,
  "password": "<AGENT PASSWORD>",
  "url_primary": "https://www.dwservice.net/"
}
```

--------------------------------

### Execute the Agent installation script

Source: https://docs.dwservice.net/docs/site/agent-installation-step-by-step/linux/linux-install-the-agent-with-credentials-console

Run the installation script with root privileges. Use the -console flag if you are on a system with a Desktop Environment to force the console-based wizard.

```bash
sudo bash dwagent.sh
```

```bash
sudo bash dwagent.sh -console
```

--------------------------------

### Silent installation using account credentials

Source: https://docs.dwservice.net/docs/site/dwservice-installation/how-do-i-install-the-agent-silently

Install the agent silently by providing account credentials, including a specific agent installation password. Optional parameters allow setting the agent name and group assignment.

```bash
dwagent.sh -silent user=xxxxxx password=xxxxxx name=xxxxxx group=xxxxxx logpath=xxxxxx
```

```bash
name=Linux
```

```bash
name="Linux Ubuntu"
```

```bash
group=DWService
```

```bash
group="DWService Office"
```

--------------------------------

### Run silent installation script

Source: https://docs.dwservice.net/docs/site/dwservice-installation/how-do-i-install-the-agent-silently

Command to execute the prepared shell script for silent installation.

```bash
sudo sh dwagent.sh
```

--------------------------------

### Windows Silent Installation with Credentials

Source: https://docs.dwservice.net/docs/site/dwservice-installation/how-do-i-install-the-agent-silently

Install the agent by providing account credentials, an agent name, and an optional group. The password used here must be the specific Agent installation password set in your account, not your account login password.

```bash
dwagent.exe -silent user=xxxxxx password=xxxxxx name=xxxxxx group=xxxxxx logpath=xxxxxx
```

--------------------------------

### config.json example with root user excluded

Source: https://docs.dwservice.net/docs/site/remote-access/how-to-use-the-shell-application

Example configuration requiring authentication where all users except root are enabled.

```json
{
  "shell.enable_authentication": true,
  "shell.users_allowed": [{"name": "root", "enable": false}, {"name": "*", "enable": true}],
  "enabled": true,
  "key": "<AGENT KEY>",
  "listen_port": 7950,
  "password": "<AGENT PASSWORD>",
  "url_primary": "https://www.dwservice.net/"
}
```

--------------------------------

### Silent installation script using credentials

Source: https://docs.dwservice.net/docs/site/dwservice-installation/how-do-i-install-the-agent-silently

Shell script for silent installation using account credentials and optional agent name/group parameters.

```bash
#!/bin/sh
 mkdir /var/tmp
 cd /var/tmp
 curl --location https://www.dwservice.net/download/dwagent.dmg -o dwagent.dmg
 hdiutil attach /var/tmp/dwagent.dmg
 cp -r /Volumes/DWAgent/DWAgent.app /Applications/
 hdiutil detach /Volumes/DWAgent
 rm /var/tmp/dwagent.dmg
 cd /Applications/DWAgent.app
 /Applications/DWAgent.app/Contents/MacOS/extract
 chmod -R 755 /Applications/DWAgent.app
 /Applications/DWAgent.app/Contents/MacOS/Install /Applications/DWAgent.app/ Y -silent user=xxxxxx password=xxxxxx name=xxxxxx group=xxxxxx logpath=xxxxxx
```

--------------------------------

### Switch to X11 via Command Line

Source: https://docs.dwservice.net/docs/site/workarounds/screen-app-error-xwayland-is-not-supported-workaround-for-raspberry

Use this command to set the display backend to X11.

```bash
sudo raspi-config nonint do_wayland W1
```

--------------------------------

### Windows Silent Installation with Installation Code

Source: https://docs.dwservice.net/docs/site/dwservice-installation/how-do-i-install-the-agent-silently

Use the -silent flag along with a pre-generated installation key to install the agent. The logpath parameter is optional for tracking installation events.

```bash
dwagent.exe -silent key=xxx-xxx-xxx logpath=xxxxxx
```

```bash
dwagent.exe -silent key=123-456-789 logpath=C:\dwagent_install.log
```

--------------------------------

### Silent installation using an installation key

Source: https://docs.dwservice.net/docs/site/dwservice-installation/how-do-i-install-the-agent-silently

Install the agent silently by providing a pre-generated installation key. The logpath parameter is optional for specifying the installation log file location.

```bash
dwagent.sh -silent key=xxx-xxx-xxx logpath=xxxxxx
```

```bash
key=123-456-789
```

```bash
logpath=/tmp/dwagent_install.log
```

```bash
dwagent.sh -silent key=123-456-789 logpath=/tmp/dwagent_install.log
```

--------------------------------

### Silent installation script using installation code

Source: https://docs.dwservice.net/docs/site/dwservice-installation/how-do-i-install-the-agent-silently

Shell script for silent installation using an installation code. Replace xxx-xxx-xxx with your generated code.

```bash
#!/bin/sh
 mkdir /var/tmp
 cd /var/tmp
 curl --location https://www.dwservice.net/download/dwagent.dmg -o dwagent.dmg
 hdiutil attach /var/tmp/dwagent.dmg
 cp -r /Volumes/DWAgent/DWAgent.app /Applications/
 hdiutil detach /Volumes/DWAgent
 rm /var/tmp/dwagent.dmg
 cd /Applications/DWAgent.app
 /Applications/DWAgent.app/Contents/MacOS/extract
 chmod -R 755 /Applications/DWAgent.app
 /Applications/DWAgent.app/Contents/MacOS/Install /Applications/DWAgent.app/ Y -silent key=xxx-xxx-xxx logpath=xxxxxx
```

--------------------------------

### Configure Xorg for headless operation

Source: https://docs.dwservice.net/docs/site/troubleshootfaq/set-up-a-device-without-a-monitor-headless

Create and edit the Xorg configuration file to define the dummy video device.

```bash
sudo nano /etc/X11/xorg.conf
```

```text
Section "Device"
 Identifier "Configured Video Device"
 Driver "dummy"
```

--------------------------------

### Launch Raspberry Pi Configuration Tool

Source: https://docs.dwservice.net/docs/site/workarounds/screen-app-error-xwayland-is-not-supported-workaround-for-raspberry

Open the graphical configuration interface to manage system settings.

```bash
sudo raspi-config
```
Tokens:
Raw