Skip to content

Commit 311a884

Browse files
authored
Sync changes of hestiacp#3605 to docs (hestiacp#3620)
1 parent 19f37bb commit 311a884

File tree

7 files changed

+58
-58
lines changed

7 files changed

+58
-58
lines changed

bin/v-add-mail-domain-reject

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
#!/bin/bash
2-
# info: add mail domain reject spam
2+
# info: add mail domain reject spam support
33
# options: USER DOMAIN
44
# labels: mail
55
#
6-
# example: v-add-mail-domain-antivirus admin mydomain.tld
6+
# example: v-add-mail-domain-reject admin mydomain.tld
77
#
8-
# The function enables clamav scan for incoming emails.
8+
# The function enables spam rejection for incoming emails.
99

1010
#----------------------------------------------------------#
1111
# Variable&Function #

bin/v-change-dns-domain-dnssec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# info: change dns domain dnssec status
33
# options: USER DOMAIN STATUS
44
#
5-
# example: v-change-dns-domain-status admin domain.pp.ua yes
5+
# example: v-change-dns-domain-dnssec admin domain.pp.ua yes
66

77
#----------------------------------------------------------#
88
# Variables & Functions #

bin/v-change-mail-account-rate-limit

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
#!/bin/bash
2-
# info: change mail domain rate limit
2+
# info: change mail account rate limit
33
# options: USER DOMAIN ACCOUNT RATE
44
#
5-
# example: v-change-mail-domain-quota admin mydomain.tld user01 100
5+
# example: v-change-mail-account-rate-limit admin mydomain.tld user01 100
66
#
77
# This function changes email account rate limit. Use system to use domain or "server" setting
88

bin/v-change-mail-domain-rate-limit

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#!/bin/bash
2-
# info: change mail account rate limit
3-
# options: USER DOMAIN ACCOUNT RATE
2+
# info: change mail domain rate limit
3+
# options: USER DOMAIN RATE
44
#
5-
# example: v-change-mail-account-quota admin mydomain.tld user01 100
5+
# example: v-change-mail-domain-rate-limit admin mydomain.tld 100
66
#
7-
# This function changes email account rate limit for the domain. account specific setting will overwrite domain setting!
7+
# This function changes email account rate limit for the domain. Account specific setting will overwrite domain setting!
88

99
#----------------------------------------------------------#
1010
# Variables & Functions #

bin/v-delete-mail-domain-reject

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
# options: USER DOMAIN
44
# labels: mail
55
#
6-
# example: v-delete-mail-domain-antispam admin mydomain.tld
6+
# example: v-delete-mail-domain-reject admin mydomain.tld
77
#
8-
# The function disable spamassasin for incoming emails.
8+
# The function disables spam rejection for incoming emails.
99

1010
#----------------------------------------------------------#
1111
# Variable&Function #

bin/v-list-user-backup

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# info: list user backup
33
# options: USER BACKUP [FORMAT]
44
#
5-
# example: v-list-user-backups admin admin.2019-05-19_03-31-30.tar
5+
# example: v-list-user-backup admin admin.2019-05-19_03-31-30.tar
66
#
77
# This function of obtaining the list of backup parameters. This call, just as
88
# all v_list_* calls, supports 3 formats - json, shell and plain.

docs/docs/reference/cli.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -504,17 +504,17 @@ This function adds DKIM signature to outgoing domain emails.
504504

505505
## v-add-mail-domain-reject
506506

507-
add mail domain reject spam
507+
add mail domain reject spam support
508508

509509
**Options**: `USER` `DOMAIN`
510510

511511
**Examples**:
512512

513513
```bash
514-
v-add-mail-domain-antivirus admin mydomain.tld
514+
v-add-mail-domain-reject admin mydomain.tld
515515
```
516516

517-
The function enables clamav scan for incoming emails.
517+
The function enables spam rejection for incoming emails.
518518

519519
## v-add-mail-domain-smtp-relay
520520

@@ -641,21 +641,21 @@ This function enables the system firewall.
641641

642642
## v-add-sys-ip
643643

644-
add system ip address
644+
add system IP address
645645

646646
**Options**: `IP` `NETMASK` `[INTERFACE]` `[USER]` `[IP_STATUS]` `[IP_NAME]` `[NAT_IP]`
647647

648648
**Examples**:
649649

