mirror of
https://github.com/stefanpejcic/openpanel
synced 2025-06-26 18:28:26 +00:00
329 lines
13 KiB
Markdown
329 lines
13 KiB
Markdown
---
|
|
hide_table_of_contents: true
|
|
---
|
|
|
|
|
|
# 0.1.7
|
|
|
|
Released on May 08, 2024
|
|
|
|
### 🚀 New features
|
|
- [French translation 🇫🇷](https://community.openpanel.co/d/45-parles-tu-francais-french-translation-for-openpanel)
|
|
- [WHMCS Module](#whmcs-module)
|
|
- [API endpoints for managing user accounts](#api-for-users)
|
|
- [Cronjobs can now be enabled/disabled and run on demand](#cron-disable)
|
|
- [Ubuntu 24.04 images](#ubuntu24-images)
|
|
- [Admin users can now be edited: rename, change password, suspend/unsuspend from OpenAdmin interface](#edit-admin-users)
|
|
- [OpenAdmin search for users, websites and options](#admin-search)
|
|
- [Forbidden usernames list](#forbidden-username)
|
|
|
|
|
|
### 💥 Breaking Changes
|
|
- [Containerized services](#containerized-services)
|
|
- [All services in our official docker images are now disabled by default](#disabled-services)
|
|
- Script `opencli docker-is_port_in_use` is now deprecated and will be removed in the future.
|
|
|
|
### 🐛 Bug fixes
|
|
- [Fixed bug with successful update message in notification center](#success-message)
|
|
- Fixed bug with email alerts not being sent if server does not have a valid ssl
|
|
- Fixed js error when there are no docker images on *OpenAdmin > Docker Settings*
|
|
- Fixed bug where the system erroneously flagged initial admin login as a new admin login.
|
|
- [Fixed bug in the update script where failed updates were being retried.](#skip-version)
|
|
- [Fixed bug with leftover DNS zones from domains removed while the Named service is down](https://github.com/stefanpejcic/OpenPanel/issues/95)
|
|
- [Fixed multiple bugs with the install script](#improved-install)
|
|
- Fixed bug with pip install errors on python 3.11
|
|
- Fixed bug with Nginx service unable to start if network is down during the installation or if ip.openpanel.co is unreachable.
|
|
- Fixed bug with `opencli admin` returning error instead of IPv4 address from external service.
|
|
- Fixed false-positive error bug when adding user via OpenAdmin interface.
|
|
- Fixed bug with search input on OpenAdmin > Firewall page.
|
|
- Fixed bug with ajax form submission not working on OpenAdmin > General Settings page (reported bySamanw).
|
|
- Fixed bug with docker: `failed to register layer: devicemapper: Error running deviceSuspend dm_task_run failed.`
|
|
- Fix bug with mysql: `ERROR 2013 (HY000): Lost connection to MySQL server at 'reading initial communication packet', system error: 2`
|
|
- Fixed bug with PIP install on Python 3.11 and 3.12: `error: externally-managed-environment`
|
|
- Fixed bug with Gunicorn: `ModuleNotFoundError: No module named 'pyarmor_runtime_000000'`
|
|
- Fixed bug with Nginx: `Starting nginx: [emerg]: bind() to IP failed (99: Cannot assign requested address)`
|
|
|
|
|
|
## 💅 Polish
|
|
- [SSH service status is now restored after reboot](#ssh-after-reboot)
|
|
- Generate password button on *OpenAdmin > Users* now toggles the password field visible.
|
|
- All images are now hosted locally.
|
|
- Google Cloud Storage is now used as a mirror for installation files.
|
|
- [All docker images are now hosted on hub.docker.com](#hub-docker-com)
|
|
- Python 3.12 is now fully supported.
|
|
|
|
|
|
----
|
|
|
|
### WHMCS Module
|
|
|
|
WHMCS module is now available for OpenPanel.
|
|
Currently supported actions are:
|
|
|
|
- ✅ create account
|
|
- ✅ change password
|
|
- ✅ suspend account
|
|
- ✅ unsuspend account
|
|
- ✅ terminate account
|
|
- ✅ autologin from frontend
|
|
- ✅ autologin from backend
|
|
- ❌ get disk usage for account
|
|
- ❌ change package
|
|
|
|
To setup WHMCS to use your OpenPanel server follow these steps:
|
|
|
|
1. **Enable API access on OpenPanel server**
|
|
First make sure that API access is enabled by going to `OpenAdmin > API` or by running `opencli config get api` from the terminal:
|
|
|
|
If API is not enabled, click on the "Enable API access" button or from terminal run `opencli config update api on`.
|
|
|
|
We recommend creating new Administrator user for API, to create a new user navigate to *OpenAdmin > OpenAdmin Settings* and create new admin user, or from terminal run: `opencli admin new USERNAME_HERE PASSWORD_HERE`
|
|
|
|
2. **Install OpenPanel WHMC Module**
|
|
Login to SSH for WHMCS server
|
|
Navigate to `path_to_whmcs/modules/servers`
|
|
Run this command to create a new folder and in it download the module: `git clone https://github.com/stefanpejcic/openpanel-whmcs-module.git openpanel`
|
|
|
|
3. **Establish connection between the two servers**
|
|
On OpenPanel server make sure that the OpenAdmin port 2087 is open on `OpenAdmin > Firewall` or whitelist the IP adress of your WHMCS server.
|
|
to whitelist ip address from terminal run: `ufw allow from WHMCS_IP_HERE`
|
|
|
|
On WHMCS server also make sure that the 2087 port is opened or whitelist the IP address of your OpenPanel server.
|
|
From WHMS navigate to: *System Settings > Products & Services > Servers*
|
|
|
|
Click on *Create New Server* and under module select **OpenPanel** then add OpenPanel server IP, username and password for the OpenAdmin panel:
|
|
|
|
|
|
4. **Create hosting packages**
|
|
Hosting packages need to be created on both OpenPanel and WHMCS servers.
|
|
On OpenPanel server login to admin panel and on `OpenAdmin > Plans` create hosting packages that you will be assinging to users on WHMCS.
|
|
|
|
On the WHMCS server create first a new group and then create new plans under this group. When creating products, make sure to select OpenPanel for Module and the newly created group
|
|
|
|
|
|
5. **Test creating new accounts**
|
|
Create an order and create a new order to test OpenPanel API.
|
|
|
|
---
|
|
|
|
### API for Users
|
|
|
|
New API endpoints are available for automating various administrative tasks or integrating with billing solutions.
|
|
|
|
|
|
- List accounts
|
|
```bash
|
|
curl -X GET http://PANEL:2087/api/users -H "Authorization: Bearer JWT_TOKEN_HERE"
|
|
```
|
|
- Create account
|
|
```bash
|
|
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN_HERE" -d '{"email": "EMAIL_HERE", "username": "USERNAME_HERE", "password": "PASSWORD_HERE", "plan_id": "PLAN_ID_HERE"}' http://PANEL:2087/api/users
|
|
```
|
|
- Suspend account
|
|
```bash
|
|
curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN_HERE" -d '{"action": "suspend"}' http://PANEL:2087/api/users/USERNAME_HERE
|
|
```
|
|
- Unsuspend account
|
|
```bash
|
|
curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN_HERE" -d '{"action": "unsuspend"}' http://PANEL:2087/api/users/USERNAME_HERE
|
|
```
|
|
- Delete account
|
|
```bash
|
|
curl -X DELETE -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN_HERE" http://PANEL:2087/api/users/USERNAME_HERE
|
|
```
|
|
- Change password
|
|
```bash
|
|
curl -X PATCH -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN_HERE" -d '{"password": "NEW_PASSWORD_HERE"}' http://PANEL:2087/api/users/USERNAME_HERE
|
|
```
|
|
- Change plan
|
|
```bash
|
|
curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN_HERE" -d '{"plan_id": "PLAN_ID_HERE"}' http://PANEL:2087/api/users/USERNAME_HERE
|
|
```
|
|
- Autologin
|
|
```bash
|
|
curl -X CONNECT -H "Content-Type: application/json" -H "Authorization: Bearer JWT_TOKEN_HERE" http://PANEL:2087/api/users/USERNAME_HERE
|
|
```
|
|
|
|
---
|
|
|
|
### Improved install
|
|
|
|
- `git` and `clamav` are now removed from the install script
|
|
- Added checks for failed wget (reported by *germangc125*)
|
|
- `--repair` flag will now retry all installation steps
|
|
- Port 22 is no longer disabled by default, only when flag `--no-ssh` is used.
|
|
- database import is now retried multiple times if mysql is not ready
|
|
|
|
----
|
|
|
|
### Cron disable
|
|
|
|
Users can now pause/unpause cronjobs and execute them out of schedule.
|
|
|
|
|
|
|
|
|
|
When troubleshooting cronjob, you can add ` >> /home/USERNAME/CRON.log 2>&1` in the cron command and output will be stored in the file everytime the cron is executed.
|
|
|
|
-----
|
|
|
|
### Edit Admin Users
|
|
|
|
Admin users can now be edited: rename, change password, suspend/unsuspend from OpenAdmin interface.
|
|
|
|
|
|
|
|
Note: *Super admin* role can not be suspended or deleted.
|
|
|
|
----
|
|
|
|
### Admin search
|
|
|
|
OpenAdmin has been enhanced with a search feature, enabling Administrators to swiftly navigate the OpenAdmin interface and locate various items.
|
|
This search functionality covers:
|
|
- Users
|
|
- Websites
|
|
- OpenAdmin pages
|
|
|
|
|
|
|
|
|
|
|
|
----
|
|
|
|
### Success message
|
|
|
|
Fixed bug with success message "OpenPanel successfully updated!" not dismissing the "New OpenPanel update is available" message.
|
|
|
|
Fixed bug with wrong description added for successfull update.
|
|
|
|
|
|
|
|
----
|
|
|
|
### Skip version
|
|
|
|
Administrators now have the ability to specify which OpenPanel versions to skip during updates by modifying the `/etc/openpanel/upgrade/skip_versions` file.
|
|
|
|
This feature proves handy when manually updating from an older version and wishing to skip certain intermediate versions.
|
|
|
|
For instance, if a user is updating from OpenPanel 0.1.3 with autopatches disabled, the update process would typically progress from 0.1.4 to 0.1.5, then to 0.1.6, and finally to the latest version, 0.1.7.
|
|
|
|
However, if there are minimal differences between versions 0.1.4 and 0.1.5, an admin can opt to skip version 0.1.4 by appending it to the `/etc/openpanel/upgrade/skip_versions` file:
|
|
|
|
```bash
|
|
echo 0.1.4 >> /etc/openpanel/upgrade/skip_versions
|
|
```
|
|
|
|
Consequently, during the update procedure, specified version 0.1.4 will be skipped.
|
|
|
|
It's worth noting that while skipping versions is possible, it's generally not recommended since each update typically takes around 30 seconds.
|
|
|
|
|
|
In the event of a failed update to a particular version, the opencli update scripts will automatically add that version to the `/etc/openpanel/upgrade/skip_versions` file to prevent future attempts at updating to it.
|
|
|
|
----
|
|
|
|
### Forbidden Username
|
|
|
|
Both `opencli user-add` and `opencli user-rename` scripts now use an external list of forbidden names from: `/usr/local/admin/scripts/helpers/forbidden_usernames.txt` file. Administrators can add usernames to this list.
|
|
|
|
```bash
|
|
test
|
|
restart
|
|
reboot
|
|
shutdown
|
|
exec
|
|
root
|
|
admin
|
|
ftp
|
|
lsws
|
|
litespeed
|
|
1000
|
|
vsftpd
|
|
apache2
|
|
apache
|
|
nginx
|
|
php
|
|
mysql
|
|
mysqld
|
|
www-data
|
|
openpanel
|
|
```
|
|
|
|
----
|
|
|
|
### SSH after reboot
|
|
|
|
SSH service inside users docker containers is disabled by default when account is created, and in OpenPanel < 0.1.6 was also disabled by default when server is rebooted.
|
|
|
|
We now store the ssh service status for each user and if enabled, after reboot will be re-enabled. note: ssh service for users uses a random port, so after reboot the port is changed.
|
|
|
|
|
|
----
|
|
|
|
### hub.docker.com
|
|
|
|
OpenPanel official docker images are now hosted on hub.docker.com
|
|
|
|
- Nginx stack: https://hub.docker.com/r/openpanel/nginx/tags
|
|
- Apache stack: https://hub.docker.com/r/openpanel/apache/tags
|
|
|
|
|
|
|
|
-----
|
|
|
|
### Disabled services
|
|
|
|
In order to reduce the memory footprint of Docker containers, we are implementing breaking changes to our official Docker images for Nginx and Apache:
|
|
|
|
- NodeJS, Python, PM2, and WP-CLI are removed from the images. They are installed only when needed: when a user adds a WordPress website or a Node.js/Python application.
|
|
- All services are disabled by default and will only be enabled when needed. MySQL is enabled when adding the first database or user, webservers are started only when a domain is added, SSH only when SSH access is enabled, cron service after cronjob is added, etc.
|
|
|
|
This ensures that only the services that are actually used are running.
|
|
|
|
With these changes, **we managed to lower idle CPU & Memory Usage of new user accounts from 680MB to less than 10MB**.
|
|
|
|
-----
|
|
|
|
|
|
### Ubuntu24 images
|
|
|
|
Both official images [openpanel/nginx](https://hub.docker.com/r/openpanel/nginx) and [openpanel/apache](https://hub.docker.com/r/openpanel/apache) now use Ubuntu 24.04 as the base images.
|
|
This change fixes 16 vulnerabilities in the previous Ubuntu 22.04 docker image.
|
|
|
|
|
|
----
|
|
|
|
### Containerized services
|
|
|
|
MySQL service is now also run as a docker container. This allows Admins to set cpu and memory limits for the service, as well to easily manage backup and restore.
|
|
|
|
Example, restart mysql container:
|
|
```bash
|
|
docker restart openpanel_mysql
|
|
```
|
|
|
|
Example, backup mysql data locally:
|
|
```bash
|
|
docker run --rm \
|
|
--mount source=openpanel_mysql_data,target=<target> \
|
|
-v $(pwd):/backup \
|
|
busybox \
|
|
tar -czvf /backup/<backup-filename>.tar.gz <target>
|
|
```
|
|
|
|
Example, backup mysql data to AWS:
|
|
```bash
|
|
docker run --rm \
|
|
-v openpanel_mysql_data:/var/lib/mysql \
|
|
--env AWS_ACCESS_KEY_ID="<xxx>" \
|
|
--env AWS_SECRET_ACCESS_KEY="<xxx>" \
|
|
--env AWS_S3_BUCKET_NAME="<xxx>" \
|
|
--entrypoint backup \
|
|
offen/docker-volume-backup:v2
|
|
```
|
|
|
|
-----
|
|
|