# Installation and configuration guide



# Setup (install/update)

### WireGuard VPN module **[WISECP](https://puqcloud.com/link.php?id=78)** 

##### [Order now](https://puqcloud.com/index.php?rp=/store/wisecp-module-wireguard-vpn) | [Download](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-WireGuard-VPN/) | [FAQ](https://faq.puqcloud.com/)

<p class="callout info">To install and update a module, you must perform one and the same action.</p>

#####  

##### 1. Download the latest version of the module.

```Powershell
wget http://download.puqcloud.com/WISECP/Product/PUQ_WISECP-WireGuard-VPN/PUQ_WISECP-WireGuard-VPN-latest.zip
```

<p class="callout info">All versions are available: [https://download.puqcloud.com/WISECP/Product/PUQ\_WISECP-WireGuard-VPN/](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-WireGuard-VPN/)</p>

#####  

##### 2. Unzip the archive with the module.

```Powershell
unzip PUQ_WISECP-WireGuard-VPN-latest.zip
```

#####  

##### 3. Copy and Replace "puqWireGuardVPN" from "PUQ\_WISECP-WireGuard-VPN" to "WISECP\_WEB\_DIR/coremio/modules/Product/"

# License Activation

### WireGuard VPN module **[WISECP](https://puqcloud.com/link.php?id=78)** 

##### [Order now](https://puqcloud.com/index.php?rp=/store/wisecp-module-wireguard-vpn) | [Download](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-WireGuard-VPN/) | [FAQ](https://faq.puqcloud.com/)

##### 1. Log in to the administrative area of your **[WISECP](https://puqcloud.com/link.php?id=78)**.

#####   
2. Go to module configuration.

```
Services -> Service Management -> Module Settings -> Other -> All Modules -> PUQ WireGuard VPN
```

[![image-1700485721333.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700485721333.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485721333.png)

[![image-1700485726951.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700485726951.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485726951.png)

[![image-1700485737918.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700485737918.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485737918.png)

[![image-1700485743386.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700485743386.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485743386.png)

##### 3. On the open page, enter the purchased license key for this product and click the '**Check and Save**' button to validate the key and save it.

[![image-1700486620519.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700486620519.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700486620519.png)

#####  

# PUQVPNCP installation and configuration

### WireGuard VPN module **[WISECP](https://puqcloud.com/link.php?id=78)** 

##### [Order now](https://puqcloud.com/index.php?rp=/store/wisecp-module-wireguard-vpn) | [Download](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-WireGuard-VPN/) | [FAQ](https://faq.puqcloud.com/)

##### Official documentation:  
  
[PUQVPNCP Documentation](https://doc.puq.info/books/puqvpncp/page/description)  
[PUQVPNCP Download](https://download.puqcloud.com/cp/puqvpncp/)  
[PUQVPNCP Order now](https://panel.puqcloud.com/index.php?rp=/store/puqvpn)

#### **1. Install the required packages**

```shell
apt-get update
apt-get install wireguard wireguard-dkms wireguard-tools -y
apt-get install iproute2 iptables -y
apt-get install bind9 -y
```

#### 2. **Download the latest version of the package**

[https://download.puqcloud.com/cp/puqvpncp/](https://download.puqcloud.com/cp/puqvpncp/)

#### 3. Install the puqvpncp package

```shell
wget https://download.puqcloud.com/cp/puqvpncp/puqvpncp_XXXX_amd64.deb
dpkg -i puqvpncp_XXXX_amd64.deb
```

#### 4. After installation, connect to your server via a web browser.

http://SERVER\_IP:8098  
Username: admin  
Password: admin

[![image-1669217804065.png](https://doc.puq.info/uploads/images/gallery/2022-11/scaled-1680-/image-1669217804065.png)](https://doc.puq.info/uploads/images/gallery/2022-11/image-1669217804065.png)

[![image-1668690609770.png](https://doc.puq.info/uploads/images/gallery/2022-11/scaled-1680-/image-1668690609770.png)](https://doc.puq.info/uploads/images/gallery/2022-11/image-1668690609770.png)

#### **5. Enable SSL Let’s Encrypt** 

**Requirements**

- The active domain name that resolves the server's IP address
- Port 80 and 443 are always open, and not busy with another process

**In order for the system to start the procedure for obtaining an SSL certificate from Let's Encrypt, it is necessary.**

**In the configuration file, enable the use of SSL and enter the domain name.**

```shell
nano /etc/puqvpncp/puqvpncp.conf 
```

```shell
LetsEncrypSSL=yes
Domain=XXXXXX.XXX
```

Restart the **PUQVPNCP** service

```shell
service puqvpncp restart
```

<p class="callout info">After these steps, the first time you connect to the server via the https protocol, the system will request an SSL certificate and automatically renew it if necessary.</p>

<p class="callout warning">ATTENTION. After activating SSL, the system will only work in the https protocol on port 443.   
A redirect is also set from port 80 to port 443.</p>

<p class="callout warning">To connect to the server via the https protocol, use only the domain that was set in the configuration file.   
Otherwise, you will get an error that SSL is not working correctly.</p>

#### 6. License configuration is available in the menu item **Settings-&gt;License**

[![image-1668763551186.png](https://doc.puq.info/uploads/images/gallery/2022-11/scaled-1680-/image-1668763551186.png)](https://doc.puq.info/uploads/images/gallery/2022-11/image-1668763551186.png)

By default, the system limit is 50 users and the API is disabled.

In order to activate the license key, the key must be entered in the "License Key" field and click on the "Save" button

[![image-1668764171867.png](https://doc.puq.info/uploads/images/gallery/2022-11/scaled-1680-/image-1668764171867.png)](https://doc.puq.info/uploads/images/gallery/2022-11/image-1668764171867.png)

#### **7.Creation of access API**

To manage API Access Hashs, go to the section Settings-&gt;API

[![image-1668764483617.png](https://doc.puq.info/uploads/images/gallery/2022-11/scaled-1680-/image-1668764483617.png)](https://doc.puq.info/uploads/images/gallery/2022-11/image-1668764483617.png)

**Enter the name and IP address of the WHMCS server and click the ADD button**

<p class="callout warning">**Attention.   
The generated Access hash will only be shown once. Copy it, it will be needed during configuration of the product server in the WHMCS system.**</p>

<p class="callout info">Accept the fact that once the Access Hashs API is created, it will only be shown once.  
Each API Access Hash only works from a specific IP address.</p>

#### **8. Creation of access API**

Add new WireGuard is available in the menu item **VPN servers-&gt;WireGuard-&gt;Click Create**

[![image-1669367825882.png](https://doc.puq.info/uploads/images/gallery/2022-11/scaled-1680-/image-1669367825882.png)](https://doc.puq.info/uploads/images/gallery/2022-11/image-1669367825882.png)

[![image-1669367860027.png](https://doc.puq.info/uploads/images/gallery/2022-11/scaled-1680-/image-1669367860027.png)](https://doc.puq.info/uploads/images/gallery/2022-11/image-1669367860027.png)

Enter or edit the parameters of the new server/interface and click the **ADD** button

<div id="bkmrk--6"><div></div></div><div id="bkmrk--7"><div></div></div><div id="bkmrk--8"><div></div></div>

# Add server (PUQVPNCP) in WISECP

### WireGuard VPN module **[WISECP](https://puqcloud.com/link.php?id=78)** 

##### [Order now](https://puqcloud.com/index.php?rp=/store/wisecp-module-wireguard-vpn) | [Download](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-WireGuard-VPN/) | [FAQ](https://faq.puqcloud.com/)

##### 1. Log in to the administrative area of your **[WISECP](https://puqcloud.com/link.php?id=78)**.

#####   
2. Go to module configuration.

```
Services -> Service Management -> Module Settings -> Other -> All Modules -> PUQ WireGuard VPN
```

[![image-1700485721333.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700485721333.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485721333.png)

[![image-1700485726951.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700485726951.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485726951.png)

[![image-1700485737918.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700485737918.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485737918.png)

[![image-1700485743386.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700485743386.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485743386.png)

##### 3. In the opened page, click the '**Add Server**' button.

[![image-1700485907763.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700485907763.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700485907763.png)

#####  

##### 4. On the opened page, enter all the necessary information:

- **Name**: Displayed name of the server.
- **Maximum Number of Accounts**: The number of services that can be on this server.
- **Server Group**: Optionally, choose the server group.
- **IP Address or Domain**: The address of the PUQVPNCP server you are connecting to.
- **Access Hash**: API key that you created in the previous step on the PUQVPNCP server.
- Check the **SSL** box if you want to use SSL-encrypted connection. If necessary, specify the port and perform a connection test.  
    [![image-1700486280198.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700486280198.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700486280198.png)

<div id="bkmrk--4"><div></div></div><div id="bkmrk--5"><div></div></div><div id="bkmrk--6"><div></div></div><div id="bkmrk--7"><div></div></div><div id="bkmrk--8"><div></div></div>

# Service configuration

### WireGuard VPN module **[WISECP](https://puqcloud.com/link.php?id=78)** 

##### [Order now](https://puqcloud.com/index.php?rp=/store/wisecp-module-wireguard-vpn) | [Download](https://download.puqcloud.com/WISECP/Product/PUQ_WISECP-WireGuard-VPN/) | [FAQ](https://faq.puqcloud.com/)

<p class="callout info">If you do not have a **Service Group** where you want to place the new service, you need to create a new **Service Group**</p>

##### 1. Log in to the administrative area of your **[WISECP](https://puqcloud.com/link.php?id=78)**.

##### 2. Create New Service Group

  
Go to

```
Services -> Service Management -> Add Group
```

[![image-1700487270737.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700487270737.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700487270737.png)

Enter all the necessary data and click the '**Create Group**' button.  
[![image-1700487384497.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700487384497.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700487384497.png)

##### 3. Adding a New Service  
  


Go to

```
Services -> our service group where you need to add the new service.
```

[![image-1700487595449.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700487595449.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700487595449.png)

In the opened window, click the '**Create New Service**' button.

[![image-1700487653237.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700487653237.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700487653237.png)

On the opened page, enter all the necessary details for your new service and navigate to the '**Core**' tab.  
  
Select the '**PUQ WireGuard VPN**' module from the drop-down list of modules.

[![image-1700489009655.png](https://doc.puq.info/uploads/images/gallery/2023-11/scaled-1680-/image-1700489009655.png)](https://doc.puq.info/uploads/images/gallery/2023-11/image-1700489009655.png)

##### 4. Fill in the configuration options according to your preferences.

- **Server Group** is the group of servers from which a server will be chosen for provisioning the service
- **WireGuard Server** is the name of the WireGuard server that was created in PUQVPNCP

<p class="callout warning">**Attention:**   
The **WireGuard Server field** is updated only after saving or adding the service.   
You will need to revisit this section to select the **WireGuard Server** and save the service.   
Additionally, the **WireGuard Server** must be created on all servers within the group.</p>

- **Bandwidth Download** and **Bandwidth Upload** represent the connection speed that will be restricted by these parameters, in megabits per second, respectively.
- **Username Prefix** will be added at the beginning of the username during user creation and is used for uniqueness
- **Username Suffix** will be added at the end of the username during user creation and is also used for uniqueness
- **Link to Instruction** Provide the link to the instruction for the service, and it will be displayed in the client area as a separate button
- **Link to VPN Clients** Provide the link to the page for downloading VPN clients for the service, and it will be displayed in the client area as a separate button
- <div>**Automatic Setup** Please activate for automatic installation of the order. Otherwise, administrator approval is required.</div>

<div id="bkmrk--3"><div></div></div>

