Просмотр исходного кода

Update development docs (#4136)

* Tidy development docs

* Fix typo

* Improve view logs copy

* Missing space

* Tidy

* Increase recommended dev VM memory

* Mention user prompt

* PR feedback
Alec Rust 2 лет назад
Родитель
Сommit
afe73c8d3a

+ 1 - 1
bin/v-update-sys-hestia-git

@@ -264,7 +264,7 @@ else
 	echo "Installing dependencies for compilation..."
 	apt-get -qq install -y $SOFTWARE > /dev/null 2>&1
 
-	# Fix for Debian PHP Envroiment
+	# Fix for Debian PHP environment
 	if [ $BUILD_ARCH == "amd64" ]; then
 		if [ ! -L /usr/local/include/curl ]; then
 			ln -s /usr/include/x86_64-linux-gnu/curl /usr/local/include/curl

+ 1 - 1
docs/.vitepress/theme/components/InstallBuilder.vue

@@ -5,7 +5,7 @@
 				<h2 class="u-text-center">Installation instructions</h2>
 				<p class="u-mb10">
 					Log in to your server e.g.
-					<code>ssh root@your.server</code> and download the installation script:
+					<code>ssh root@your.server</code> then download the installation script:
 				</p>
 				<CopyToClipboardInput
 					class="u-mb10"

+ 8 - 6
docs/docs/contributing/development.md

@@ -32,10 +32,12 @@ multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
    git clone https://github.com/YourUsername/hestiacp.git $HOME/projects
    ```
 
-1. Create an Ubuntu VM with at least 2G of memory and 15G of disk space
+1. Create an Ubuntu VM with at least 2GB of memory and 15GB of disk space
+
+   _(if running VM on ARM architecture e.g. Apple M1, use at least 12GB of memory)_
 
    ```bash
-   multipass launch --name hestia-dev --memory 2G --disk 15G
+   multipass launch --name hestia-dev --memory 4G --disk 15G --cpus 4
    ```
 
 1. Map your cloned repository to the VM's home directory
@@ -58,7 +60,7 @@ multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
    node --version
    ```
 
-1. Install dependencies and build the theme files:
+1. Install dependencies and build the theme files
 
    ```bash
    npm install
@@ -69,16 +71,16 @@ multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
 
    ```bash
    cd src
-   ./hst_autocompile.sh --hestia --noinstall --keepbuild '~localsrc'
+   ./hst_autocompile.sh --all --noinstall --keepbuild '~localsrc'
    ```
 
-1. Navigate to `/install` and install Hestia
+1. Navigate to `/install` and install Hestia with these flags
 
    _(update the [installation flags](../introduction/getting-started#list-of-installation-options) to your liking, note that login credentials are set here)_
 
    ```bash
    cd ../install
-   bash hst-install-ubuntu.sh -D /tmp/hestiacp-src/deb/ --interactive no --email admin@example.com --password Password123 --hostname demo.hestiacp.com -f
+   bash hst-install-ubuntu.sh --hostname demo.hestiacp.com --email admin@example.com --username admin --password Password123 --with-debs /tmp/hestiacp-src/deb/ --interactive no --force
    ```
 
 1. Reboot the VM (and exit SSH session)

+ 1 - 1
src/hst_autocompile.sh

@@ -299,7 +299,7 @@ if [ "$dontinstalldeps" != 'true' ]; then
 			echo "Requires NodeJS 18.x or higher"
 			exit 1
 		fi
-		# Fix for Debian PHP Envroiment
+		# Fix for Debian PHP environment
 		if [ $BUILD_ARCH == "amd64" ]; then
 			if [ ! -L /usr/local/include/curl ]; then
 				ln -s /usr/include/x86_64-linux-gnu/curl /usr/local/include/curl

+ 8 - 9
web/templates/pages/edit_whitelabel.php

@@ -77,13 +77,12 @@
 							value="<?= htmlentities(trim($v_from_name, "'")) ?>"
 						>
 					</div>
-
 					<div class="u-mb10">
 						<label for="v_from_email" class="form-label">
 							<?= _("Sender Email Address") ?><span class="optional">(<?= _("Default") ?>: <?= sprintf("noreply@%s", htmlentities(trim(get_hostname(), "'"))) ?>)</span>
 						</label>
 						<input
-							type="text"
+							type="email"
 							class="form-control"
 							name="v_from_email"
 							id="v_from_email"
@@ -122,17 +121,17 @@
 				<div class="collapse-content">
 					<div class="u-mb10">
 						<label for="v_custom_logo" class="form-label">
-							<?= _("Custom logo") ?>
+							<?= _("Custom Logo") ?>
 						</label>
 					</div>
 					<div class="u-mb10">
-						<p><?= sprintf(_("Upload the files to %s"), "/usr/local/hestia/web/images/custom/") ?></p>
+						<p class="u-mb10"><?= sprintf(_("Upload the files to %s"), "/usr/local/hestia/web/images/custom/") ?></p>
 						<ul>
-							<li>logo.svg <small>(100px x 120px)</small></li>
-							<li>logo.png <small>(100px x 120px)</small></li>
-							<li>logo-header.svg <small>(54x x 29px)</small></li>
-							<li>favicon.png <small>(64px x 64px)</small></li>
-							<li>favicon.ico<small>(16px x 16px)</small></li>
+							<li><code>logo.svg</code> <small>(100px x 120px)</small></li>
+							<li><code>logo.png</code> <small>(100px x 120px)</small></li>
+							<li><code>logo-header.svg</code> <small>(54x x 29px)</small></li>
+							<li><code>favicon.png</code> <small>(64px x 64px)</small></li>
+							<li><code>favicon.ico</code> <small>(16px x 16px)</small></li>
 						</ul>
 					</div>
 					<div class="u-mb10">

+ 2 - 2
web/templates/pages/list_web.php

@@ -277,10 +277,10 @@
 								<a
 									class="units-table-row-action-link"
 									href="/list/web-log/?domain=<?= $key ?>&type=access#"
-									title="<?= _("Access Log") ?>"
+									title="<?= _("View Logs") ?>"
 								>
 									<i class="fas fa-binoculars icon-purple"></i>
-									<span class="u-hide-desktop"><?= _("Access Log") ?></span>
+									<span class="u-hide-desktop"><?= _("View Logs") ?></span>
 								</a>
 							</li>
 							<li class="units-table-row-action shortcut-s" data-key-action="js">

+ 2 - 2
web/templates/pages/list_weblog.php

@@ -37,9 +37,9 @@
 									</a>
 								</li>
 								<li class="top-bar-menu-item">
-									<a class="top-bar-menu-link <?php if ($_GET['type'] == 'access') echo 'active' ?>" href="/list/web-log/?domain=<?= htmlentities($_GET['domain']) ?>&type=access&token=<?= $_SESSION['token'] ?>" title="<?= _("Access Log") ?>">
+									<a class="top-bar-menu-link <?php if ($_GET['type'] == 'access') echo 'active' ?>" href="/list/web-log/?domain=<?= htmlentities($_GET['domain']) ?>&type=access&token=<?= $_SESSION['token'] ?>" title="<?= _("View Logs") ?>">
 										<i class="fas fa-eye"></i>
-										<span class="top-bar-menu-link-label"><?= _("Access Log") ?></span>
+										<span class="top-bar-menu-link-label"><?= _("View Logs") ?></span>
 									</a>
 								</li>
 								<li class="top-bar-menu-item">