Skip to content

Commit d166181

Browse files
authored
Improve development docs (hestiacp#3161)
1 parent d4ad985 commit d166181

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

docs/docs/contributing/development.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Hestia is an open-source project, and we welcome contributions from the communit
55
Hestia is designed to be installed on a web server. To develop Hestia on your local machine, a virtual machine is recommend.
66

77
::: warning
8-
Development builds are unstable. If you encounter a bug please [report it via GitHub](https://github.com/hestiacp/hestiacp/issues/new/choose) or [submit a Pull request](https://github.com/hestiacp/hestiacp/pulls).
8+
Development builds are unstable. If you encounter a bug please [report it via GitHub](https://github.com/hestiacp/hestiacp/issues/new/choose) or [submit a Pull Request](https://github.com/hestiacp/hestiacp/pulls).
99
:::
1010

1111
## Creating a virtual machine for development
@@ -14,6 +14,16 @@ These are example instructions for creating a virtual machine running Hestia for
1414

1515
These instructions use [Multipass](https://multipass.run/) to create the VM. Feel free to adapt the commands for any virtualization software you prefer.
1616

17+
::: warning
18+
Sometimes during this process, the mapping between the source code directory on your local machine to the directory in the VM can be lost. If this happens simply unmount and remount e.g.
19+
20+
```bash
21+
multipass unmount hestia-dev
22+
multipass mount $HOME/projects/hestiacp hestia-dev:/home/ubuntu/hestiacp
23+
```
24+
25+
:::
26+
1727
1. [Install Multipass](https://multipass.run/install) for your OS.
1828

1929
1. [Fork Hestia](https://github.com/hestiacp/hestiacp/fork) and clone the repository to your local machine
@@ -22,10 +32,10 @@ These instructions use [Multipass](https://multipass.run/) to create the VM. Fee
2232
git clone https://github.com/YourUsername/hestiacp.git $HOME/projects
2333
```
2434

25-
1. Create an Ubuntu VM with at least 2G of memory
35+
1. Create an Ubuntu VM with at least 2G of memory and 15G of disk space
2636

2737
```bash
28-
multipass launch --name hestia-dev --mem 2G
38+
multipass launch --name hestia-dev --mem 2G --disk 15G
2939
```
3040

3141
1. Map your cloned repository to the VM's home directory
@@ -37,7 +47,7 @@ These instructions use [Multipass](https://multipass.run/) to create the VM. Fee
3747
1. SSH into the VM as root and install some required packages
3848

3949
```bash
40-
multipass exec hestiacp-dev -- sudo bash
50+
multipass exec hestia-dev -- sudo bash
4151
sudo apt update && sudo apt install -y jq libjq1
4252
```
4353

@@ -54,7 +64,7 @@ These instructions use [Multipass](https://multipass.run/) to create the VM. Fee
5464

5565
```bash
5666
cd ../install
57-
bash hst-install.sh -D /tmp/hestiacp-src/deb/ --interactive no --email admin@example.com --password password123 --hostname demo.hestiacp.com -f
67+
bash hst-install-ubuntu.sh -D /tmp/hestiacp-src/deb/ --interactive no --email admin@example.com --password password123 --hostname demo.hestiacp.com -f
5868
```
5969

6070
1. Reboot VM (and exit SSH session)

docs/docs/server-administration/web-templates.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ FastCGI cache works best for sites get a lot of request and where the pages don
104104

105105
### Why does software package x and y not work with FastCGI cache
106106

107-
As we have over 20 different templates and we don’t use them all, we have decided to stop releasing new ones the future and hope the community helps improving the templates by [submitting a Pull request](https://github.com/hestiacp/hestiacp/pulls).
107+
As we have over 20 different templates and we don’t use them all, we have decided to stop releasing new ones the future and hope the community helps improving the templates by [submitting a Pull Request](https://github.com/hestiacp/hestiacp/pulls).
108108

109109
If you want to add support to a certain template, follow the instructions below.
110110

0 commit comments

Comments
 (0)