### Start UniFi Network Server Service

Source: https://help.ui.com/hc/en-us/articles/205144550-Self-Hosting-a-UniFi-Network-Server-as-a-Windows-Service-Advanced

Use this command to start the UniFi Network Server service after it has been installed.

```bash
java -jar lib\ace.jar startsvc
```

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

### Example UID Enterprise Desktop App Configuration

Source: https://help.ui.com/hc/en-us/articles/18750806392343-UID-Enterprise-Bulk-Deploy-UID-Enterprise-Desktop-App

This example demonstrates a silent installation with specific configurations for automatic updates, workspace domain, VPN proxy mode, and launch at startup. Ensure the MSI file name and parameters are correct for your environment.

```bash
UI_Desktop-v0.49.1.3.msi /quiet CHECK_UPDATE=1 WORKSPACE=acme VPN_PROXY_MODE=1 LAUNCH_AT_STARTUP=1
```

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

### Configure and Execute Installer

Source: https://help.ui.com/hc/en-us/articles/34210126298775-Self-Hosting-UniFi

Commands to set the installer permissions and execute the installation process.

```bash
chmod +x <local_path_to_uos_server_download>
```

```bash
sudo <local_path_to_uos_server_download>
```

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

### Example Response for Get Clients on a Site

Source: https://help.ui.com/hc/en-us/articles/31228198640023-External-Hotspot-API-for-Authorization-Clients

A sample JSON response for the '/v1/sites/{siteId}/clients' endpoint, detailing a client's status, including whether they are authorized.

```json
{
  "type": "WIRELESS",
  "id": "clientId",
  "name": "Apple iPad Pro",
  "macAddress": "42:8a:f7:3c:50:b0",
  "access": {
    "type": "GUEST",
    "authorized": false
  }
}
```

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

### Install UniFi Network Server as a Windows Service

Source: https://help.ui.com/hc/en-us/articles/205144550-Self-Hosting-a-UniFi-Network-Server-as-a-Windows-Service-Advanced

Execute this command in the UniFi installation directory to install the UniFi Network Server as a Windows service.

```bash
java -jar lib\ace.jar installsvc
```

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

### Start Python Web Server

Source: https://help.ui.com/hc/en-us/articles/360043360253-UniFi-Recovery-Mode

Launch a local web server on port 80 to serve the firmware file.

```bash
python -m http.server 80
```

```bash
python -m SimpleHTTPServer 80
```

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

### Start UniFi Network Service

Source: https://help.ui.com/hc/en-us/articles/220066768-Updating-and-Installing-Self-Hosted-UniFi-Network-Servers-Linux

If the UniFi Network application is not launching automatically after installation or upgrade, use this command to start the service manually.

```bash
sudo service unifi start
```

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

### Reset to Factory Default Configuration

Source: https://help.ui.com/hc/en-us/articles/205202580-Explaining-the-UniFi-system-properties-File

This setting is used to facilitate UniFi Network application installation by starting the application with its factory default configuration. It is generally recommended for new installations rather than modifying existing ones.

```properties
is_default=true_
```

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

### Example Response for Get Sites

Source: https://help.ui.com/hc/en-us/articles/31228198640023-External-Hotspot-API-for-Authorization-Clients

A sample JSON response when querying the '/v1/sites' endpoint, showing the structure of site information returned.

```json
[
  {
    "id": "siteId",
    "name": "Site Name"
  }
]
```

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

### WireGuard Configuration File Example

Source: https://help.ui.com/hc/en-us/articles/16357883221015-UniFi-Gateway-WireGuard-VPN-Client

This is an example of a WireGuard configuration file. It includes essential parameters like PrivateKey, Address, DNS, PublicKey, PresharedKey, AllowedIPs, and Endpoint. Ensure these match your VPN provider's details.

```ini
[Interface]
PrivateKey = aBcDeFgHiJkLmNaBcDeFgHiJkLmNaBcDeFgHiJkLmNa=
Address = 192.168.5.2/32
DNS = 192.168.5.1

[Peer]
PublicKey = aBcDeFgHiJkLmNaBcDeFgHiJkLmNaBcDeFgHiJkLmNa=
PresharedKey = aBcDeFgHiJkLmNaBcDeFgHiJkLmNaBcDeFgHiJkLmNa=
AllowedIPs = 192.168.5.1/32,192.168.5.2/32,0.0.0.0/0
Endpoint = 198.51.100.1:51820
```

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

### Create Web Server Directory

Source: https://help.ui.com/hc/en-us/articles/360043360253-UniFi-Recovery-Mode

Commands to create a dedicated directory for hosting firmware files.

```bash
mkdir c:\webserver
cd c:\webserver
```

```bash
cd ~
mkdir webserver
cd webserver
```

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

### Download UniFi OS Server Installer

Source: https://help.ui.com/hc/en-us/articles/34210126298775-Self-Hosting-UniFi

Commands to download the installer package using curl or wget.

```bash
curl -O <uos_server_download_link>
```

```bash
wget <uos_server_download_link>
```

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

### Get WiFi List via curl

Source: https://help.ui.com/hc/en-us/articles/17196782820247-UID-Enterprise-Troubleshoot-WiFi-Issues-and-FAQ

This command retrieves a list of WiFi networks configured on the UniFi Console, including their IDs and names. It requires 'curl' and 'jq' to be installed.

```bash
curl http://localhost:8081/v2/api/site/default/uid/wlan |jq '.[] | {_id:._id,name:.name}'
```