Skip to content

Commit 53e8d53

Browse files
author
Kristan Kenney
committed
Update README.md and add branch question to issue template
1 parent d52da1a commit 53e8d53

File tree

2 files changed

+70
-23
lines changed

2 files changed

+70
-23
lines changed

ISSUE_TEMPLATE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ Type here (e.g. Ubuntu 18.04 LTS)
1515
### HestiaCP Version:
1616
Type here (e.g. 0.9.8-29)
1717

18+
### Which branch are you using?
19+
Type here (e.g master, develop, etc.)
20+
1821
### What software is installed?
1922
Type here (e.g. Apache, Nginx, PHP-FPM, Dovecot/Exim, MariaDB, etc.)
2023

README.md

Lines changed: 67 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,55 @@
11
[Hestia Control Panel](https://www.hestiacp.com/)
22
==================================================
33

4-
Disclaimer
4+
**Pre-Release Software Information**
55
----------------------------
6-
**Hestia Control Panel is in active development and has been made available as a pre-release beta.**<br>
7-
**Please use caution if you choose to use this software in a production environment.**
6+
**Hestia Control Panel is undergoing rapid changes in development. As such, it is important to note that:**
7+
* Current builds are released as a beta and are intended for development and testing purposes only.
8+
* This software should not be used on production systems without understanding the risks.
9+
* By using this software, you acknowledge and accept that bugs or issues could occur at any time.
10+
* By using this software, you acknowledge and accept that changes to the functionality or user interface are likely during the course of development.
811

912
What is Hestia Control Panel?
1013
----------------------------
1114
* An open source web server control panel with an easy-to-use interface.
1215
* A lightweight alternative to cPanel, Plesk, etc.
1316

14-
What features does Hestia Control Panel support?
17+
What does Hestia Control Panel support?
1518
----------------------------
16-
* Web Server (Apache/Nginx) with PHP
17-
* DNS Server (Bind)
18-
* Mail Server (Exim/Dovecot) with Anti-Virus and Spam Filtering (ClamAV and SpamAssassin)
19-
* Database Server (MariaDB/PostgreSQL)
19+
* Standard Web Server (apache2/nginx) with PHP
20+
* PHP Web Application Server (nginx + php-fpm)
21+
* Multiple PHP versions (5.6 - 7.3)
22+
* DNS Server (Bind) with clustering capabilities
23+
* Mail Server (Exim/Dovecot) with Anti-Virus and Anti-Spam (ClamAV and SpamAssassin)
24+
* Database functionality (MariaDB/PostgreSQL)
25+
* Let's Encrypt SSL with wildcard certificates
2026

21-
System Requirements:
27+
Supported operating systems:
2228
----------------------------
2329
* Debian 8 or 9
2430
* Ubuntu 16.04 LTS or Ubuntu 18.04 LTS
25-
* **NOTE:** Hestia Control Panel must be installed on a "clean" operating system to ensure proper functionality.
31+
* **NOTE:** Hestia Control Panel must be installed on top of a fresh operating system installation to ensure proper functionality.
2632

27-
How to install:
28-
----------------------------
29-
Log in to your server as root, either directly or via SSH:
33+
Installing Hestia Control Panel
34+
============================
35+
## Step 1: Log in
36+
To install Hestia Control Panel on your server, you will need to be logged in as **root** either directly from the command line console or remotely via SSH:
3037
```bash
3138
ssh root@your.server
3239
```
33-
Download the installation script:
40+
## Step 2: Download
41+
Download the installation script for the latest release:
3442
```bash
3543
wget https://raw.githubusercontent.com/hestiacp/hestiacp/master/install/hst-install.sh
3644
```
37-
Run the installation script and follow the on-screen instructions:
45+
## Step 3: Run
46+
To begin the installation process, simply run the script and follow the on-screen prompts:
3847
```bash
3948
bash hst-install.sh
4049
```
50+
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.
51+
52+
## Additional installation notes:
4153
To perform an unattended installation using the default options:
4254
```bash
4355
bash hst-install.sh -f -y no -e <email> -p <password> -s <hostname>
@@ -46,20 +58,52 @@ For additional installation options:
4658
```bash
4759
bash hst-install.sh -h
4860
```
49-
Reporting bugs & issues:
50-
----------------------------
61+
62+
Installing development builds
63+
=============================
64+
To install a development build based on the latest published code, you must first have an existing installation of Hestia available. If you do not have a server configured, please install the latest stable build using the instructions above before continuing.
65+
66+
**Development builds should not be installed on systems with live production data.**
67+
68+
## Step 1: Download the compiler script
69+
```bash
70+
wget https://raw.githubusercontent.com/hestiacp/hestiacp/develop/src/hst_autocompile.sh
71+
```
72+
## Step 2: Compile and install the desired build:
73+
```bash
74+
bash hst_autocompile.sh --packageset <branchname> <yes|no>
75+
```
76+
**Valid options for *packageset* flag include:**
77+
* all
78+
* hestia
79+
* nginx
80+
* php
81+
82+
For example, to install only the Control Panel itself built from the main development branch (**develop**):
83+
```bash
84+
bash hst_autocompile.sh --hestia develop yes
85+
```
86+
87+
**Important:** Updates which have been released via the Hestia package repositories and upgraded through **apt** will replace installations which use the above method.
88+
89+
Reporting Issues
90+
=============================
5191
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.
5292

53-
Bug reports can be filed using GitHub's [Issues](https://github.com/hestiacp/hestiacp/issues) feature located at the top of our repository.
93+
Bug reports can be filed using GitHub's [Issues](https://github.com/hestiacp/hestiacp/issues) feature.
5494

55-
License:
56-
----------------------------
57-
Hestia Control Panel is licensed under [GPL v3](https://github.com/hestiacp/hestiacp/blob/master/LICENSE) license, and is based on VestaCP.<br>
95+
Contributions
96+
=============================
97+
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.
5898

59-
How to support Hestia Control Panel:
60-
----------------------------
99+
Donations
100+
=============================
61101
Hestia Control Panel is open source and completely free for everyone to use.
62102

63103
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.
64104

65105
[![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)
106+
107+
License
108+
=============================
109+
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)