gogrlx/bootstrap.grlx.dev
1
0
Fork 0
mirror of https://github.com/gogrlx/bootstrap.grlx.dev.git synced 2026-04-02 02:59:05 -07:00
Code Issues Packages Projects Releases Wiki Activity

add gifs to readme

Browse Source
This commit is contained in:
Tai Groot
2023-10-21 19:35:25 -07:00
parent 5f844df966
commit 05155f2df9
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -15,6 +15,7 @@ You'll be asked some questions, such as which interface the `farmer` is listenin
Set the interface to the domain name or IP address of the `farmer`. Set the interface to the domain name or IP address of the `farmer`.
Once configured, the CLI prints out your administrator public key, which you'll need for the next step! Once configured, the CLI prints out your administrator public key, which you'll need for the next step!
## <p align="center"><img src="docs/grlx-install.gif"></p>
2. On your control server, you'll need to install the `farmer`. 2. On your control server, you'll need to install the `farmer`.
```bash ```bash
# or, just run as root instead of sudo # or, just run as root instead of sudo
@@ -25,6 +26,7 @@ For the quick start, it's recommended to use the default ports (make sure there'
You'll be prompted for an admin public key, which you should have gotten from the prior step, and a certificate host name(s). You'll be prompted for an admin public key, which you should have gotten from the prior step, and a certificate host name(s).
Make sure the certificate host name matches the external-facing interface (a domain or IP address) as it will be used for TLS validation! Make sure the certificate host name matches the external-facing interface (a domain or IP address) as it will be used for TLS validation!
## <p align="center"><img src="docs/farmer-install.gif"></p>
3. On all of your fleet nodes, you'll need to install the `sprout`. 3. On all of your fleet nodes, you'll need to install the `sprout`.
```bash ```bash
# Set FARMER_INTERFACE to your farmer's domain name. FARMER_BUS_PORT and FARMER_API_PORT # Set FARMER_INTERFACE to your farmer's domain name. FARMER_BUS_PORT and FARMER_API_PORT
@@ -33,6 +35,8 @@ curl -L https://bootstrap.grlx.dev/latest/sprout | FARMER_INTERFACE=localhost su
``` ```
Once the sprout is up and running, return to the CLI. Once the sprout is up and running, return to the CLI.
## <p align="center"><img src="docs/sprout-install.gif"></p>
4. If all is well, you're ready to `cook`! 4. If all is well, you're ready to `cook`!
```bash ```bash
grlx keys accept -A grlx keys accept -A
@@ -41,3 +45,5 @@ grlx -T \* test ping
grlx -T \* cmd run whoami grlx -T \* cmd run whoami
grlx -T \* cmd run --out json -- uname -a grlx -T \* cmd run --out json -- uname -a
``` ```
## <p align="center"><img src="docs/grlx-cmd.gif"></p>