Skip to content

Commit afe73c8

Browse files
authored
Update development docs (hestiacp#4136)
* Tidy development docs * Fix typo * Improve view logs copy * Missing space * Tidy * Increase recommended dev VM memory * Mention user prompt * PR feedback
1 parent ee3ea29 commit afe73c8

File tree

7 files changed

+23
-22
lines changed

7 files changed

+23
-22
lines changed

bin/v-update-sys-hestia-git

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ else
264264
echo "Installing dependencies for compilation..."
265265
apt-get -qq install -y $SOFTWARE > /dev/null 2>&1
266266

267-
# Fix for Debian PHP Envroiment
267+
# Fix for Debian PHP environment
268268
if [ $BUILD_ARCH == "amd64" ]; then
269269
if [ ! -L /usr/local/include/curl ]; then
270270
ln -s /usr/include/x86_64-linux-gnu/curl /usr/local/include/curl

docs/.vitepress/theme/components/InstallBuilder.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<h2 class="u-text-center">Installation instructions</h2>
66
<p class="u-mb10">
77
Log in to your server e.g.
8-
<code>ssh root@your.server</code> and download the installation script:
8+
<code>ssh root@your.server</code> then download the installation script:
99
</p>
1010
<CopyToClipboardInput
1111
class="u-mb10"

docs/docs/contributing/development.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,12 @@ multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
3232
git clone https://github.com/YourUsername/hestiacp.git $HOME/projects
3333
```
3434

35-
1. Create an Ubuntu VM with at least 2G of memory and 15G of disk space
35+
1. Create an Ubuntu VM with at least 2GB of memory and 15GB of disk space
36+
37+
_(if running VM on ARM architecture e.g. Apple M1, use at least 12GB of memory)_
3638

3739
```bash
38-
multipass launch --name hestia-dev --memory 2G --disk 15G
40+
multipass launch --name hestia-dev --memory 4G --disk 15G --cpus 4
3941
```
4042

4143
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
5860
node --version
5961
```
6062

61-
1. Install dependencies and build the theme files:
63+
1. Install dependencies and build the theme files
6264

6365
```bash
6466
npm install
@@ -69,16 +71,16 @@ multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
6971

7072
```bash
7173
cd src
72-
./hst_autocompile.sh --hestia --noinstall --keepbuild '~localsrc'
74+
./hst_autocompile.sh --all --noinstall --keepbuild '~localsrc'
7375
```
7476

75-
1. Navigate to `/install` and install Hestia
77+
1. Navigate to `/install` and install Hestia with these flags
7678

7779
_(update the [installation flags](../introduction/getting-started#list-of-installation-options) to your liking, note that login credentials are set here)_
7880

7981
```bash
8082
cd ../install
81-
bash hst-install-ubuntu.sh -D /tmp/hestiacp-src/deb/ --interactive no --email admin@example.com --password Password123 --hostname demo.hestiacp.com -f
83+
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
8284
```
8385

8486
1. Reboot the VM (and exit SSH session)

src/hst_autocompile.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ if [ "$dontinstalldeps" != 'true' ]; then
299299
echo "Requires NodeJS 18.x or higher"
300300
exit 1
301301
fi
302-
# Fix for Debian PHP Envroiment
302+
# Fix for Debian PHP environment
303303
if [ $BUILD_ARCH == "amd64" ]; then
304304
if [ ! -L /usr/local/include/curl ]; then
305305
ln -s /usr/include/x86_64-linux-gnu/curl /usr/local/include/curl

web/templates/pages/edit_whitelabel.php

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,12 @@ class="form-control"
7777
value="<?= htmlentities(trim($v_from_name, "'")) ?>"
7878
>
7979
</div>
80-
8180
<div class="u-mb10">
8281
<label for="v_from_email" class="form-label">
8382
<?= _("Sender Email Address") ?><span class="optional">(<?= _("Default") ?>: <?= sprintf("noreply@%s", htmlentities(trim(get_hostname(), "'"))) ?>)</span>
8483
</label>
8584
<input
86-
type="text"
85+
type="email"
8786
class="form-control"
8887
name="v_from_email"
8988
id="v_from_email"
@@ -122,17 +121,17 @@ class="form-control"
122121
<div class="collapse-content">
123122
<div class="u-mb10">
124123
<label for="v_custom_logo" class="form-label">
125-
<?= _("Custom logo") ?>
124+
<?= _("Custom Logo") ?>
126125
</label>
127126
</div>
128127
<div class="u-mb10">
129-
<p><?= sprintf(_("Upload the files to %s"), "/usr/local/hestia/web/images/custom/") ?></p>
128+
<p class="u-mb10"><?= sprintf(_("Upload the files to %s"), "/usr/local/hestia/web/images/custom/") ?></p>
130129
<ul>
131-
<li>logo.svg <small>(100px x 120px)</small></li>
132-
<li>logo.png <small>(100px x 120px)</small></li>
133-
<li>logo-header.svg <small>(54x x 29px)</small></li>
134-
<li>favicon.png <small>(64px x 64px)</small></li>
135-
<li>favicon.ico<small>(16px x 16px)</small></li>
130+
<li><code>logo.svg</code> <small>(100px x 120px)</small></li>
131+
<li><code>logo.png</code> <small>(100px x 120px)</small></li>
132+
<li><code>logo-header.svg</code> <small>(54x x 29px)</small></li>
133+
<li><code>favicon.png</code> <small>(64px x 64px)</small></li>
134+
<li><code>favicon.ico</code> <small>(16px x 16px)</small></li>
136135
</ul>
137136
</div>
138137
<div class="u-mb10">

web/templates/pages/list_web.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -277,10 +277,10 @@ class="units-table-row-action-link"
277277
<a
278278
class="units-table-row-action-link"
279279
href="/list/web-log/?domain=<?= $key ?>&type=access#"
280-
title="<?= _("Access Log") ?>"
280+
title="<?= _("View Logs") ?>"
281281
>
282282
<i class="fas fa-binoculars icon-purple"></i>
283-
<span class="u-hide-desktop"><?= _("Access Log") ?></span>
283+
<span class="u-hide-desktop"><?= _("View Logs") ?></span>
284284
</a>
285285
</li>
286286
<li class="units-table-row-action shortcut-s" data-key-action="js">

web/templates/pages/list_weblog.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ class="top-bar-menu-link u-hide-tablet"
3737
</a>
3838
</li>
3939
<li class="top-bar-menu-item">
40-
<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") ?>">
40+
<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") ?>">
4141
<i class="fas fa-eye"></i>
42-
<span class="top-bar-menu-link-label"><?= _("Access Log") ?></span>
42+
<span class="top-bar-menu-link-label"><?= _("View Logs") ?></span>
4343
</a>
4444
</li>
4545
<li class="top-bar-menu-item">

0 commit comments

Comments
 (0)