Add markdownlint (hestiacp#3107)

Author: AlecRust

.github/workflows/lint.yml

@@ -19,6 +19,18 @@ jobs:
         with:
           severity: error
 
+  markdownlint:
+    name: markdownlint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Run markdownlint
+        uses: avto-dev/markdown-lint@v1
+        with:
+          args: "*.md docs/**/*.md"
+
   prettier:
     name: Prettier
     runs-on: ubuntu-latest

.lintstagedrc.cjs

@@ -1,4 +1,6 @@
 module.exports = {
+	// Run markdownlint on MD files
+	'*.md': 'markdownlint --fix',
 	// Run Stylelint on CSS files
 	'*.css': 'stylelint --fix',
 	// Run ESLint on TS, TSX, JS, JSX files

.markdownlint.yml

@@ -0,0 +1,11 @@
+# MD010/no-hard-tabs - Hard tabs
+MD010: false
+
+# MD013/line-length - Line length
+MD013: false
+
+# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
+MD024: false
+
+# MD033/no-inline-html - Inline HTML
+MD033: false

.vscode/extensions.json

@@ -1,11 +1,12 @@
 {
 	"recommendations": [
-		"mrmlnc.vscode-apache",
 		"editorconfig.editorconfig",
+		"DavidAnson.vscode-markdownlint",
 		"dbaeumer.vscode-eslint",
+		"timonwong.shellcheck",
 		"esbenp.prettier-vscode",
-		"bmewburn.vscode-intelephense-client",
+		"mrmlnc.vscode-apache",
 		"william-voyek.vscode-nginx",
-		"timonwong.shellcheck"
+		"bmewburn.vscode-intelephense-client"
 	]
 }

CHANGELOG.md

@@ -334,7 +334,7 @@ A bug in v-update-sys-hestia caused auto update to be not working. Please run: `
   - Update zlib to 1.2.12
   - Update PCRE to 10.40
 - Update hestia-php to 8.1.7
-- Updated phpMyAdmin to 5.2.0 (https://www.phpmyadmin.net/files/5.2.0/)
+- Updated phpMyAdmin to 5.2.0 (<https://www.phpmyadmin.net/files/5.2.0/>)
 - Update Filegator to 7.8.1
 - Update PHPmailer to 6.6.2
 - Update composer dependencies
@@ -347,7 +347,7 @@ A bug in v-update-sys-hestia caused auto update to be not working. Please run: `
 
 ### Dependencies
 
-- Update phpMyAdmin to 5.1.4 (https://www.phpmyadmin.net/files/5.1.4/) (#2529)
+- Update phpMyAdmin to 5.1.4 (<https://www.phpmyadmin.net/files/5.1.4/>) (#2529)
 
 ## [1.5.14] - Service release
 
@@ -402,8 +402,8 @@ A bug in v-update-sys-hestia caused auto update to be not working. Please run: `
 
 ### Dependencies
 
-- Update PHPMailer to 6.6.0 (https://github.com/PHPMailer/PHPMailer/releases/tag/v6.6.0)
-- Update Filegator to 7.7.2 (https://github.com/filegator/filegator/releases/tag/v7.7.2)
+- Update PHPMailer to 6.6.0 (<https://github.com/PHPMailer/PHPMailer/releases/tag/v6.6.0>)
+- Update Filegator to 7.7.2 (<https://github.com/filegator/filegator/releases/tag/v7.7.2>)
 
 ## [1.5.8] - Service release
 
@@ -421,11 +421,11 @@ A bug in v-update-sys-hestia caused auto update to be not working. Please run: `
 - Fixed an issue where users were being redirected to login page when visiting /reset/ endpoint #2401
 - Fixed an issue where deleting sftp jail did not revert back permissions of said user. #2143
 - Fixed an issue where "REDIRECT" variable wasn't cleared correctly causing other sites to redirect to the domain after v-update-letsencrypt-ssl
-- Changed repository url MariaDB for new installs to https://wdlm.mariadb.com/repo/mariadb-server
+- Changed repository url MariaDB for new installs to <https://wdlm.mariadb.com/repo/mariadb-server>
 
 ### Dependencies
 
-- Update phpMyAdmin to 5.1.3 (https://github.com/phpmyadmin/phpmyadmin/releases/tag/RELEASE_5_1_3)
+- Update phpMyAdmin to 5.1.3 (<https://github.com/phpmyadmin/phpmyadmin/releases/tag/RELEASE_5_1_3>)
 
 ## [1.5.7] - Service release
 
@@ -435,13 +435,13 @@ A bug in v-update-sys-hestia caused auto update to be not working. Please run: `
 
 If you have to following error
 
-```
+```bash
 The following signatures couldn't be verified because the public key is not available: NO_PUBKEY A189E93654F0B0E5
 ```
 
 Follow the following instructions
 
-```
+```bash
 rm /usr/share/keyrings/hestia-keyring.gpg
 mkdir /root/.gnupg/
 gpg --no-default-keyring --keyring /usr/share/keyrings/hestia-keyring.gpg --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys A189E93654F0B0E5
@@ -454,16 +454,16 @@ After that run apt update && apt upgrade
 ### Bugfixes
 
 - Fixed an issue with the installer. system.pkg didn't allow for a Web alias #2381
-- Fixed an issue with upgrade script causing command to to be executed (https://forum.hestiacp.com/t/upgrading-to-1-5-5-error-line/5449/3)
+- Fixed an issue with upgrade script causing command to to be executed (<https://forum.hestiacp.com/t/upgrading-to-1-5-5-error-line/5449/3>)
 
 ## [1.5.5] - Service release
 
 ### Features
 
 - Improve default php-fpm.conf files. (#2318, #2343)
 - Notify user when a suspended user tries to login (#2310, #2345)
-- Allow setting default web install templates for Quick install (#2344) (https://github.com/hestiacp/hestia-quick-install)
-- Improve security how apt keys are downloaded #2299 (https://blog.cloudflare.com/dont-use-apt-key/)
+- Allow setting default web install templates for Quick install (#2344) (<https://github.com/hestiacp/hestia-quick-install>)
+- Improve security how apt keys are downloaded #2299 (<https://blog.cloudflare.com/dont-use-apt-key/>)
 - Allow users to set system php version in Web GUI (#2357)
 - Added a link to the firewall in list services (#2371) @fra81
 
@@ -487,9 +487,9 @@ After that run apt update && apt upgrade
 
 ### Dependencies
 
-- Update PHPmyadmin to 5.1.2 (https://www.phpmyadmin.net/files/5.1.2/)
-- Update Filegator to 7.7.1 (https://github.com/filegator/filegator/releases/tag/v7.7.1)
-- Update B2CLI to 3.2.0 (https://github.com/Backblaze/B2_Command_Line_Tool/releases/tag/v3.2.0) (#2349) @ptrinh
+- Update PHPmyadmin to 5.1.2 (<https://www.phpmyadmin.net/files/5.1.2/>)
+- Update Filegator to 7.7.1 (<https://github.com/filegator/filegator/releases/tag/v7.7.1>)
+- Update B2CLI to 3.2.0 (<https://github.com/Backblaze/B2_Command_Line_Tool/releases/tag/v3.2.0>) (#2349) @ptrinh
 
 ## [1.5.4] - Service release
 
@@ -628,7 +628,7 @@ After that run apt update && apt upgrade
 
 ### Dependencies
 
-- Update Roundcube to 1.5.0 https://roundcube.net/news/2021/10/18/roundcube-1.5.0-released
+- Update Roundcube to 1.5.0 <https://roundcube.net/news/2021/10/18/roundcube-1.5.0-released>
 - Update jQuery UI to the last version [CVE-2021-41182](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-41182)
 
 ## [1.4.17] - Service release
@@ -834,7 +834,7 @@ After that run apt update && apt upgrade
 
 - Improve the calculated disk size of a new backup estimated by excluding the exclude folders, mail accounts and database in backups (#1616) @Myself5
 - Improve v-update-firewall / v-stop-firewall to make it self healing (#1892) @myrevery
-- Update phpMyAdmin version to 1.5.1 (See https://www.phpmyadmin.net/news/2021/6/4/phpmyadmin-511-released/)
+- Update phpMyAdmin version to 1.5.1 (See <https://www.phpmyadmin.net/news/2021/6/4/phpmyadmin-511-released/>)
 - Fixed a bug after rebuilding mail with Exim4 and suspended domains (#1886)
 - Fixed "Allowed IP addresses for API" field with strange behaviour #1866
 - Fixed an issue where the "Saved confirmation" was not set due to a redirect #1879
@@ -854,14 +854,14 @@ After that run apt update && apt upgrade
 
 - **NOTE:** During the 1.4.1 / 1.4.0 release we have introduced a bug for Ubuntu 20.04 and 18.04 users with multiple network ports on the server. This release will solve the problems caused by this bug! If you are unable to download the Hestia packages via apt. Run the following command via CLI or SSH as root
 
-```
-    iptables -A INPUT -m state --state RELATED,ESTABLISHED -j ACCEPT
+```bash
+iptables -A INPUT -m state --state RELATED,ESTABLISHED -j ACCEPT
 ```
 
 Then run the update via
 
-```
-    apt update && apt upgrade
+```bash
+apt update && apt upgrade
 ```
 
 ### Bugfixes
@@ -887,7 +887,7 @@ Then run the update via
 
 - **NOTE:** Ubuntu 16.04 (Xenial) is no longer supported as it has reached EOL (end-of-life) status.
 - **NOTE:** Apache in "standalone" mode is no longer actively supported and has been removed from installer options. Nginx (Proxy) + Apache2 will remain supported.
-- **NOTE:** Custom "quick installer apps" will not work anymore due to changes in how we handle quick installer apps. Minimal changes to the Quick installer apps are required! Please check https://github.com/hestiacp/hestia-quick-install for how to migrate!
+- **NOTE:** Custom "quick installer apps" will not work anymore due to changes in how we handle quick installer apps. Minimal changes to the Quick installer apps are required! Please check <https://github.com/hestiacp/hestia-quick-install> for how to migrate!
 - **NOTE:** Manual upgrade scripts are available to update Roundcube, Rainloop and PHPmyadmin to the last version they can be found in /usr/local/hestia/install/upgrade/manual/
 
 ### Features
@@ -987,7 +987,7 @@ Then run the update via
 
 ### Bugfixes
 
-- Updated APT repository key for PHP from packages.sury.org (https://forum.hestiacp.com/t/apt-upgrade-failed-gpg-error-packages-sury-org)
+- Updated APT repository key for PHP from packages.sury.org (<https://forum.hestiacp.com/t/apt-upgrade-failed-gpg-error-packages-sury-org>)
 - Updated phpMyAdmin to v5.1.0.
 
 ## [1.3.4] - Service Release
@@ -1306,7 +1306,7 @@ Then run the update via
 - Fixed wrong quotes used for default keys folder location in v-generate-api-key backend script.
 - Fixed permissions to allow access for FTP users created in web domains under admin account.
 - Check if user home directory exists before setting permissions on SFTP fail2ban jail.
-- Fixed several reported security issues, thanks to Andrea Cardaci (https://cardaci.xyz/)
+- Fixed several reported security issues, thanks to Andrea Cardaci (<https://cardaci.xyz/>)
 - Security fix: Command line arguments arguments were glob expanded when written to log file.
 - Ensure that SFTP accounts remain configured in sshd when removing web domains/
 - Improved security by ensuring that file operations in user home folder will be executed as the real user.
@@ -1359,7 +1359,7 @@ Then run the update via
 
 ### Bugfixes
 
-- Fixed several security issues, thanks to Andrea Cardaci (https://cardaci.xyz/)
+- Fixed several security issues, thanks to Andrea Cardaci (<https://cardaci.xyz/>)
 - Rework Let's Encrypt ACME staging to use hestia conform standard.
 - Fixed if condition, use nginx for Let's Encrypt ACME request if present.
 
@@ -1422,7 +1422,6 @@ Then run the update via
 
 -
 
-[current]: https://github.com/hestiacp/hestiacp
 [1.0.4]: https://github.com/hestiacp/hestiacp/releases/tag/1.0.4
 [1.0.3]: https://github.com/hestiacp/hestiacp/releases/tag/1.0.3
 [1.0.1]: https://github.com/hestiacp/hestiacp/releases/tag/1.0.1

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-## Hestia Control Panel - Contribution Guidelines
+# Hestia Control Panel - Contribution Guidelines
 
 ## Ways to contribute
 
@@ -38,7 +38,7 @@ The first step is to create a fork of the `hestiacp/hestiacp` repository under y
 
 Once you've created your fork, clone the repository to your computer and make sure that you've checked out the `main` branch. **Always** create a new topic branch for your work.
 
-### Branch naming convention:
+### Branch naming convention
 
 - **Prefix:** `topic/` (such as **fix**, **feature**, **refactor**, etc.)
 - **ID**: `888` (GitHub Issue ID if an issue exists)
@@ -64,7 +64,7 @@ To aid other developers and keep the project's commit history clean, please **sq
 
 All pull requests must include a brief but descriptive title, and a detailed description of the changes that you've made. **Only include commits that are related to your feature, bug fix, or patch in your pull request!**
 
-## Thank you!
+## Thank you
 
 We appreciate **all** contributions no matter what size; your feedback and input directly shapes the future of Hestia Control Panel and we could not do it without your support.
 

README.md

@@ -1,7 +1,7 @@
-![Hestia screenshot](https://hestiacp.com/img/screen_HestiaServer-dark.png)
-
 # [Hestia Control Panel](https://www.hestiacp.com/)
 
+![Hestia screenshot](https://hestiacp.com/img/screen_HestiaServer-dark.png)
+
 **Latest stable release:** Version 1.6.11 | [View Changelog](https://github.com/hestiacp/hestiacp/blob/release/CHANGELOG.md) | [![Build Status](https://drone.hestiacp.com/api/badges/hestiacp/hestiacp/status.svg?ref=refs/heads/main)](https://drone.hestiacp.com/hestiacp/hestiacp) <br>
 
 **Web:** [www.hestiacp.com](https://www.hestiacp.com/)<br>
@@ -29,7 +29,7 @@ Hestia Control Panel is designed to provide administrators an easy to use web an
 - Let's Encrypt SSL support with wildcard certificates
 - Firewall with brute-force attack detection and IP lists (iptables, fail2ban, and ipset).
 
-# Supported platforms and operating systems
+## Supported platforms and operating systems
 
 - **NOTE:** Hestia Control Panel does not support 32 bit operating systems!
 
@@ -38,21 +38,21 @@ Hestia Control Panel is designed to provide administrators an easy to use web an
 
 - **NOTE:** Hestia Control Panel in combination with OpenVZ 7 or lower might have issue Bind9 server not starting or issues with Firewall. If you use a Virtual Private Server we strongly advice you to use something based on KVM or LXC!
 
-# Installing Hestia Control Panel
+## Installing Hestia Control Panel
 
 - **NOTE:** Hestia Control Panel must be installed on top of a fresh operating system installation to ensure proper functionality.
 
 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.
 
-## Step 1: Log in
+### Step 1: Log in
 
 To start the installation, you will need to be logged in as **root** or a user with super-user privileges. You can perform the installation either directly from the command line console or remotely via SSH:
 
 ```bash
 ssh root@your.server
 ```
 
-## Step 2: Download
+### Step 2: Download
 
 Download the installation script for the latest release:
 
@@ -66,7 +66,7 @@ If the download fails due to an SSL validation error, please be sure you've inst
 apt-get update && apt-get install ca-certificates
 ```
 
-## Step 3: Run
+### Step 3: Run
 
 To begin the installation process, simply run the script and follow the on-screen prompts:
 
@@ -76,17 +76,17 @@ bash hst-install.sh
 
 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.
 
-## Custom installation:
+### Custom installation
 
 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:
 
 ```bash
 bash hst-install.sh -h
 ```
 
-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.
+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.
 
-# How to upgrade an existing installation
+## How to upgrade an existing installation
 
 Automatic Updates are enabled by default on new installations of Hestia Control Panel and can be managed from **Server Settings > Updates**. To manually check for and install available updates, use the apt package manager:
 
@@ -95,18 +95,18 @@ apt-get update
 apt-get upgrade
 ```
 
-# Issues & Support Requests
+## Issues & Support Requests
 
 - If you encounter a general problem while using Hestia Control Panel and need help, please [visit our forum](https://forum.hestiacp.com/) to search for potential solutions or post a new thread where community members can assist.
 - Bugs and other reproducible issues should be filed via GitHub by [creating a new issue report](https://github.com/hestiacp/hestiacp/issues) so that our developers can investigate further. Please note that requests for support will be redirected to our forum.
 
 **IMPORTANT: We _cannot_ provide support for requests that do not describe the troubleshooting steps that have already been performed, or for third-party applications not related to Hestia Control Panel (such as WordPress). Please make sure that you include as much information as possible in your forum posts or issue reports!**
 
-# Contributions
+## Contributions
 
 If you would like to contribute to the project, please [read our Contribution Guidelines](https://github.com/hestiacp/hestiacp/blob/release/CONTRIBUTING.md) for a brief overview of our development process and standards.
 
-# Copyright
+## Copyright
 
 "Hestia Control Panel", "HestiaCP", and the Hestia logo are original copyright of hestiacp.com and the following restrictions apply:
 
@@ -120,6 +120,6 @@ If you would like to contribute to the project, please [read our Contribution Gu
 - use the names "Hestia Control Panel", "HestiaCP", or the Hestia logo in any context that is not related to the project,
 - alter the name "Hestia Control Panel", "HestiaCP", or the Hestia logo in any way.
 
-# License
+## License
 
 Hestia Control Panel is licensed under [GPL v3](https://github.com/hestiacp/hestiacp/blob/release/LICENSE) license, and is based on the [VestaCP](https://www.vestacp.com/) project.<br>

SECURITY.md

@@ -23,7 +23,7 @@ With that, good luck hacking us ;)
 
 ## Qualifying Vulnerabilities
 
-### Vulnerabilities we really care about!
+### Vulnerabilities we really care about
 
 - Remote command execution
 - Code/SQL Injection

bin/v-list-sys-ips

@@ -4,7 +4,7 @@
 #
 # example: v-list-sys-ips
 #
-# This function for obtaining the list of system ip adresses.
+# This function for obtaining the list of system ip addresses.
 
 #----------------------------------------------------------#
 #                Variables & Functions                     #