Merge pull request #299 from smetsliam/main

Update docs
This commit is contained in:
Stefan Pejcic 2024-12-16 12:34:58 +01:00 committed by GitHub
commit d1677ce98a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 37 additions and 37 deletions

View File

@ -4,7 +4,7 @@ sidebar_position: 6
# Notifications
Notifications are accesible from the notification icon in upper right corner.
Notifications are accessible from the notification icon in upper right corner.
![notifications center](/img/admin/notifications_center.png)
@ -23,7 +23,7 @@ OpenPanel records the following actions:
- high swap usage
- dns changed
Each notification type can be disabled and treshold limits can be set by the Admin user.
Each notification type can be disabled and threshold limits can be set by the Admin user.
<Tabs>
<TabItem value="openadmin-notifications-view" label="With OpenAdmin" default>
@ -72,13 +72,13 @@ On Server Reboot
If service is inactive:
![service](/img/admin/dashboard/service.png)
If CPU usage is over a treshold:
If CPU usage is over a threshold:
![cpu](/img/admin/dashboard/cpu.png)
If new version of OpenPanel is available:
![update](/img/admin/dashboard/update.png)
If Memory usage is over a treshold:
If Memory usage is over a threshold:
![ram](/img/admin/dashboard/ram.png)
If system is running out of disk space:
@ -102,7 +102,7 @@ To configure your own SMTP for email delivery, you need to update values:
- mail_use_ssl - default is True
- mail_username - email address to use for sending
- mail_password - password for email address
- mail_default_sender - email to display, defauls is same as mail_username
- mail_default_sender - email to display, defaults is same as mail_username
Each value is configured using `opencli config update` option. examples:

View File

@ -21,7 +21,7 @@ The status of the Mail Server service is displayed at the top of the page, where
The current status of the webmail client is shown under "Webmail Software," along with the total number of email accounts.
![maila ctions](/img/admin/mail_actions.png)
![mail_actions](/img/admin/mail_actions.png)
## MailServer Stack
@ -29,7 +29,7 @@ Administrators can set and configure different services based on their needs:
![mailserver stack](/img/admin/mailserver_stack.png)
Changes to this services will interupt current email traffic and restart the mailserver.
Changes to this service will interrupt current email traffic and restart the mailserver.
Advanced users can edit the `/usr/local/mail/openmail/mailserver.env` and `/usr/local/mail/openmail/compose.yml` files directly through the interface.
@ -40,7 +40,7 @@ Advanced users can edit the `/usr/local/mail/openmail/mailserver.env` and `/usr/
An SMTP relay service (aka relay host / smarthost) is an MTA that relays (forwards) mail on behalf of third parties (it does not manage the mail domains).
You should only configur this when you have some external service for outgoing emails, like SMTP2GO or self-hosted Proxmox Mail Gateway.
You should only configure this when you have some external service for outgoing emails, like SMTP2GO or self-hosted Proxmox Mail Gateway.
![relay hosts](/img/admin/relay_hosts.png)

View File

@ -72,7 +72,7 @@ opencli plan-list --json
<Tabs>
<TabItem value="openadmin-plan-new" label="With OpenAdmin" default>
To create a new hosting plan click on the 'Create new plan' nutton and set the desired limits for the plan.
To create a new hosting plan click on the 'Create new plan' button and set the desired limits for the plan.
![openadmin create new plan](/img/admin/adminpanel_plans_create_new.gif)
@ -132,7 +132,7 @@ opencli plan-usage 2
| id | username | email | plan_name | registered_date |
+----+----------+-------+----------------+---------------------+
| 2 | rasa | rasa | cloud_4_apache | 2023-11-30 10:33:52 |
| 3 | aas | sasa | cloud_4_apache | 2023-11-30 12:01:49 |
| 3 | aas | aas | cloud_4_apache | 2023-11-30 12:01:49 |
+----+----------+-------+----------------+---------------------+
```

View File