650650
```bash
651-
v-add-sys-ip 216.239.32.21 255.255.255.0
651+
v-add-sys-ip 203.0.113.1 255.255.255.0
652652
```
653653

654-
This function adds ip address into a system. It also creates rc scripts. You
655-
can specify ip name which will be used as root domain for temporary aliases.
654+
This function adds IP address into a system. It also creates rc scripts. You
655+
can specify IP name which will be used as root domain for temporary aliases.
656656
For example, if you set a1.myhosting.com as name, each new domain created on
657-
this ip will automatically receive alias $domain.a1.myhosting.com. Of course
658-
you must have wildcard record \*.a1.myhosting.com pointed to ip. This feature
657+
this IP will automatically receive alias $domain.a1.myhosting.com. Of course
658+
you must have wildcard record \*.a1.myhosting.com pointed to IP. This feature
659659
is very handy when customer wants to test domain before dns migration.
660660

661661
## v-add-sys-pma-sso
@@ -1177,7 +1177,7 @@ change dns domain dnssec status
11771177
**Examples**:
11781178

11791179
```bash
1180-
v-change-dns-domain-status admin domain.pp.ua yes
1180+
v-change-dns-domain-dnssec admin domain.pp.ua yes
11811181
```
11821182

11831183
## v-change-dns-domain-exp
@@ -1355,14 +1355,14 @@ This function changes email account disk quota.
13551355

13561356
## v-change-mail-account-rate-limit
13571357

1358-
change mail domain rate limit
1358+
change mail account rate limit
13591359

13601360
**Options**: `USER` `DOMAIN` `ACCOUNT` `RATE`
13611361

13621362
**Examples**:
13631363

13641364
```bash
1365-
v-change-mail-domain-quota admin mydomain.tld user01 100
1365+
v-change-mail-account-rate-limit admin mydomain.tld user01 100
13661366
```
13671367

13681368
This function changes email account rate limit. Use system to use domain or "server" setting
@@ -1383,17 +1383,17 @@ This function changes mail domain catchall.
13831383

13841384
## v-change-mail-domain-rate-limit
13851385

1386-
change mail account rate limit
1386+
change mail domain rate limit
13871387

1388-
**Options**: `USER` `DOMAIN` `ACCOUNT` `RATE`
1388+
**Options**: `USER` `DOMAIN` `RATE`
13891389

13901390
**Examples**:
13911391

13921392
```bash
1393-
v-change-mail-account-quota admin mydomain.tld user01 100
1393+
v-change-mail-domain-rate-limit admin mydomain.tld 100
13941394
```
13951395

1396-
This function changes email account rate limit for the domain. account specific setting will overwrite domain setting!
1396+
This function changes email account rate limit for the domain. Account specific setting will overwrite domain setting!
13971397

13981398
## v-change-mail-domain-sslcert
13991399

@@ -1534,59 +1534,59 @@ This function for changing system hostname.
15341534

15351535
## v-change-sys-ip-name
15361536

1537-
change ip name
1537+
change IP name
15381538

15391539
**Options**: `IP` `NAME`
15401540

15411541
**Examples**:
15421542

15431543
```bash
1544-
v-change-sys-ip-name 80.122.52.70 acme.com
1544+
v-change-sys-ip-name 203.0.113.1 acme.com
15451545
```
15461546

1547-
This function for changing dns domain associated with ip.
1547+
This function for changing dns domain associated with IP.
15481548

15491549
## v-change-sys-ip-nat
15501550

1551-
change ip nat address
1551+
change NAT IP address
15521552

15531553
**Options**: `IP` `NAT_IP` `[RESTART]`
15541554

15551555
**Examples**:
15561556

15571557
```bash
1558-
v-change-sys-ip-nat 185.209.50.140 10.110.104.205
1558+
v-change-sys-ip-nat 10.0.0.1 203.0.113.1
15591559
```
15601560

1561-
This function for changing nat ip associated with ip.
1561+
This function for changing NAT IP associated with IP.
15621562

15631563
## v-change-sys-ip-owner
15641564

1565-
change ip owner
1565+
change IP owner
15661566

15671567
**Options**: `IP` `USER`
15681568

15691569
**Examples**:
15701570

15711571
```bash
1572-
v-change-sys-ip-owner 91.198.136.14 admin
1572+
v-change-sys-ip-owner 203.0.113.1 admin
15731573
```
15741574

1575-
This function of changing ip address ownership.
1575+
This function of changing IP address ownership.
15761576

