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

style(docs): updated code highlighted farmer and sprout

Browse Source 
- Changed `farmer` to farmer
- Changed `sprout` to sprout
This commit is contained in:
Ethan Holz
2023-11-04 13:38:53 -05:00
parent e869d1a3bf
commit 57bd363f34
2 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/content/docs/getting-started.mdx
View File

@@ -60,16 +60,16 @@ Install the CLI on your development machine with the correct command for your ar
</TabItem>
</Tabs>
You'll be asked some questions, such as which interface the `farmer` is listening on, and which ports to use for communication.
Set the interface to the domain name or IP address of the `farmer`.
You'll be asked some questions, such as which interface the farmer is listening on, and which ports to use for communication.
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!
It's recommended you now add `grlx` somewhere in your `$PATH`.
---
### 2. Install the `farmer` on the control server
### 2. Install the farmer on the control server
You will then need to install the `farmer` on the control server. The `farmer` is the central server that manages the fleet.
You will then need to install the farmer on the control server. The farmer is the central server that manages the fleet.
<Tabs>
<TabItem label="systemd (Recommended)">
@@ -180,9 +180,9 @@ You will then need to install the `farmer` on the control server. The `farmer` i
---
### 3. Install the `sprout` on every node you want to manage
### 3. Install the sprout on every node you want to manage
The `sprout` is the agent that runs on every node you want to manage. It's responsible for executing commands and reporting back to the `farmer`.
The sprout is the agent that runs on every node you want to manage. It's responsible for executing commands and reporting back to the farmer.
```bash
# or, just run as root instead of sudo
@@ -195,9 +195,9 @@ Once the sprout is up and running, return to the CLI.
---
### 4. Accept the TLS cert and the `sprout` keys
### 4. Accept the TLS cert and the sprout keys
Next, you must accept each `sprout`'s public key and the `farmer`'s TLS certificate. This is done using the `keys` command. Furthermore, using `grlx version`, shows you that you are able to connect to your farmer.
Next, you must accept each sprout's public key and the farmer's TLS certificate. This is done using the `keys` command. Furthermore, using `grlx version`, shows you that you are able to connect to your farmer.
```bash
grlx version

2
src/content/docs/ingredients/file-providers.md
View File

@@ -2,7 +2,7 @@
title: grlx.ingedients.file.providers
description: grlx built-in file providers
---
`grlx` has a concept of file providers for different ways that you might obtain a file to be added to a given `sprout`. This uses a provider interface to keep this extensible and provide a standard way to use different file types. The `go` interface for File Providers looks like the following:
`grlx` has a concept of file providers for different ways that you might obtain a file to be added to a given sprout. This uses a provider interface to keep this extensible and provide a standard way to use different file types. The `go` interface for File Providers looks like the following:
```go
type FileProvider interface {
Download(context.Context) error