bayrepo/hestiacp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Initial

Browse Source
This commit is contained in:
Alexey Berezhok
2024-03-19 22:05:27 +03:00
commit 346a50856b
1572 changed files with 182163 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

100
docs/docs/user-guide/account.md Normal file
View File

@@ -0,0 +1,100 @@
# Account
To access your account settings, click the <i class="fas fa-lg fa-fw fa-user-circle"><span class="visually-hidden">user</span></i> button in the top right.
## Security
### Password
The password requirements are as follows:
- At least 8 characters, 14 or more are recommended.
- At least 1 number.
- At least 1 capital letter and 1 lowercase letter.
If you want to generate a secure password, you can use [1Password’s generator](https://1password.com/password-generator/).
### Two-factor authentication (2FA)
1. In your account settings, check the box labeled **Enable two-factor authentication**.
2. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
3. Scan the QR code using an authentication app.
4. Save your **Account Recovery Code** somewhere safe, in case you lose access to your authenticator.
::: details Need a 2FA app?
If you do not have an authenticator app, here are a couple of recommendations.
- iCloud Keychain – [Windows](https://9to5mac.com/2022/07/25/icloud-passwords-windows-2fa-code/), [macOS](https://9to5mac.com/2021/11/16/use-safari-password-manager-and-2fa-autofill/), [iOS](https://9to5mac.com/2022/03/07/use-ios-15-2fa-code-generator-plus-autofill-iphone/)
- [Tofu Authenticator](https://www.tofuauth.com/) – Open-source, iOS only
- [Aegis Authenticator](https://getaegis.app/) – Open-source, Android only
- [Raivo OTP](https://github.com/raivo-otp/) – Open-source, iOS and macOS only
- [Google Authenticator](https://googleauthenticator.net/)
- [Microsoft Authenticator](https://www.microsoft.com/en-ca/security/mobile-authenticator-app)
- [Authy](https://authy.com/) – Free, has a cloud sync feature
- [1Password](https://1password.com/) – Paid password manager
- [Bitwarden](https://bitwarden.com/) – Password manager. 2FA in premium plan only
:::
### Login restrictions
Hestia has the following options to help you secure your account:
- Disable login into the account.
- Whitelist your IP address to login into your account.
### Security logs
The security logs contain various information, such as: changes to web domains, API access, backup creation, etc. Click the **<i class="fas fa-fw fa-history"></i> Logs** button to view them.
### Login history
On the security logs page, click the **<i class="fas fa-fw fa-binoculars"></i> Login history** button to see the login history. The history contains the time of login, IP address, and user agent of the browser that was used.
## SSH keys
Click the **<i class="fas fa-fw fa-key"></i> Manage SSH keys** button to view the installed keys.
### Adding an SSH key
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add SSH key** button.
2. Copy your public key in the text area.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
### Deleting an SSH key
1. Hover over the SSH key you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the SSH ID.
::: details Need to generate a key?
If you do not have an SSH key, here are a couple of ways to generate one.
- For Windows: [Putty](https://www.ssh.com/academy/ssh/putty/windows/puttygen#running-puttygen).
- For macOS and Linux use `ssh-keygen`.
You can also use an app to manage them:
- [1Password](https://developer.1password.com/docs/ssh/manage-keys/)
- [Termius](https://www.termius.com/)
:::
## API access keys
::: info
This option is disabled by default for standard users. An administrator needs to enable it in the server settings.
:::
Click the **<i class="fas fa-fw fa-key"></i> Access Keys** button to view the access keys. Access keys are used for the API to autenticate instead of using the username and password.
### Creating an access key
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add Access key** button.
2. Select the permission sets you want to enable.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
4. Copy the access key and the secret key. Make sure to save the secret key somewhere safe as it **cannot** be viewed once the page is closed.
### Deleting an access key
1. Hover over the access key you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the access key.

81
docs/docs/user-guide/backups.md Normal file
View File

@@ -0,0 +1,81 @@
# Backups
To manage your backups, navigate to the **Backups <i class="fas fa-fw fa-file-archive"></i>** tab.
## Manually creating a backup
Click the **<i class="fas fa-fw fa-plus-circle"></i> Create backup** button.
A popup will be shown with the following message:
**Task has been added to the queue. You will receive an email notification when your backup is ready for download.**
## Downloading a backup
1. Hover over the backup you want to download.
2. Click the <i class="fas fa-fw fa-file-download"><span class="visually-hidden">Download</span></i> icon on the right of the backup’s filename.
If the backup is stored on a remote server, the file is downloaded to the server and you will get notified by email when the download is available.
## Restoring a backup
1. Hover over the backup you want to restore.
2. Click the backup’s filename or the <i class="fas fa-fw fa-undo"><span class="visually-hidden">Restore</span></i> icon on the right of the backup’s filename.
3. Restore the backup in one of the following ways:
1. You can restore the whole backup by clicking the **<i class="fas fa-fw fa-undo"></i> Restore backup** button on the top right.
2. Restore multiple parts of the backup, by selecting them, then selecting **Restore** in the **Apply to selected** menu in the top right and clicking on the <i class="fas fa-fw fa-arrow-right"><span class="visually-hidden">Apply</span></i> button.
3. Restore one part of the backup by hovering over it and clicking the <i class="fas fa-fw fa-undo"><span class="visually-hidden">Restore</span></i> icon on the right.
## Deleting a backup
1. Hover over the backup you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the backup’s filename.
## Excluding components from backups
1. Click the **<i class="fas fa-fw fa-folder-minus"></i> Backup Exclusion** button.
2. Click the **<i class="fas fa-fw fa-pencil-alt"></i> Edit backup exclusions** button.
### Excluding a web domain
In the box labeled **Web Domains**, enter each domain you want to exclude, one per line.
To exclude a specific folder from a domain use the following syntax:
```bash
domain.tld:public_html/wp-content/uploads:public_html/cache
```
This will excude both `public_html/wp-content/uploads/` and `public_html/cache/` from that domain.
To exclude all domains, use `*`.
### Excluding a mail domain
In the box labeled **Mail Domains**, enter each domain you want to exclude, one per line.
To exclude only one or multiple mail account use the following syntax:
```bash
domain.tld:info:support
```
This will excude both `info@domain.tld` and `support@domain.tld`.
To exclude all domains, use `*`.
### Excluding a database
In the box labeled **Databases**, enter the name of each database you want to exclude, one per line.
To exclude all databases, use `*`.
### Excluding a user directory
In the box labeled **User Directories**, enter the name of each directory you want to exclude, one per line.
To exclude all directories, use `*`.
## Editing the number of backups
To edit the number of backups, please read the [Packages](../user-guide/packages.md) and [Users](../user-guide/users.md) documentation. You will need to create or edit a package, and assign it to the desired user.

30
docs/docs/user-guide/cron-jobs.md Normal file
View File

@@ -0,0 +1,30 @@
# Cron Jobs
To manage your cron jobs, navigate to the **Cron <i class="fas fa-fw fa-clock"></i>** tab.
## Toggling cron job notifications
1. To turn them off click the **<i class="fas fa-fw fa-toggle-off"></i> Turn off notifications** button.
2. To turn them back on click the **<i class="fas fa-fw fa-toggle-off"></i> Turn on notifications** button.
## Adding a cron job
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add job** button.
2. Enter the command you want to execute.
3. Enter the schedule on which you want to execute the command. You can use the generator to help you, or a tool such as [Crontab.guru](https://crontab.guru/).
## Editing a cron job
1. Hover over the job you want to edit.
2. Click the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon on the right of the job’s command.
## Suspending a cron job
1. Hover over the job you want to suspend.
2. Click the <i class="fas fa-fw fa-pause"><span class="visually-hidden">suspend</span></i> icon on the right of the job’s command.
3. To unsuspend it, click the <i class="fas fa-fw fa-play"><span class="visually-hidden">unsuspend</span></i> icon on the right of the job’s command.
## Deleting a cron job
1. Hover over the job you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the job’s command.

34
docs/docs/user-guide/databases.md Normal file
View File

@@ -0,0 +1,34 @@
# Databases
To manage your databases, navigate to the **DB <i class="fas fa-fw fa-database"></i>** tab.
## Adding a database
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add Database** button.
2. Fill out the fields. The name and username will be prefixed with `user_`.
3. Optionally, provide an email address where the login details will be sent.
4. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
Under **Advanced Options**, you are able to select the host (`localhost` by default) and charset (`utf8` by default).
## Editing a database
1. Hover over the database you want to edit.
2. Click the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon on the right of the database’s name. If you don’t want to change the password, keep the password field empty.
## Accessing a database
By default, **phpMyAdmin** and **phpPgAdmin** are accessible at `https://hostname.domain.tld/phpmyadmin` and `https://hostname.domain.tld/phppgadmin` respectively. You can also click the **<i class="fas fa-fw fa-database"></i> phpMyAdmin** and **<i class="fas fa-fw fa-database"></i> phpPgAdmin** buttons in the **DB <i class="fas fa-fw fa-database"></i>** tab.
For MySQL databases, if **phpMyAdmin Single Sign On** is enabled, hovering a database will show an <i class="fas fa-fw fa-sign-in-alt"><span class="visually-hidden">phpMyAdmin</span></i> icon. Click it to login to **phpMyAdmin** directly.
## Suspending a database
1. Hover over the database you want to suspend.
2. Click the <i class="fas fa-fw fa-pause"><span class="visually-hidden">suspend</span></i> icon on the right of the database’s name.
3. To unsuspend it, click the <i class="fas fa-fw fa-play"><span class="visually-hidden">unsuspend</span></i> icon on the right of the database’s name.
## Deleting a database
1. Hover over the database you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the database’s name. Both the database user and the database will get deleted.

125
docs/docs/user-guide/dns.md Normal file
View File

@@ -0,0 +1,125 @@
# DNS
To manage your DNS zones and records, navigate to the **DNS <i class="fas fa-fw fa-atlas"></i>** tab.
## Adding a DNS zone
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add DNS Zone** button.
2. Enter the domain name in the **Domain** field.
- Choose the appropriate template for the zone.
- If the domain requires different name servers, change them in the **Advanced Options** section.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Editing a DNS zone
1. Hover over the zone you want to edit.
2. Click the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon on the right of the zone’s domain.
3. Make the desired changes.
4. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Viewing DNSSEC public keys
1. Hover over the zone whose DNSSEC keys you want to see.
2. Click the <i class="fas fa-fw fa-key"><span class="visually-hidden">DNSSEC</span></i> icon on the right of the zone’s domain.
## Suspending a DNS zone
1. Hover over the zone you want to suspend.
2. Click the <i class="fas fa-fw fa-pause"><span class="visually-hidden">suspend</span></i> icon on the right of the zone’s domain.
3. To unsuspend it, click the <i class="fas fa-fw fa-play"><span class="visually-hidden">unsuspend</span></i> icon on the right of the zone’s domain.
## Deleting a DNS zone
1. Hover over the zone you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the zone’s domain.
## DNS zone configuration
### IP address
IP address that should be used for the root domain.
### Template
- **default**: Standard DNS template. Suitable for most usecases.
- **default-nomail**: Standard DNS template. Suitable for most usecases when you don’t want to host mail on Hestia.
- **gmail**: When your email provider is Google Workspace.
- **office365**: When your email provider is Microsoft 365 (Exchange).
- **zoho**: When your email provider is Zoho.
- **child-ns**: When you are going to use the domain as a name server.
### Expiration date
This date is not used by Hestia, but can be used as a reminder.
### SOA
A Start of Authority (SOA) record includes administrative information about your zone, as defined by the domain name system (DNS).
### TTL
Adjust the default time-to-live. A shorter TTL means faster changes, but results in more requests to the server. If you are going to change the IP, it might be helpful to decrease it to 300 seconds (5 min).
### DNSSEC
Enable DNSSEC to improve security. However, this setting requires some changes to at your domain registrar before it is active. For more information, see the [DNS cluster](../server-administration/dns.md) documentation.
## Adding a DNS record to a zone
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add Record** button.
2. Fill out the fields.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Editing a DNS record
1. Click the recordor the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon that appears on hover.
2. Make the desired changes.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Suspending a DNS record
1. Hover over the record you want to suspend.
2. Click the <i class="fas fa-fw fa-pause"><span class="visually-hidden">suspend</span></i> icon on the right of the record’s domain.
3. To unsuspend it, click the <i class="fas fa-fw fa-play"><span class="visually-hidden">unsuspend</span></i> icon on the right of the record’s domain.
## Deleting a DNS record
1. Hover over the record you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the record’s domain.
## DNS record configuration
### Record
The record name. `record`.domain.tld. Use `@` for root.
### Type
The following record types are supported:
- A
- AAAA
- CAA
- CNAME
- DNSKEY
- IPSECKEY
- KEY
- MX
- NS
- PTR
- SPF
- SRV
- TLSA
- TXT
### IP or value
IP or value of the record you want to use.
### Priority
Priority of the record. Only used for MX records
### TTL
Adjust the default time-to-live. A shorter TTL means faster changes, but results in more requests to the server. If you are going to change the IP, it might be helpful to decrease it to 300 seconds (5 min).

5
docs/docs/user-guide/file-manager.md Normal file
View File

@@ -0,0 +1,5 @@
# File Manager
To access the file manager, click the **<i class="fas fa-fw fa-folder-open"></i> Files** button in the top left.
The file manager Hestia uses is called FileGator. You can find more information about it on [their website](https://filegator.io/).

156
docs/docs/user-guide/mail-domains.md Normal file
View File

@@ -0,0 +1,156 @@
# Mail Domains
To manage your mail domains, navigate to the **Mail <i class="fas fa-fw fa-mail-bulk"></i>** tab.
## Adding a mail domain
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add Mail domain** button.
2. Enter your domain name.
3. Select the options you want to use.
4. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Editing a mail domain
1. Hover over the domain you want to edit.
2. Click the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon on the right of the mail domain.
3. Edit the fields.
4. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Suspending a web domain
1. Hover over the domain you want to suspend.
2. Click the <i class="fas fa-fw fa-pause"><span class="visually-hidden">suspend</span></i> icon on the right of the mail domain.
3. To unsuspend it, click the <i class="fas fa-fw fa-play"><span class="visually-hidden">unsuspend</span></i> icon on the right of the mail domain.
## Deleting a web domain
1. Hover over the domain you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the mail domain. Both the mail domain and **all** the mail accounts will get deleted.
## Mail domain configuration
### Webmail client
We currently support Roundcube, Rainloop and SnappyMail (optional install). You can also disable webmail access.
### Catch all email
This email address will receive all emails for this domain that are sent to users that don’t exist.
### Rate limit
::: info
This option is only available for the admin user.
:::
Set the limit for the amount of emails an account can send per hour.
### Spam filter
::: info
This option is not always available.
:::
Enable Spam Assassin for this domain.
### Antivirus
::: info
This option is not always available
:::
Enable ClamAV for this domain.
### DKIM
Enable DKIM for this domain.
### SSL
1. Check the **Enable SSL for this domain** box.
2. Check the **Use Let’s Encrypt to obtain SSL certificate** box to use Let’s Encrypt.
3. Depending on your requirements, you can enable **Enable automatic HTTPS redirection** or **Enable HTTP Strict Transport Security (HSTS)**.
4. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
If you want to use your own SSL certificate you can enter the SSL certificate in the text area.
If you are having issues with enabling Let’s Encrypt, please refer to our [SSL certificates](../server-administration/ssl-certificates.md) documentation.
### SMTP relay
This option allows the user to use a different SMTP relay than server defined one or bypass the default Exim route. This can enhance deliverability.
1. Check the **SMTP Relay** box and a form will appear.
2. Enter the information from your SMTP relay provider.
### Get DNS records
If you don’t host your DNS in Hestia, but you still want to use its email service, click the <i class="fas fa-atlas"><span class="visually-hidden">DNS</span></i> icon to view the DNS records you need to add to your DNS provider.
### Webmail
By default, the webmail is accessible at `https://webmail.domain.tld` or `https://mail.domain.tld` when SSL is enabled. Otherwise use `http://` instead.
## Adding a mail account to a domain
1. Click the mail domain.
2. Click **<i class="fas fa-fw fa-plus-circle"></i> Add Mail account** button.
3. Enter the account name (without the `@domain.tld` part) and a password.
4. Optionally, supply an email address that will receive the login details.
5. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
If required you can also modify the **Advanced Options**, which are explained below.
On the right side, you can see the methods to access your mail account via SMTP, IMAP and POP3.
## Editing a mail account
1. Hover over the account you want to edit.
2. Click the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon on the right of the mail account.
3. Edit the fields.
4. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Suspending a mail account
1. Hover over the account you want to suspend.
2. Click the <i class="fas fa-fw fa-pause"><span class="visually-hidden">suspend</span></i> icon on the right of the mail account.
3. To unsuspend it, click the <i class="fas fa-fw fa-play"><span class="visually-hidden">unsuspend</span></i> icon on the right of the mail account.
## Deleting a mail account
1. Hover over the account you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the mail account.
## Mail account configuration
### Quota
The maximum space the account is allowed to use. This includes mail, contacts, etc.
### Aliases
Add an alias to redirect mail to the main account. Enter the username only. For example: `alice`.
### Discard all mail
All incoming mail will not get forwarded and will get deleted.
### Do not store forwarded mail
If this option is selected, all forwarded mail will get deleted.
### Auto-Reply
Setup an auto-reply.
### Forward mail
Forward all incoming mail to the entered email address.
::: warning
A lot of spam filters may flag the forwarded mail as spam by default!
:::
### Rate limit
Set the limit for the amount of emails an account can send per hour.

5
docs/docs/user-guide/notifications.md Normal file
View File

@@ -0,0 +1,5 @@
# Notifications
To view your notifications, click the <i class="fas fa-lg fa-fw fa-bell"><span class="visually-hidden">notification</span></i> icon in the top right.
You can dismiss a notification by clicking the small red circle on its right.

124
docs/docs/user-guide/packages.md Normal file
View File

@@ -0,0 +1,124 @@
# Packages
To manage packages, log in as an **administrator** and navigate to the **Users <i class="fas fa-fw fa-users"></i>** tab.
## Adding a new package
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add Package** button.
2. Fill out the form. When clicking on <i class="fas fa-fw fa-infinity"><span class="visually-hidden">unlimited</span></i> icon, the limits will be set to unlimited.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Copying a package
1. Hover over the package you want to copy.
2. Click the <i class="fas fa-fw fa-clone"><span class="visually-hidden">copy</span></i> icon on the right of the package name.
## Editing a package
::: info
The **system** package can’t be edited or renamed.
:::
1. Hover over the package you want to edit.
2. Click the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon on the right of the package name.
## Deleting a package
::: info
The **system** package can’t be deleted.
:::
1. Hover over the package you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the package name.
## Importing existing packages from a different server
Packages are stored in `/usr/local/hestia/data/packages` as `package-name.pkg`. Simply copy these package files to other servers.
## Package configuration
::: info
Some options may not be available depending on your setup.
:::
### Quota
Total available storage space including the websites, email accounts, databases and the home folder. If you have enabled **File Quotas** during install or in the server settings, this value enforces the quota limit on websites, email accounts and the home folder. Databases are excluded.
### Bandwidth
Allocated bandwidth. Only outgoing traffic over web is accounted for.
There’s currently no methods of auto-suspending available.
### Backups
Maximum number of backups that can be stored.
## Web domains
### Web domains
Maximum number of web domains that can be created.
### Aliases
Maximum number of aliases that can be added per domain.
### Proxy Template
Default proxy template for created domains.
### Web Template
Default web template for created domains.
## DNS
### DNS Template
Default DNS template that get assigned on domain creation.
### DNS Domains
Maximum number of DNS domains that can be created.
### DNS records
Maximum number of DNS records that can be added per domain.
### Name Servers
Default name servers to be used by the user. Up to 8 different name servers can be added.
## Mail
### Mail Domains
Maximum number of mail domains that can be created.
### Mail accounts
Maximum number of mail accounts that can be added per domain.
### Rate limit
Maximum number of emails that accounts can send per hour.
## Databases
Maximum number of databases that can be created.
## System
### Cron jobs
Maximum number of cron jobs that can be created.
### Shell access
Select the shell that will be shown to the user when logging in via SSH.
::: warning
When set to `nologin`, SSH access is disabled but SFTP access is still allowed.
:::

16
docs/docs/user-guide/statistics.md Normal file
View File

@@ -0,0 +1,16 @@
# Statistics
To access the statistics, click the **<i class="fas fa-fw fa-chart-line"></i> Statistics** button in the top left.
This page will show the current user’s statistics, grouped per month. Here are the available statistics:
- Bandwidth usage
- Assigned IP addresses
- Disk usage, split by component
- Number of web domains and aliases
- Number of domains using SSL
- Number of DNS zones and records
- Number of mail domains and accounts
- Number of databases
- Number of cron jobs
- Number of backups

72
docs/docs/user-guide/users.md Normal file
View File

@@ -0,0 +1,72 @@
# Users
To manage users, log in as an **administrator** and navigate to the **Users <i class="fas fa-fw fa-users"></i>** tab.
## Adding a user
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add User** button.
2. Fill out the fields.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Impersonating a user
1. Hover over the user you want to login as.
2. Click the <i class="fas fa-fw fa-sign-in-alt"><span class="visually-hidden">login as</span></i> icon on the right of the user’s name and email.
3. You are now logged in as the user. As such, any action you perform will be done as this user.
## Editing a user
The settings specified below are only available to administrators. For the regular settings, you can refer to the [Account Management](../user-guide/account.md) documentation.
To edit a user you can either impersonate them and click the <i class="fas fa-lg fa-fw fa-user-circle"><span class="visually-hidden">user</span></i> icon in the top right, or follow these steps:
1. Hover over the user you want to edit.
2. Click the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon on the right of the user’s name and email.
## Suspending a user
1. Hover over the user you want to suspend.
2. Click the <i class="fas fa-fw fa-pause"><span class="visually-hidden">suspend</span></i> icon on the right of the user’s name and email.
## Deleting a user
1. Hover over the user you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete</span></i> icon on the right of the user’s name and email.
## User configuration
### Disabling control panel access
To remove Control Panel access from a user, check the box labelled: **Do not allow user to log in to Control Panel**.
### Changing role
To change a user’s role change the **Role** value from the dropdown.
::: warning
Assigning the **Administrator** role to a user will enable them to see and edit other users. They will not be able to edit the **admin** user, but will be able to see them, unless disabled in the server settings.
:::
### Changing package
To change a user’s package, change the **Package** value from the dropdown.
### Changing SSH access
To change a user’s SSH access, click the **Advanced Options** button, then change the **SSH Access** value from the dropdown.
::: warning
Using the **nologin** shell will _not_ disable SFTP access.
:::
### Changing PHP CLI version
To change a user’s PHP CLI version, click the **Advanced Options** button, then change the **PHP CLI Version** value from the dropdown.
### Changing default name servers
To change a user’s default name servers, click the **Advanced Options** button, then edit the **Default Name Servers** fields.
::: warning
At least 2 default name servers are necessary. This is to provide redundancy, in case one of them fails to answer. In fact, it is suggested that both name servers be on separate servers, for better resilience. If you are the system administrator and would like to set this up, refer to our [DNS Cluster documentation](../server-administration/dns.md#dns-cluster-setup).
:::

129
docs/docs/user-guide/web-domains.md Normal file
View File

@@ -0,0 +1,129 @@
# Web Domains
To manage your web domains, navigate to the **Web <i class="fas fa-fw fa-globe-americas"></i>** tab.
## Adding a web domain
1. Click the **<i class="fas fa-fw fa-plus-circle"></i> Add Web Domain** button.
2. Enter the domain name in the **Domain** field.
- If you wish to manage this domain’s DNS in Hestia, check the box labeled **Create DNS zone**
- If you wish to enable mail for this domain, check the box labeled **Enable mail for this domain**.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Installing an app
1. Click the domain name or the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon that appears on hover.
2. Click the **<i class="fas fa-fw fa-magic"></i> Quick install App** button in the top right.
3. Select the application you want to install and click the **Setup** button.
4. Fill out the fields. If the app uses a database, you will have the option to auto-create a database or use an existing one.
5. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
::: warning
Depending on the application you chose to install, this can take 30 seconds or longer. Do not reload or close the tab!
:::
## Editing a web domain
1. Click the domain name or the <i class="fas fa-fw fa-pencil-alt"><span class="visually-hidden">edit</span></i> icon that appears on hover.
2. Make your changes. The options are explained below.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
## Viewing access and error logs
1. Hover over the domain whose logs you want to view.
2. Click the <i class="fas fa-fw fa-binoculars"><span class="visually-hidden">logs</span></i> icon.
3. At the top of the page, you have the possibility to download the logs or view the error logs instead.
## Suspending a web domain
1. Hover over the domain you want to suspend.
2. Click the <i class="fas fa-fw fa-pause"><span class="visually-hidden">suspend</span></i> icon on the right of the web domain.
## Deleting a web domain
1. Hover over the domain you want to delete.
2. Click the <i class="fas fa-fw fa-trash"><span class="visually-hidden">delete user</span></i> icon on the right of the web domain. **Both** the web domain and the linked FTP accounts will get deleted.
## Web domain configuration
### Enabling statistics
1. Chose **awstats** in the selection boxed labelled **Web Statistics**.
2. If desired, enter a username and password.
3. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
4. Navigate to `https://domain.tld/vstats/` to view the stats.
### Managing redirections
1. Check the **Enable domain redirection** box.
2. Select the option you want. When selecting **Redirect visitors to a custom domain or web address** you have to option to select the HTTP status code (301 by default).
::: warning
If your domain is an [internationalized domain name (IDN)](https://en.wikipedia.org/wiki/Internationalized_domain_name) containing special characters, even if you select `www.domain.tld` or `domain.tld`, it will convert the domain to [punycode](https://en.wikipedia.org/wiki/Punycode) and select **Redirect visitors to a custom domain or web address**.
:::
### Enabling SSL
1. Check the **Enable SSL for this domain** box.
2. Check the **Use Let’s Encrypt to obtain SSL certificate** box to use Let’s Encrypt.
3. Depending on your requirements, you can enable **Enable automatic HTTPS redirection** or **Enable HTTP Strict Transport Security (HSTS)**.
4. Click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
If you want to use your own SSL certificate you can enter the SSL certificate in the text area.
If you are having issues with enabling Let’s Encrypt, please refer to our [SSL certificates](../server-administration/ssl-certificates.md) documentation.
### Changing PHP version
::: info
This option is not always available. It may be disabled in the server settings. Please contact your server administrator for more information.
:::
1. Select the desired PHP version in the **Backend Template** field.
### Using a different root directory
1. Check the **Custom document root** box.
2. Select the domain name where you want this domain to point.
3. Select the path. For example, `/public/` will link to `/home/user/web/domain.tld/public_html/public/`.
### Additional FTP accounts
1. Check the **Additional FTP accounts** box.
2. Enter a username and a password (or generate one). The username will be prefixed by `user_`.
3. Enter the path the account will be able to access.
4. Optionally, provide an email address where the login details will be sent.
To add another FTP account, click the **Add FTP account** button, then click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
To delete an FTP account, click the **DELETE** link on the right of its name, then click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
To change the password, update the password field, then click the **<i class="fas fa-fw fa-save"></i> Save** button in the top right.
### Proxy templates
::: info
Depending on the server setup, this option may not be available.
:::
- **default**: All purpose template. Suitable for most usecases.
- **caching**: Template with proxy cache enabled. Suitable for mostly static content, for example: blogs or news websites.
- **hosting**: Similar to default.
Any custom templates will also show up here.
::: tip
Any custom templates starting with `caching-` will allow the use of the **<i class="fas fa-fw fa-trash"></i> Purge Nginx Cache** button. Make sure a `.sh` file exists for `caching-my-template` with at least [this content](https://github.com/hestiacp/hestiacp/blob/main/install/deb/templates/web/nginx/caching.sh)
:::
### Web templates
For servers running Apache2 and Nginx, the **default** template will work fine.
For servers running Nginx only, pick the template matching the app name you are going to use.
### Managing Nginx caching
When Nginx caching is enabled (using FastCGI cache or with a caching-enabled template), you can purge the cache via the **<i class="fas fa-fw fa-trash"></i> Purge Nginx Cache** button.
When using Nginx only, you can enable FastCGI caching using the **Enable FastCGI Cache** box. When checked, an option is shown to determine for how long the cache is considered valid.