bayrepo/hestiacp
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added document fixes

Browse Source
This commit is contained in:
Alexey Berezhok
2024-09-10 22:50:16 +03:00
parent ef861e9c28
commit 9d93d56a05
14 changed files with 101 additions and 249 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
docs/.vitepress/config.js
View File

@@ -23,30 +23,20 @@ export default defineConfig({
nav: nav(),
socialLinks: [
{ icon: 'github', link: 'https://dev.brepo.ru/bayrepo/hestiacp' },
{ icon: 'github', link: 'https://github.com/bayrepo/hestiacp' },
{ icon: 'github', link: 'https://github.com/hestiacp/hestiacp' },
{ icon: 'twitter', link: 'https://twitter.com/HestiaPanel' },
{ icon: 'facebook', link: 'https://www.facebook.com/hestiacp' },
],
sidebar: { '/docs/': sidebarDocs() },
outline: [2, 3],
editLink: {
pattern: 'https://github.com/hestiacp/hestiacp/edit/main/docs/:path',
text: 'Edit this page on GitHub',
},
footer: {
message: 'Released under the GPLv3 License.',
copyright: 'Copyright © 2019-present Hestia Control Panel',
copyright: 'Copyright © 2019-present Hestia Control Panel and some RPM based components belongs to bayrepo',
},
algolia: {
appId: 'V04P0P5D2R',
apiKey: '7a90a3ac7f9313f174c50b0f301f7ec6',
indexName: 'hestia_cp',
},
},
});
@@ -56,24 +46,20 @@ function nav() {
{ text: 'Features', link: '/features.md' },
{ text: 'Install', link: '/install.md' },
{ text: 'Documentation', link: '/docs/introduction/getting-started.md', activeMatch: '/docs/' },
{ text: 'Team', link: '/team.md' },
{ text: 'Demo', link: 'https://demo.hestiacp.com:8083/' },
{ text: 'Forum', link: 'https://forum.hestiacp.com/' },
{ text: 'Donate', link: '/donate.md' },
{
text: `v${version}`,
items: [
{
text: 'Changelog',
link: 'https://github.com/hestiacp/hestiacp/blob/main/CHANGELOG.md',
link: 'https://dev.brepo.ru/bayrepo/hestiacp/src/branch/master/CHANGELOG.md',
},
{
text: 'Contributing',
link: 'https://github.com/hestiacp/hestiacp/blob/main/CONTRIBUTING.md',
link: 'https://dev.brepo.ru/bayrepo/hestiacp/src/branch/master/CONTRIBUTING.md',
},
{
text: 'Security policy',
link: 'https://github.com/hestiacp/hestiacp/blob/main/SECURITY.md',
link: 'https://dev.brepo.ru/bayrepo/hestiacp/src/branch/master/SECURITY.md',
},
],
},
@@ -159,5 +145,12 @@ function sidebarDocs() {
{ text: 'CLI', link: '/docs/reference/cli.md' },
],
},
{
text: 'Extensions',
collapsed: false,
items: [
{ text: 'PHP cli selector', link: '/docs/extensions/php-cli-selector.md' },
],
},
];
}

22
docs/_data/features.js
View File

@@ -16,30 +16,12 @@ export const webDomains = [
{
text: 'MultiPHP support for',
items: [
{ text: "PHP 5.6 (<a href='https://www.php.net/supported-versions.php'>EOL</a>)" },
{ text: "PHP 7.0 (<a href='https://www.php.net/supported-versions.php'>EOL</a>)" },
{ text: "PHP 7.1 (<a href='https://www.php.net/supported-versions.php'>EOL</a>)" },
{ text: "PHP 7.2 (<a href='https://www.php.net/supported-versions.php'>EOL</a>)" },
{ text: "PHP 7.3 (<a href='https://www.php.net/supported-versions.php'>EOL</a>)" },
{ text: "PHP 7.4 (<a href='https://www.php.net/supported-versions.php'>EOL</a>)" },
{ text: 'PHP 8.0' },
{ text: 'PHP 8.1' },
{ text: 'PHP 8.2' },
],
},
{
text: 'One-Click Install Apps',
items: [
{ text: 'WordPress' },
{ text: 'Dokuwiki' },
{ text: 'Drupal' },
{ text: 'Grav' },
{ text: 'Laravel' },
{ text: 'MediaWiki' },
{ text: 'NextCloud' },
{ text: 'OpenCart' },
{ text: 'Prestashop' },
{ text: 'Symphony' },
{ text: 'PHP 8.3' },
{ text: 'PHP 8.4' },
],
},
];

