Skip to content

Commit ef7061b

Browse files
authored
Merge pull request #331 from mikalekseev/master
extended eportal doc with automated installation
2 parents cf438d4 + ca2ec12 commit ef7061b

File tree

1 file changed

+59
-1
lines changed

1 file changed

+59
-1
lines changed

docs/eportal/README.md

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,64 @@ If you are installing for the first time, please confirm with our sales engineer
4545

4646
ePortal is compatible with 64-bit versions of EL7/8/9 based distros like CentOS 7/8, AlmaLinux 8/9/10, Ubuntu 20.04/22.04/24.04 and Debian 11/12
4747

48+
## Automated Installation Script
49+
50+
TuxCare provides an automated installation script that simplifies the ePortal installation and configuration process. The script handles repository setup, package installation, and initial configuration.
51+
52+
### Supported Distributions
53+
54+
The installer script supports the following distributions:
55+
56+
**RHEL-based:**
57+
* AlmaLinux 8, 9, 10
58+
* Red Hat Enterprise Linux (RHEL) 8, 9, 10
59+
* Oracle Linux (OEL) 8, 9, 10
60+
61+
**Debian-based:**
62+
* Debian 11, 12
63+
* Ubuntu 20.04, 22.04, 24.04
64+
65+
### Main Features
66+
67+
The installer script automates the following:
68+
69+
* **Repository Configuration**: Automatically configures the required repositories (Nginx and TuxCare ePortal)
70+
* **Package Installation**: Installs ePortal and all required dependencies
71+
* **Service Validation**: Verifies that ePortal service is properly installed and running
72+
* **Admin Password Setup**: Interactive configuration of the admin user password
73+
* **Cache Mode Configuration**: Optional configuration to enable patch caching mode (reduces disk space requirements)
74+
* **Business Units Configuration**: Optional setup for multi-tenant business unit isolation
75+
* **Proxy Configuration**: Optional proxy server configuration for environments requiring it
76+
* **SSL Certificate Setup**: Optional Let's Encrypt SSL certificate installation and configuration
77+
* **Firewall Configuration**: Automatically configures firewall rules for HTTP/HTTPS access
78+
79+
### Using the Installation Script
80+
81+
Download and run the installer script:
82+
83+
```text
84+
# curl -O https://repo.cloudlinux.com/kcare-eportal/eportal_installer.sh
85+
# chmod +x eportal_installer.sh
86+
# ./eportal_installer.sh
87+
```
88+
89+
The script will:
90+
1. Detect your Linux distribution and version
91+
2. Configure the necessary repositories
92+
3. Install ePortal and dependencies
93+
4. Guide you through interactive configuration steps
94+
5. Optionally configure SSL certificates
95+
96+
After installation, you can access ePortal at `http://YOUR_SERVER_IP/admin` using the admin credentials you configured during installation.
97+
98+
:::tip Note
99+
The installer script requires root privileges and will prompt you to agree to the terms before proceeding.
100+
:::
101+
102+
## Manual Installation
103+
104+
If you prefer to install ePortal manually or need more control over the installation process, follow the instructions below.
105+
48106
### RHEL-based distros
49107

50108
For installation and workability of ePortal the Nginx web server is required. We recommend to use stable version from the official Nginx repository:
@@ -1843,4 +1901,4 @@ If you experience problems configuring the patch source or have problems accessi
18431901
```
18441902

18451903
The above command will create an archive with the collected data and output the path to it.
1846-
You can inspect the contents of the archive if necessary and then send it to the support team.
1904+
You can inspect the contents of the archive if necessary and then send it to the support team.

0 commit comments

Comments
 (0)