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

Add links to detailed instructions

Browse Source
This commit is contained in:
Khue Doan 2021-08-03 17:13:48 +00:00
parent 3a3b7365b0
commit dc16722239
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -57,6 +57,8 @@ For bare metal nodes:
- Secure boot disabled (optional, depending on the OS)
- Note their MAC addresses
To view the detailed instruction, please visit the [Prerequisite document](https://khuedoan.github.io/homelab/deployment/prerequisite.html).
### Configurations
Change these configuration files to match your hardware and network setup:
@ -64,9 +66,11 @@ Change these configuration files to match your hardware and network setup:
- [Bare metal nodes settings](./metal/hosts.yml) (IP, MAC...)
- [OS settings](./metal/group_vars/all.yml) (PXE, network...)
To view the detailed instruction, please visit the [Configuration document](https://khuedoan.github.io/homelab/deployment/configuration.html).
### Build
Open the tools container:
You can install all the tools manually, or you can use the convenience tools container:
```sh
make tools
@ -78,6 +82,8 @@ Then build the homelab:
make
```
If you encounter any issue, please visit [Trouble shooting guide](https://khuedoan.github.io/homelab/troubleshooting/README.html)
## Roadmap
See [roadmap](https://khuedoan.github.io/homelab/roadmap.html) and [open issues](https://github.com/khuedoan/homelab/issues) for a list of proposed features and known issues.