@ -32,7 +32,7 @@ The firewall settings page provides multiple tabs:
- IPv4 - View and manage IPv4 firewall rules
- IPv6 - View and manage IPv6 firewall rules
- Settings - Manage UFW settings
- Blacklists - Enable/disable blaklists
- Blacklists - Enable/disable blacklists
- Logs - view the UFW service log
### View rules
@ -50,7 +50,7 @@ To create a new rule click on the 'Add Rule' button and in the modal choose 'ALL
### Delete Rules
To delete a rule click on the 'Delete' link next to it, and in the confirmaiton modal click on 'Delete' button.
To delete a rule click on the 'Delete' link next to it, and in the confirmation modal click on 'Delete' button.
![openadmin firewall delete rule](/img/admin/adminpanel_firewall_delete_rule.png)
@ -71,9 +71,9 @@ The following settings are available:
The following tools are available:
- **Export IPv4 rules** - click to download dall existing IPv4 rules form the UFW service.
- **Export IPv6 rules** - click to download dall existing IPv6 rules form the UFW service.
- **Restrict access to Cloudflare only** - block access to this server for traffic not coming from [Cloudflare IP addresses](https://www.cloudflare.com/ips/). This will prevent direct access to the server IP and only allow traffic from Cloudflare netwrork. This is useful when your domains are configured to use the Cloudflare proxy, and you want to block direct access that bypasses Cloudflare's protection. **NOTE: This setting affects all users and their services.**
- **Export IPv4 rules** - click to download all existing IPv4 rules form the UFW service.
- **Export IPv6 rules** - click to download all existing IPv6 rules form the UFW service.
- **Restrict access to Cloudflare only** - block access to this server for traffic not coming from [Cloudflare IP addresses](https://www.cloudflare.com/ips/). This will prevent direct access to the server IP and only allow traffic from Cloudflare network. This is useful when your domains are configured to use the Cloudflare proxy, and you want to block direct access that bypasses Cloudflare's protection. **NOTE: This setting affects all users and their services.**
- **Reset ports for all users** - delete all existing UFW rules and open ports required by OpenPanel, plus custom ports for users.
@ -94,7 +94,7 @@ Default blacklists:
| AbuseIPDB (DISABLED) | [https://api.abuseipdb.com/api/v2/blacklist](https://api.abuseipdb.com/api/v2/blacklist) |
| OpenPanel | [https://api.openpanel.co/blocklist.txt](https://api.openpanel.co/blocklist.txt) |
| Spamhaus DROP | [https://www.spamhaus.org/drop/drop.lasso](https://www.spamhaus.org/drop/drop.lasso) |
| Spamhaus EDROP | [https://www.spamhaus.org/drop/edrop.lasso](https://www.spamhaus.org/drop/edrop.lasso) |
| Spamhaus DROP | [https://www.spamhaus.org/drop/edrop.lasso](https://www.spamhaus.org/drop/edrop.lasso) |
| DShield | [https://www.dshield.org/feeds/suspiciousdomains_Low.txt](https://www.dshield.org/feeds/suspiciousdomains_Low.txt) |
| FireHOL level1 | [https://raw.githubusercontent.com/firehol/blocklist-ipsets/master/firehol_level1.netset](https://raw.githubusercontent.com/firehol/blocklist-ipsets/master/firehol_level1.netset) |
| FireHOL level2 | [https://raw.githubusercontent.com/firehol/blocklist-ipsets/master/firehol_level2.netset](https://raw.githubusercontent.com/firehol/blocklist-ipsets/master/firehol_level2.netset) |

View File

@ -42,7 +42,7 @@ You can follow user-friendly guides to easily customize ModSecurity rules, adapt
## Enable ModSecurity for existing domains
After installing ModSecurioty only new domains that users add will by default have ModSecurity activate, and for existing users this process can be performed by the administrator from this page or from each user panel individually. To enable ModSecurity on all domains owneed by a user, select the user anc click on 'Enable' button.
After installing ModSecurity only new domains that users add will by default have ModSecurity activate, and for existing users this process can be performed by the administrator from this page or from each user panel individually. To enable ModSecurity on all domains owned by a user, select the user anc click on 'Enable' button.
![openadmin modsec settings](/img/admin/adminpanel_modsec_use.png)

View File

@ -28,7 +28,7 @@ Here are tutorials for some popular domain providers:
- [GoDaddy](https://uk.godaddy.com/help/add-custom-hostnames-12320)
- [NameCheap](https://www.namecheap.com/support/knowledgebase/article.aspx/768/10/how-do-i-register-personal-nameservers-for-my-domain/#:~:text=Click%20on%20the%20Manage%20option,5.)
To add nameservers from OpenAdmin navgiate to Settings > OpenPanel and set nameservers in ns1 and ns2 fields and click on save:
To add nameservers from OpenAdmin navigate to Settings > OpenPanel and set nameservers in ns1 and ns2 fields and click on save:
![openpanel add nameservers](/img/admin/openadmin_add_ns.png)
@ -39,9 +39,9 @@ opencli config update ns2 your_ns2.domain.com
```
:::info
After creating nameservers it can take up to 12h for the records to be globally accessible. Use a tool sush as [whatsmydns.net](https://www.whatsmydns.net/) to monitor the status.
After creating nameservers it can take up to 12h for the records to be globally accessible. Use a tool such as [whatsmydns.net](https://www.whatsmydns.net/) to monitor the status.
If you still experience problems after the propagation process, then please check this guide: [dns server not responding to reqeuests](https://community.openpanel.co/d/5-dns-server-does-not-respond-to-request-for-domain-zone).
If you still experience problems after the propagation process, then please check this guide: [dns server not responding to requests](https://community.openpanel.co/d/5-dns-server-does-not-respond-to-request-for-domain-zone).
:::
@ -96,7 +96,7 @@ Redis feature enables the [REDIS page](/docs/panel/caching/Redis/) where users c
Memcached feature enables the [Memcached page](/docs/panel/caching/Memcached/) where users can view Memcached port (`11211`), view logs, set memory limits and enable/disable service.
### ElasticSearch
Memcached feature enables the [ElasticSearch page](/docs/panel/caching/elasticsearch/) where users can view WlasticSearch port (`9200`), view logs, set memory limits and enable/disable service.
Memcached feature enables the [ElasticSearch page](/docs/panel/caching/elasticsearch/) where users can view ElasticSearch port (`9200`), view logs, set memory limits and enable/disable service.
### Resource Usage
usage feature enables the [Resource Usage page](/docs/panel/analytics/resource_usage/) where users can view real-time information about the server's CPU and RAM usage.

View File

@ -444,7 +444,7 @@ opencli user-unsuspend filip
<Tabs>
<TabItem value="openadmin-user-username" label="With OpenAdmin" default>
To Rename a user, click on the 'Edit Information' link for the user, then change the adress in 'Username' field and click on 'Save changes'.
To Rename a user, click on the 'Edit Information' link for the user, then change the address in 'Username' field and click on 'Save changes'.
Step 1. | Step 2.
:-------------------------:|:-------------------------:
@ -475,7 +475,7 @@ User 'stefan' successfully renamed to 'pejcic'.
<Tabs>
<TabItem value="openadmin-user-email" label="With OpenAdmin" default>
To change email address for a user, click on the 'Edit Information' link for the user, then change the adress in 'Email address' field and click on 'Save changes'.
To change email address for a user, click on the 'Edit Information' link for the user, then change the address in 'Email address' field and click on 'Save changes'.
Step 1. | Step 2.
:-------------------------:|:-------------------------:
@ -568,7 +568,7 @@ Step 1. | Step 2.
To allow users to install new services and have unrestricted access inside their container, run the following command:
```bash
opencli user-sudo <USERNAME> <ENABLE/DIASBLE/STATUS>
opencli user-sudo <USERNAME> <ENABLE/DISABLE/STATUS>
```
Example:

View File

@ -34,7 +34,7 @@ OpenPanel applies the following rules when you create databases and users:
Database names may **only** use lowercase letters (`az`) and digits (`09`).
- Database name cannot contain less than **1** character.
- Databaase name cannot contain more than **64** characters.
- Database name cannot contain more than **64** characters.
Database users may **only** use lowercase letters (`az`) and digits (`09`).
@ -110,4 +110,4 @@ Currently reserved usernames:
- openpanel
- openadmin
To reserve a certail username, simply add it to the forbidden_usernames.txt file.
To reserve a certain username, simply add it to the forbidden_usernames.txt file.

View File

@ -20,7 +20,7 @@ Login to phpMyAdmin from the OpenPanel interface and note the version under 'Ser
Login to OpenPanel and navigate to Process Manager to view under which PHP version is the phpMyAdmin interface running.
![process manager check php verison](https://i.postimg.cc/2jXTJRQ5/2024-08-02-19-07.png)
![process manager check php version](https://i.postimg.cc/2jXTJRQ5/2024-08-02-19-07.png)
### Step 2. Edit php.ini file

View File

@ -38,7 +38,7 @@ Once enabled, the feature becomes instantly available to all users, appearing in
## Set pre-installed services
OpenPanel uses [docker images](https://dev.openpanel.com/images/) as the base for each hosting plan. Based on the docker image, different services can be set per plan/user. For examples, we provide 2 docker iamges, one that has nginx pre-installed and another that uses apache. By creating a custom docker image, you can set in that image what to be pre-installed when you create a new user, for exmaple, set mariadb instead of mysql or install php ioncube loader extension.
OpenPanel uses [docker images](https://dev.openpanel.com/images/) as the base for each hosting plan. Based on the docker image, different services can be set per plan/user. For examples, we provide 2 docker images, one that has nginx pre-installed and another that uses apache. By creating a custom docker image, you can set in that image what to be pre-installed when you create a new user, for example, set mariadb instead of mysql or install php ioncube loader extension.
To add a custom service pre-installed for users:
@ -72,7 +72,7 @@ To translate OpenPanel to another language follow these steps:
## Set custom branding
Custom brand name and logo can be set from [OpenAdmnin > Settings > OpenPanel](/docs/admin/settings/openpanel/#branding) page.
Custom brand name and logo can be set from [OpenAdmin > Settings > OpenPanel](/docs/admin/settings/openpanel/#branding) page.
To set a custom name visible in the OpenPanel sidebar and on login pages, enter the desired name in the "Brand name" option. Alternatively, to display a logo instead, provide the URL in the "Logo image" field and save the changes.
@ -154,7 +154,7 @@ For example, to edit the sidebar and hide the OpenPanel logo, follow these steps
3. Edit the code.
4. Configure OpenPanel to use your template.
Edit the `/root/docker-compose.yml` file and in it setyour file to overwrite the original template:
Edit the `/root/docker-compose.yml` file and in it set your file to overwrite the original template:
```bash
nano /root/docker-compose.yml
```
@ -186,7 +186,7 @@ To edit the login page:
3. Edit the code.
4. Configure OpenPanel to use your template.
Edit the `/root/docker-compose.yml` file and in it setyour file to overwrite the original template:
Edit the `/root/docker-compose.yml` file and in it set your file to overwrite the original template:
```bash
nano /root/docker-compose.yml
```

View File

@ -100,7 +100,7 @@ opencli plan-create <NAME> <DESCRIPTION> <DOMAINS_LIMIT> <WEBSITES_LIMIT> <DISK_
Example:
```bash
opencli plan-create cloud_8 "Custom plan with 8GB of RAM&CPU" 0 0 15 500000 0 8 8 my_custom_nxinx_image 200
opencli plan-create cloud_8 "Custom plan with 8GB of RAM&CPU" 0 0 15 500000 0 8 8 my_custom_nginx_image 200
```
### Create new user

View File

@ -4,7 +4,7 @@ OpenPanel uses Docker images as a base for every user. We provide and maintain f
These images are optimized for both speed and performance, and new idle accounts will use from 10-150mb of RAM - depending if using Debian or Ubuntu as server OS.
If you want to fine tune the performanse and lower RAM usage for idle accounts, you can create a custom Docker image that will have only the services that you offer pre-installed.
If you want to fine tune the performance and lower RAM usage for idle accounts, you can create a custom Docker image that will have only the services that you offer pre-installed.
[Here is an example guide on creating a custom docker image](/docs/articles/docker/building_a_docker_image_example_include_php_ioncubeloader/).
@ -19,7 +19,7 @@ This allows to minimize resources needed for each user, and allows overselling o
## Memory Usage shows High usage
Unlike other panels, all usage data is real-time and shows actuall usage for user. As on other panels, **cached memory is counted in the total memory usage**. This means that if a service or process used ram and exits, that ram is not automatically returned to the free ram and will still show as used, but in reallity it is cached ram that can be made available at any time if needed.
Unlike other panels, all usage data is real-time and shows actual usage for user. As on other panels, **cached memory is counted in the total memory usage**. This means that if a service or process used ram and exits, that ram is not automatically returned to the free ram and will still show as used, but in reality it is cached ram that can be made available at any time if needed.
This means that the memory usage displayed for current processes is lower than the memory usage reported in OpenPanel dashboard page.
Bacause this often confuses users, OpenPanel will periodically safely drop all cached ram at the beginning of an hour.
Because this often confuses users, OpenPanel will periodically safely drop all cached ram at the beginning of an hour.

View File

@ -1,6 +1,6 @@
# All Domains show Nginx 502 error
This happens when a third party user/service restarted docker and the floatingip service failed to reload the `/etc/hosts` file with new docker private IP addresses.
This happens when a third party user/service restarted docker and the floating ip service failed to reload the `/etc/hosts` file with new docker private IP addresses.
To resolve this issue, run:

View File

@ -2,7 +2,7 @@
Email communication is crucial for any organization, but issues can arise that disrupt this essential service. This guide provides practical steps to diagnose and resolve common email errors encountered in [OpenPanel Enterprise edition](/product/openpanel-premium-control-panel/), ensuring your email systems run smoothly and efficiently.
## ERROR listmailuser: '/tmp/docker-mailserver/postfix-accounts.cf' does not exist
## ERROR list mail user: '/tmp/docker-mailserver/postfix-accounts.cf' does not exist
Dovecot is not started until the first email account is created, therefor listing email accounts with the command `opencli email-setup email list` before creating any email accounts, will produce error:
```bash