Skip to content

Commit 6017cc1

Browse files
author
Kristan Kenney
committed
Update README.md - Version 1.2.0
1 parent 95a7de1 commit 6017cc1

File tree

1 file changed

+29
-76
lines changed

1 file changed

+29
-76
lines changed

README.md

Lines changed: 29 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,40 @@
22

33
[Hestia Control Panel](https://www.hestiacp.com/)
44
==================================================
5-
**Current stable release:** Version 1.1.1, released on March 26th, 2020.<br>
6-
**Current development release:** Version 1.2.0.
7-
<br><br>
8-
**Due to a change of the repository infrastructure, please install the new key before you upgrade your existing installations:**
9-
```bash
10-
wget -qO - https://gpg.hestiacp.com/deb_signing.key | sudo apt-key add -
11-
```
12-
13-
**Welcome!**
14-
----------------------------
15-
Hestia Control Panel offers easy to use web and command line interfaces, enabling web server administrators to quickly deploy and manage web domains, mail accounts, and DNS zones from one central location without the hassle of manually deploying and configuring individual components.
5+
**Latest stable release:** Version 1.2.0 - June 29, 2020 | [View Changelog](https://github.com/hestiacp/hestiacp/blob/master/CHANGELOG.md)<br>
166

17-
While we have taken every effort to make the interface as friendly as possible (even for new users), it is assumed that you will have some prior knowledge and understanding in the basics how to set up a Linux server and managing web applications.
18-
19-
**We cannot provide support for requests that do not describe in detail the troubleshooting that has already been performed, or for third-party applications which do not directly relate to Hestia Control Panel. Please make sure that you fill in the necessary details in your issue reports, and remove any sections that do not apply to your issue or use case.**
7+
**Web:** [www.hestiacp.com](https://www.hestiacp.com/)<br>
8+
**Documentation:** [docs.hestiacp.com](https://docs.hestiacp.com/)<br>
9+
**Forums:** [forum.hestiacp.com](https://forum.hestiacp.com/)<br><br>
10+
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ST87LQH2CHGLA)
11+
<br>
2012

21-
Interested in helping shape the future of Hestia Control Panel?
13+
**Welcome!**
2214
----------------------------
23-
Are you a software developer, tester, or have experience in writing documentation or guides and have some time to contibute to the project?<br><br>Please send an email to info@hestiacp.com with a quick outline of your previous experience in any of these areas or where you think you could help on the project and we'll reach out to discuss the next steps.
24-
25-
As always we welcome all feedback and contributions!
26-
27-
Sincerely,<br>
28-
The Hestia Control Panel development team
15+
Hestia Control Panel is designed to provide administrators an easy to use web and command line interface, enabling them to quickly deploy and manage web domains, mail accounts, DNS zones, and databases from one central dashboard without the hassle of manually deploying and configuring individual components or services.
2916

30-
What is Hestia Control Panel?
17+
Features and Services
3118
----------------------------
32-
* An open source web server control panel with an easy-to-use interface.
33-
* A lightweight alternative to cPanel, Plesk, etc.
34-
35-
What does Hestia Control Panel support?
36-
----------------------------
37-
* Standard Web Server (Apache/NGINX) with PHP
38-
* PHP Web Application Server (NGINX + PHP-FPM)
39-
* Multiple PHP versions (5.6 - 7.4, with 7.3 currently as default for optimal compatibility)
19+
* Apache2 and NGINX with PHP-FPM
20+
* Multiple PHP versions (5.6 - 7.4, 7.3 as default for optimal compatibility)
4021
* DNS Server (Bind) with clustering capabilities
41-
* Mail Server (Exim/Dovecot) with Anti-Virus and Anti-Spam (ClamAV and SpamAssassin)
42-
* Database functionality (MariaDB/PostgreSQL)
43-
* Let's Encrypt SSL with wildcard certificates
22+
* POP/IMAP/SMTP mail services with Anti-Virus, Anti-Spam, and Webmail (ClamAV, SpamAssassin, and Roundcube)
23+
* MariaDB or PostgreSQL databases
24+
* Let's Encrypt SSL support with wildcard certificates
25+
* Firewall with brute-force attack detection and IP lists (iptables, fail2ban, and ipset).
4426

45-
Supported operating systems:
27+
Supported operating systems
4628
----------------------------
47-
* Debian 8, 9, 10
48-
* Ubuntu 16.04 LTS or Ubuntu 18.04 LTS (the latest LTS release is generally recommended)
29+
* Debian 10, 9
30+
* Ubuntu 20.04 LTS, 18.04 LTS, or 16.04 LTS
4931
* **NOTE:** Hestia Control Panel must be installed on top of a fresh operating system installation to ensure proper functionality.
5032

5133
Installing Hestia Control Panel
5234
============================
35+
While we have taken every effort to make the installation process and the control panel interface as friendly as possible (even for new users), it is assumed that you will have some prior knowledge and understanding in the basics how to set up a Linux server before continuing.
36+
5337
## Step 1: Log in
54-
To install Hestia Control Panel on your server, you will need to be logged in as **root** or a user with super-user privileges in order to continue. You can perform the installation either directly from the command line console or remotely via SSH:
38+
To start the installation process on your server, you will need to be logged in as **root** or a user with super-user privileges in order to continue. You can perform the installation either directly from the command line console or remotely via SSH:
5539
```bash
5640
ssh root@your.server
5741
```
@@ -72,57 +56,22 @@ bash hst-install.sh
7256
```
7357
You will receive a welcome email at the address specified during installation (if applicable) and on-screen instructions after the installation is completed to log in and access your server.
7458

75-
## Additional installation notes:
76-
To perform an unattended installation using the default options:
77-
```bash
78-
bash hst-install.sh -f -y no -e <email> -p <password> -s <hostname>
79-
```
8059
## Custom installation:
8160
You may specify a number of various flags during installation to only install the features in which you need. To view a list of available options, run:
8261
```bash
8362
bash hst-install.sh -h
8463
```
8564
Alternatively, @gabizz has made available a command-line script generator at https://gabizz.github.io/hestiacp-scriptline-generator/ which allows you to easily generate the installation command via GUI.
8665

87-
Installing & testing development builds
66+
Issues
8867
=============================
89-
In order to install a development build based on the latest published code, you should first have an instance of Hestia Control Panel set up. If you do not have a server configured, please install the latest stable build using the instructions above before continuing.
68+
If you've run into a problem, [file a new issue report via GitHub](https://github.com/hestiacp/hestiacp/issues) so that we may investigate further.
9069

91-
**PLEASE NOTE: Development builds should not be installed on systems with live production data without understanding the potential risks involved.**
92-
93-
To install a development build, first ensure that you have the latest Git upgrade script installed which handles new dependencies added after the 1.0.x branch:
94-
```bash
95-
wget -O $HESTIA/bin/v-update-sys-hestia-git https://raw.githubusercontent.com/hestiacp/hestiacp/master/bin/v-update-sys-hestia-git
96-
chmod +x $HESTIA/bin/v-update-sys-hestia-git
97-
```
98-
99-
Then run the following command:
100-
```bash
101-
v-update-sys-hestia-git branchname
102-
```
103-
Replace *branchname* with the name of the branch you wish to install from, such as **release** or **master** (stable and current development branches, respectively).
104-
105-
Reporting Issues
106-
=============================
107-
If you've run into an issue with Hestia Control Panel, please let us know as soon as possible so that we may investigate further and resolve any issues in a timely manner.
108-
109-
Bug reports can be filed using GitHub's [Issues](https://github.com/hestiacp/hestiacp/issues) feature.
70+
**We cannot provide support for requests that do not describe the troubleshooting steps that have already been performed, or for third-party applications which do not relate to Hestia Control Panel. Please make sure that you fill in the necessary details in your issue reports!**
11071

11172
Contributions
11273
=============================
113-
If you would like to contribute to the project, please [read our submission guidelines](https://github.com/hestiacp/hestiacp/blob/master/CONTRIBUTING.md) for a brief overview of our development processes and standards.
114-
115-
Donations
116-
=============================
117-
Hestia Control Panel is open source and completely free for everyone to use.
118-
119-
If you would like to help our developers cover their time and infrastucture costs, or to support the Hestia Control Panel project as a whole, please consider making a donation via PayPal or become a sponsor.
120-
121-
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ST87LQH2CHGLA)
122-
123-
License
124-
=============================
125-
Hestia Control Panel is licensed under [GPL v3](https://github.com/hestiacp/hestiacp/blob/master/LICENSE) license, and is based on the [VestaCP](https://www.vestacp.com/) project.<br>
74+
If you would like to contribute to the project, please [read our Contribution Guidelines](https://github.com/hestiacp/hestiacp/blob/master/CONTRIBUTING.md) for a brief overview of our development process and standards.
12675

12776
Copyright
12877
=============================
@@ -135,3 +84,7 @@ Copyright
13584
- sell or redistribute the application under the name "Hestia Control Panel", "HestiaCP", or similar derivatives, including the use of the Hestia logo in any brand or marketing materials related to revenue generating activities,
13685
- use the names "Hestia Control Panel", "HestiaCP", or the Hestia logo in any context that is not related to the project,
13786
- alter the name "Hestia Control Panel", "HestiaCP", or the Hestia logo in any way.
87+
88+
License
89+
=============================
90+
Hestia Control Panel is licensed under [GPL v3](https://github.com/hestiacp/hestiacp/blob/master/LICENSE) license, and is based on the [VestaCP](https://www.vestacp.com/) project.<br>

0 commit comments

Comments
 (0)