16
docs/docs/extensions/php-cli-selector.md Normal file
View File

@@ -0,0 +1,16 @@
# PHP cli selector
PHP cli selector replace system php - `/usr/bin/php` with link to the tool, which analyze HestiaCP config for user and exec needed for user php.
Example:
```
# readlink -f /usr/bin/php
/usr/bin/hestiacp-php-selector
```
By default php cli selector disbaled and system php points to default php binary.
For enabling PHP cli selector got ot "Server Options"->"Options"->"Web-server".
Find selector "System PHP" and under the selector set checkbox "Use PHP cli selector".
![php_cli_selector](/images/php_cli_selector.png)

67
docs/docs/introduction/getting-started.md
View File

@@ -27,12 +27,9 @@ We currently do not support i386 or ARM7-based processors.
### Supported operating systems
- Debian 10, 11 or 12
- Ubuntu 20.04 or 22.04
::: warning
Hestia does not support non-LTS Operating systems. If you install it on, for example, Ubuntu 21.10, you will not receive support from us.
:::
- MSVSphere 9
- AlmaLinux 9
- Rocky Linux 9
## Regular installation
@@ -49,7 +46,7 @@ wget https://dev.brepo.ru/bayrepo/hestiacp/raw/branch/master/install/hst-install
If the download fails due to an SSL validation error, please be sure you've installed the ca-certificate package on your system - you can do this with the following command:
```bash
apt-get update && apt-get install ca-certificates
yum install ca-certificates
```
### Step 2: Run
@@ -81,33 +78,35 @@ An easier way to choose your installation options is by using the [Install strin
To choose what software gets installed, you can provide flags to the installation script. You can view the full list of options below.
```bash
-a, --apache Install Apache [yes | no] default: yes
-w, --phpfpm Install PHP-FPM [yes | no] default: yes
-o, --multiphp Install Multi-PHP [yes | no] default: no
-v, --vsftpd Install Vsftpd [yes | no] default: yes
-j, --proftpd Install ProFTPD [yes | no] default: no
-k, --named Install Bind [yes | no] default: yes
-m, --mysql Install MariaDB [yes | no] default: yes
-M, --mysql-classic Install Mysql8 [yes | no] default: no
-g, --postgresql Install PostgreSQL [yes | no] default: no
-x, --exim Install Exim [yes | no] default: yes
-z, --dovecot Install Dovecot [yes | no] default: yes
-Z, --sieve Install Sieve [yes | no] default: no
-c, --clamav Install ClamAV [yes | no] default: yes
-t, --spamassassin Install SpamAssassin [yes | no] default: yes
-i, --iptables Install Iptables [yes | no] default: yes
-b, --fail2ban Install Fail2ban [yes | no] default: yes
-q, --quota Filesystem Quota [yes | no] default: no
-d, --api Activate API [yes | no] default: yes
-r, --port Change Backend Port default: 8083
-l, --lang Default language default: en
-y, --interactive Interactive install [yes | no] default: yes
-s, --hostname Set hostname
-e, --email Set admin email
-p, --password Set admin password
-D, --with-debs Path to Hestia debs
-f, --force Force installation
-h, --help Print this help
-a, --apache Install Apache [yes|no] default: yes
-w, --phpfpm Install PHP-FPM [yes|no] default: yes
-o, --multiphp Install Multi-PHP [yes|no] default: no
-v, --vsftpd Install Vsftpd [yes|no] default: yes
-j, --proftpd Install ProFTPD [yes|no] default: no
-k, --named Install Bind [yes|no] default: yes
-m, --mysql Install MariaDB [yes|no] default: yes
-M, --mysql-classic Install MySQL 8 [yes|no] default: no
-g, --postgresql Install PostgreSQL [yes|no] default: no
-x, --exim Install Exim [yes|no] default: yes
-z, --dovecot Install Dovecot [yes|no] default: yes
-Z, --sieve Install Sieve [yes|no] default: no
-c, --clamav Install ClamAV [yes|no] default: no
-t, --spamassassin Install SpamAssassin [yes|no] default: yes
-i, --iptables Install Iptables [yes|no] default: yes
-b, --fail2ban Install Fail2ban [yes|no] default: yes
-q, --quota Filesystem Quota [yes|no] default: no
-d, --api Activate API [yes|no] default: yes
-r, --port Change Backend Port default: 8083
-l, --lang Default language default: en
-y, --interactive Interactive install [yes|no] default: yes
-I, --nopublicip Use local ip [yes|no] default: yes
-s, --hostname Set hostname
-e, --email Set admin email
-p, --password Set admin password
-R, --with-rpms Path to Hestia rpms
-f, --force Force installation
-h, --help Print this help
```
#### Example

2
docs/docs/server-administration/configuration.md
View File

@@ -15,8 +15,6 @@ A good starting point for every software is to check the official docs:
- For Apache2: [Apache Docs](http://httpd.apache.org/docs/2.4/)
- For PHP-FPM: [PHP Docs](https://www.php.net/manual/en/install.fpm.configuration.php)
You could also try [our Forum](https://forum.hestiacp.com)
## Can I use HestiaCP behind Cloudflare CDN?
By default the [Cloudflare Proxy](https://developers.cloudflare.com/fundamentals/get-started/reference/network-ports/) supports only a limited number of ports. This means that Cloudflare will not forward port 8083, which is the default port for Hestia. To change the Hestia port to one that Cloudflare will forward, run this command:

37
docs/docs/server-administration/os-upgrades.md
View File

@@ -13,12 +13,12 @@ Make sure to verify that MariaDB is running on a supported version for the new o
Once a backup has been made, update Hestia to the last supported version:
```bash
apt update && apt upgrade
yum update
```
Follow system instructions to upgrade your OS. When done, make sure to check that the files in `/etc/apt/sources.list.d` are not hashed out. If they are, remove the hash and run `apt update && apt upgrade` again.
## Debian 10 Buster to Debian 11 Bullseye
## MSVSphere, AlmaLinux, RockyLinux 9
### SHA512 password encryption
@@ -37,37 +37,4 @@ cp -f /usr/local/hestia/install/deb/exim/exim4.conf.4.94.template /etc/exim4/exi
Comment out [line 29](https://github.com/hestiacp/hestiacp/blob/1ff8a4e5207aae1e241954a83b7e8070bcdca788/install/deb/proftpd/proftpd.conf#L29) in `/etc/profpd/prodtpd.conf`.
## Debian 9 Stretch to Debian 10 Buster
No issues have been found in the past.
## Ubuntu 20.04 Focal to Ubuntu 22.04 Jammy
::: tip
Verify that MariaDB is running at least version 10.6. If not, first upgrade to this version in your current operating system! After that, comment out the line in `/etc/apt/sources.list.d/mariadb.list` and then upgrade your OS.
:::
### SHA512 password encryption
```bash
sed -i "s/obscure yescrypt/obscure sha512/g" /etc/pam.d/common-password
```
### Exim4 config
```bash
rm -f /etc/exim4/exim4.conf.template
cp -f /usr/local/hestia/install/deb/exim/exim4.conf.4.94.template /etc/exim4/exim4.conf.template
```
### ProFTPD
Comment out [line 29](https://github.com/hestiacp/hestiacp/blob/1ff8a4e5207aae1e241954a83b7e8070bcdca788/install/deb/proftpd/proftpd.conf#L29) in `/etc/profpd/prodtpd.conf`.
## Ubuntu 18.04 Bionic to Ubuntu 20.04 Focal
No issues have been found in the past.
## Older versions
We haven’t tested the upgrade paths from Ubuntu 16.04 to Ubuntu 20.04 or Debian 8 Jessy to Debian 10

13
docs/index.md
View File

@@ -6,7 +6,7 @@ titleTemplate: Open-source web server control panel.
hero:
name: Hestia Control Panel
text: Open-source web server control panel
text: Open-source web server control panel (RPM based build)
tagline: Fast, reliable, open-source. The control panel you’ve always wanted is just a command away.
image:
src: /logo.svg
@@ -16,10 +16,10 @@ hero:
text: Get started
link: /docs/introduction/getting-started
- theme: alt
text: Try the demo
link: https://demo.hestiacp.com:8083/
text: RPM version
link: https://dev.brepo.ru/bayrepo/hestiacp
- theme: alt
text: View on GitHub
text: Original version
link: https://github.com/hestiacp/hestiacp
features:
@@ -28,11 +28,6 @@ features:
details: Hestia is made with ease of use in mind. Creating a user or a website is as easy as clicking a button and filling out a couple of fields, while advanced features are easily accessible.
link: /docs/introduction/getting-started
linkText: Documentation
- icon: ❤️
title: Made with love & pride
details: Hestia is open-source software that is built by passionate people from around the world. This means that the code is reviewed by multiple people and that anybody can contribute to it!
link: /team
linkText: See the team
- icon: 🛠️
title: Extendable & powerful
details: Hestia is extendable while being easy to learn. You can build your own themes, web templates, quick install applications and can interact with it using third party software via its API.

BIN
docs/public/images/php_cli_selector.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.8 KiB