You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Do you want to contribute to the Hestia Control Panel project? The easiest way to get started is to [submit an issue report](https://github.com/hestiacp/hestia/issues) if you come across a bug or issue. If you're a developer, please feel free to submit a patch/pull request with a fix.
5
+
6
+
**We appreciate all contributions to our project; it is with the help of the open-source community that we are able to build a product that meets users needs.**
7
+
8
+
Code Contributions & Pull Requests - Guidelines
9
+
-----------------------
10
+
11
+
**All pull requests must include:**
12
+
1. A brief but descriptive title, such as **Fixed typo in php.ini** or **Updated rebuild_mail_conf function in rebuild.sh**.
13
+
2. A detailed description of the changes that you've made.
14
+
1. Example: "Apache subdomain configuration was incorrect, modified variables in templates to point to the correct files."
15
+
3. Only commits which are related to the pull request or issue itself.
16
+
17
+
### Code formatting and comments:
18
+
We ask that you try to follow existing naming schemes and coding conventions as much as possible, and that you please add brief but descriptive comments in your source code to aid other developers in debugging and understanding your code in the future.
19
+
20
+
### Squashing commits for smaller changes:
21
+
When submitting a pull request with multiple smaller commits which are related to the same issue (or file), we ask that you please **squash your commits** in order to keep the project's commit history clean and easy to follow for other developers.
22
+
23
+
### Working with branches:
24
+
Development for this project takes place in branches to effectively develop, manage, and test manage new features and code changes, ensuring that that each release meets high quality standards. There are two main branches which have a never-ending life cycle:
25
+
26
+
***master**:Latest stable release code (install packages align with this branch)
27
+
***develop**: Primary development branch containing code for the next release.
28
+
29
+
If you are submitting a fix for a critical issue (such as security or broken functionality) in the current release, please create a branch with the prefix **hotfix-** starting from **master** for your work and submit a pull request with **[CRITICAL]** in the title.
30
+
31
+
For all other changes, we ask that you create a new branch based on **develop**. Please follow the below naming conventions for your work and submit a pull request when it has been completed. Once reviewed and approved, our development team will merge your code into the primary development branch.
32
+
33
+
***feature-**: New features
34
+
***bugfix-**: Fixes for non-critical bugs
35
+
***secfix-**: Fixes for non-critical security issues
36
+
***webui-**: Control Panel user experience and interface changes
37
+
38
+
**Please ensure that all pull requests meet the guidelines listed above; those that do not will be rejected and sent back for review.**
39
+
40
+
Donations
41
+
-----------------------
42
+
If you would like to make a donation to the Hestia Control Panel project to further its development (or if you'd like to buy our developers a lunch), please feel free to do so via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ST87LQH2CHGLA).
**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.
8
11
9
12
What is Hestia Control Panel?
10
13
----------------------------
11
14
* An open source web server control panel with an easy-to-use interface.
12
15
* A lightweight alternative to cPanel, Plesk, etc.
13
16
14
-
What features does Hestia Control Panel support?
17
+
What does Hestia Control Panel support?
15
18
----------------------------
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
20
26
21
-
System Requirements:
27
+
Supported operating systems:
22
28
----------------------------
23
29
* Debian 8 or 9
24
30
* 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.
26
32
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:
30
37
```bash
31
38
ssh root@your.server
32
39
```
33
-
Download the installation script:
40
+
## Step 2: Download
41
+
Download the installation script for the latest release:
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:
38
47
```bash
39
48
bash hst-install.sh
40
49
```
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:
41
53
To perform an unattended installation using the default options:
@@ -46,20 +58,52 @@ For additional installation options:
46
58
```bash
47
59
bash hst-install.sh -h
48
60
```
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.**
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
+
=============================
51
91
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.
52
92
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.
54
94
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.
58
98
59
-
How to support Hestia Control Panel:
60
-
----------------------------
99
+
Donations
100
+
=============================
61
101
Hestia Control Panel is open source and completely free for everyone to use.
62
102
63
103
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.
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