fix: update readme
This commit is contained in:
1 file changed
+11
-11
@@ -40,6 +40,17 @@ Bare metal or VMs with any modern operating system like Ubuntu, Debian or CentOS
|
|||||||
|
|
||||||
It's very important and I cannot stress enough, make sure you are not pushing your secrets un-encrypted to a public Git repo.
|
It's very important and I cannot stress enough, make sure you are not pushing your secrets un-encrypted to a public Git repo.
|
||||||
|
|
||||||
|
### pre-commit
|
||||||
|
|
||||||
|
It is advisable to install [pre-commit](https://pre-commit.com/) and the pre-commit hooks that come with this repository.
|
||||||
|
[sops-pre-commit](https://github.com/k8s-at-home/sops-pre-commit) will check to make sure you are not by accident commiting your secrets un-encrypted.
|
||||||
|
|
||||||
|
After pre-commit is installed on your machine run:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
pre-commit install-hooks
|
||||||
|
```
|
||||||
|
|
||||||
## :rocket: Lets go!
|
## :rocket: Lets go!
|
||||||
|
|
||||||
Very first step will be to create a new repository by clicking the **Use this template** button on this page.
|
Very first step will be to create a new repository by clicking the **Use this template** button on this page.
|
||||||
@@ -208,17 +219,6 @@ sudo echo "${BOOTSTRAP_INGRESS_NGINX_LB} ${BOOTSTRAP_DOMAIN} homer.${BOOTSTRAP_D
|
|||||||
|
|
||||||
Head over to your browser and you _should_ be able to access `https://homer.${BOOTSTRAP_DOMAIN}`
|
Head over to your browser and you _should_ be able to access `https://homer.${BOOTSTRAP_DOMAIN}`
|
||||||
|
|
||||||
### pre-commit
|
|
||||||
|
|
||||||
It is advisable to install [pre-commit](https://pre-commit.com/) and the pre-commit hooks that come with this repository.
|
|
||||||
[sops-pre-commit](https://github.com/k8s-at-home/sops-pre-commit) will check to make sure you are not by accident commiting your SOPS secrets un-encrypted.
|
|
||||||
|
|
||||||
After pre-commit is installed run:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
pre-commit install-hooks
|
|
||||||
```
|
|
||||||
|
|
||||||
### direnv
|
### direnv
|
||||||
|
|
||||||
This is a great tool to export environment variables depending on what your present working directory is, head over to their [installation guide](https://direnv.net/docs/installation.html) and don't forget to hook it into your shell!
|
This is a great tool to export environment variables depending on what your present working directory is, head over to their [installation guide](https://direnv.net/docs/installation.html) and don't forget to hook it into your shell!
|
||||||
|
|||||||
Reference in new issue
Block a user