sidebar_position: 1

Get Started with OpenAdmin

The OpenAdmin offers an administrator-level interface where you can efficiently handle tasks such as creating and managing users, setting up hosting plans, configuring backups, and editing OpenPanel settings.

Requirements

Hardware Requirements

A blank full virtual machine or a bare metal server
Ubuntu 22.04 LTS server
A minimum of 4GB RAM and 20GB storage
x86_64/amd64 architecture

Installation

The installation process takes about 5 minutes. To install openpanel follow these steps:

Log in to your new server;
as root via SSH or
as a user with sudo privileges and type "sudo -i"
Copy and paste openpanel installation command into the terminal
```
bash <(curl -sSL https://get.openpanel.co/)
```

:::info We recommend that you run the installation command within a Linux screen session. The Linux Screen utility allows you to create a shell session that will stay active through a network disruption. :::

OpenPanel installation process will by default perform the following steps:

Check if your OS and available hardware resources meet the bare minimum system requirements
Check if existing hosting panel or webserver is already installed
Detect your OS and the package manager to be used for installation commands
Check if another OpenPanel installaiton is in progress or was interrupted
Update and start installing required packages
Configure and start all required system services
Download required Docker images
Set domain, generate SSL, and configure services
Create hosting packages

The installation script also supports optional flags that can be used to install additional services, skip certain installation steps or display debugging information:

Flag	What it does
`--version=`	Specify OpenPanel verison to install intead of the default latest. Example: `--version=0.1.8`
`--with_modsec`	Rebuild Nginx with ModSecurity module and set the OWASP core ruleset.
`--debug`	Display on screen each installation step and output debugging information.
`--skip-requirements`	Do not check if the server meets the minimum recommended requirements for running OpenPanel.
`--skip-apt-update`	Do not check if apt is up-to-date and skip udpating it.
`--skip-panel-check`	Do not check if other hosting panels or webservers are installed and overwrite.
`--repair`	Do not check if OpenPanel installation is already running or previously failed and retry installation.
`--skip-firewall`	Do not install UFW and skip setting custom firewall rules.
`--skip-images`	Skip building Docker images for Nginx and Apache.
`--skip-ssl`	Do not check if the server hostname is pointed to the IP and set it to be used for OpenPanel; instead, the server IP will be used.
`--enable-ftp`	Experimental feature that will install FTP for all users.
`--no-ssh`	Close the default ssh port 22 but whitelist the current ip address of the user running the installation.
`--post_install=`	Specify a bash script to be executed after OpenPanel is installed.

Example: Install OpenPanel in debug mode

bash <(curl -sSL https://get.openpanel.co/) --debug

:::info openpanel will install Docker, MySQL, Nginx, and several other tools on your server. You should install it on a fresh server, otherwise, you risk facing installation errors. :::

:::danger Port 53, 80, 443 and 2083 must be available and not blocked by your hosting provider firewall. :::

Troubleshooting failed installation

In a rare case that the OpenPanel installation process fails you shoud be able to determine the root cause from the error message alone.

You can also run the installation process with the --debug flag and afterwards check the installation log file for errors:

cat /root/openpanel_install.log

:::tip In nearly 99.9% of instances, installation failures result from conflicts with residual services from a previous hosting panel or web server. If a web server was previously installed on the server, it is advisable to reinstall the operating system before attempting to install OpenPanel again. :::

Reporting bugs

If you encountered any errors while running the installation script, and you are able to again reproduce the error on another server (or same after reinstalling the OS) then please copy & paste the installation log file to the community forums.

Post Install Steps

Access AdminPanel

Run opencli admin command to find the address on which AdminPanel is accessible. Example output:

root@server:/home# opencli admin
● AdminPanel is running and is available on: https://server.openpanel.co:2087/

To login to admin panel you need a username and password.

Default username for the main Administrator account is admin and password is random generated. To set a new password for the admin account run command: opencli admin password USER_HERE NEW_PASSWORD_HERE

Example:

root@server:/home# opencli admin password admin ba63vfav7fq36vas
Password for user 'admin' changed.

===============================================================
● AdminPanel is running and is available on: https://server.openpanel.co:2087/

- username: admin
- password: ba63vfav7fq36vas

===============================================================

Updates

The panel will check for new updates nightly. If available, it will check your local update and patch preferences and update only when enabled.

To enable or disable updates, navigate to OpenAdmin > General Settings and check or uncheck the 'Auto Updates' and 'Auto Patches'.

To change update preferences from the terminal use commands:

opencli config update autoupdate yes

opencli config update autopatch yes

If you want to update manually regardless of the schedule, you can run the following command.

opencli update --force

Security

OpenPanel has been built from the ground up with security in mind. Internet history is littered with painful security incidents, so we traded old software compatibility and insecure authentication methods for modern day security measures.

OpenPanel Security features:

Each user container is isolated by Docker.
Two-Factor Authentication (2FA) can be activated by users.
phpMyAdmin and WebTerminal offer auto-login using one-time tokens.
Users' public services (SSH, MySQL) are accessible via non-standard ports.
All user actions on the panel are stored in activity log.
Bruteforce protection and rate limiting are implemented for all panel pages.
The user panel is segregated from the admin panel and websites.
All user panel requests are processed in the backend.

OpenAdmin Security features:

The admin panel can be entirely disabled while retaining all functionality.
HTTP Basic Authentication can be enabled for the admin panel.
Admins can change the default port (2083) for the user panel.
Email alerts and notifications for admin logins from new IP address.
Bruteforce protection is enforced for the admin panel.
Passwords are stored as salted SHA512 hashes by default (5000 rounds).
The admin panel is isolated from the user panel and websites.
Separated database software for admin and user accounts.

Websites:

ModSecurity Web Application Firewall (WAF) can be activated for domains, with the OWASP core ruleset.
IP blocking per domain name.
Hotlink protection per domain using vhost files.
No outgoing emails, only SMTP!
TLS (Transport Layer Security) is utilized.

000_intro.md 8.7 KB Permanentný odkaz História Raw