mirrors/khuedoan-homelab
1
0
Fork 0
mirror of https://github.com/khuedoan/homelab.git synced 2024-12-22 22:34:41 +07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update local dev env instruction

Browse Source
This commit is contained in:
Khue Doan 2022-07-14 00:41:26 +07:00
parent c52c439fac
commit 0cafd02d8c
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -199,7 +199,7 @@ They can't capture all the project's features, but they are sufficient to get a
## Get Started
- [Try it out locally](https://homelab.khuedoan.com/installation/development) without any hardware
- [Try it out locally](https://homelab.khuedoan.com/installation/development) without any hardware (just 4 commands!)
- [Deploy on real hardware](https://homelab.khuedoan.com/installation/production/prerequisites) for production workload
## Roadmap

11
docs/installation/development.md
View File

@ -15,10 +15,11 @@ Please keep in mind that the development cluster may be unstable and things may
Host machine:
- OS: Linux (Windows and macOS will not work due to networking limitations, you can use a Linux VM)
- Recommended hardware specifications:
- CPU: 4 cores
- RAM: 16 GiB
- OS: Linux (Windows and macOS are untested, please let me know if it works)
- Available ports: `80` and `443`
Install the following packages:
@ -46,7 +47,13 @@ Build a development cluster and bootstrap it:
make
```
Look for the dashboard URL in the command output.
!!! note
It will take about 15 to 30 minutes to build depending on your internet connection
## Explore
The homepage should be available at <https://home.127-0-0-1.nip.io> (ignore the security warning because we don't have valid certificates).
## Clean up