15771577
## v-change-sys-ip-status
15781578

1579-
change ip status
1579+
change IP status
15801580

15811581
**Options**: `IP` `IP_STATUS`
15821582

15831583
**Examples**:
15841584

15851585
```bash
1586-
v-change-sys-ip-status 91.198.136.14 yourstatus
1586+
v-change-sys-ip-status 203.0.113.1 yourstatus
15871587
```
15881588

1589-
This function of changing an ip address's status.
1589+
This function of changing an IP address's status.
15901590

15911591
## v-change-sys-language
15921592

@@ -2689,10 +2689,10 @@ delete mail domain reject spam support
26892689
**Examples**:
26902690

26912691
```bash
2692-
v-delete-mail-domain-antispam admin mydomain.tld
2692+
v-delete-mail-domain-reject admin mydomain.tld
26932693
```
26942694

2695-
The function disable spamassasin for incoming emails.
2695+
The function disables spam rejection for incoming emails.
26962696

26972697
## v-delete-mail-domain-smtp-relay
26982698

@@ -2831,18 +2831,18 @@ This function disables firewall support
28312831

28322832
## v-delete-sys-ip
28332833

2834-
delete system ip
2834+
delete system IP
28352835

28362836
**Options**: `IP`
28372837

28382838
**Examples**:
28392839

28402840
```bash
2841-
v-delete-sys-ip 212.42.76.210
2841+
v-delete-sys-ip 203.0.113.1
28422842
```
28432843

2844-
This function for deleting a system ip. It does not allow to delete first ip
2845-
on interface and do not allow to delete ip which is used by a web domain.
2844+
This function for deleting a system IP. It does not allow to delete first IP
2845+
on interface and do not allow to delete IP which is used by a web domain.
28462846

28472847
## v-delete-sys-mail-queue
28482848

@@ -4074,25 +4074,25 @@ This function for obtaining the list of network interfaces.
40744074

40754075
## v-list-sys-ip
40764076

4077-
list system ip
4077+
list system IP
40784078

40794079
**Options**: `IP` `[FORMAT]`
40804080

40814081
**Examples**:
40824082

40834083
```bash
4084-
v-list-sys-ip 116.203.78.202
4084+
v-list-sys-ip 203.0.113.1
40854085
```
40864086

4087-
This function for getting the list of system ip parameters.
4087+
This function for getting the list of system IP parameters.
40884088

40894089
## v-list-sys-ips
40904090

4091-
list system ips
4091+
list system IPs
40924092

40934093
**Options**: `[FORMAT]`
40944094

4095-
This function for obtaining the list of system ip addresses.
4095+
This function for obtaining the list of system IP addresses.
40964096

40974097
## v-list-sys-languages
40984098

@@ -4300,7 +4300,7 @@ list user backup
43004300
**Examples**:
43014301

43024302
```bash
4303-
v-list-user-backups admin admin.2019-05-19_03-31-30.tar
4303+
v-list-user-backup admin admin.2019-05-19_03-31-30.tar
43044304
```
43054305

43064306
This function of obtaining the list of backup parameters. This call, just as
@@ -4336,7 +4336,7 @@ This function for obtaining the list of available user backups.
43364336

43374337
## v-list-user-ips
43384338

4339-
list user ips
4339+
list user IPs
43404340

43414341
**Options**: `USER` `[FORMAT]`
43424342

@@ -4346,7 +4346,7 @@ list user ips
43464346
v-list-user-ips admin
43474347
```
43484348

4349-
This function for obtaining the list of available ip addresses.
4349+
This function for obtaining the list of available IP addresses.
43504350

43514351
## v-list-user-log
43524352

@@ -5886,7 +5886,7 @@ Downloads and compiles/installs packages from GitHub repositories
58865886

58875887
## v-update-sys-ip
58885888

5889-
update system ip
5889+
update system IP
58905890

58915891
**Options**: –
58925892

@@ -5897,8 +5897,8 @@ v-update-sys-ip
58975897
# Intended for internal usage
58985898
```
58995899

5900-
This function scans configured ip in the system and register them with hestia
5901-
internal database. This call is intended for use on vps servers, where ip is
5900+
This function scans configured IP in the system and register them with Hestia
5901+
internal database. This call is intended for use on vps servers, where IP is
59025902
set by hypervisor.
59035903

59045904
## v-update-sys-ip-counters

0 commit comments

Comments
 (0)