Skip to content

Commit 7ddff07

Browse files
authored
docs: add Homebrew install instructions and improve examples (#251)
Signed-off-by: Ignasi Barrera <ignasi@tetrate.io>
1 parent 9039cf6 commit 7ddff07

7 files changed

Lines changed: 21 additions & 12 deletions

File tree

cli/cmd/genconfig_help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Local extensions use `file://` URLs pointing to the locally cached binaries.
1515

1616
## Examples
1717

18-
Generate a complete Envoy configuration with the `example-lua` extension:
18+
Generate a complete Envoy configuration for the desired extensions:
1919

2020
```shell
2121
boe gen-config --extension ip-restriction
@@ -56,5 +56,5 @@ Generate configuration from a specific version hosted in a custom OCI registry:
5656
export BOE_REGISTRY_USERNAME=username
5757
export BOE_REGISTRY_PASSWORD=password
5858

59-
boe gen-config --extension example-lua:1.0.0
59+
boe gen-config --extension example-go:0.3.0
6060
```

cli/cmd/list_help.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The output shows a table with the extension name, version, type, and a brief des
1717

1818
```
1919
NAME VERSION TYPE DESCRIPTION
20-
example-lua 1.0.0 lua A simple Lua extension that adds a custom header
21-
cors 1.0.0 lua Cross-Origin Resource Sharing (CORS) support
20+
chat-completions-decoder 0.3.0 go Decodes OpenAI Chat Completion requests and responses and...
21+
example-lua 1.0.0 lua Comprehensive example demonstrating Envoy Lua HTTP filter...
22+
ip-restriction 0.1.1 rust IP-based access control using allowlists or denylists
2223
```

website/src/components/Hero.astro

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ const highlighter = await createHighlighter({
88
});
99
1010
const installCmd = `curl -sL ${WEBSITE}/install.sh | sh`;
11-
const runCmd = `${CLI_NAME} run --extension example-go --extension example-lua`;
11+
const runCmd = `${CLI_NAME} run --extension example-go --local ./my-extension`;
1212
1313
const installHtml = highlighter.codeToHtml(installCmd, { lang: 'bash', theme: 'github-dark' });
1414
const runHtml = highlighter.codeToHtml(runCmd, { lang: 'bash', theme: 'github-dark' });

website/src/pages/docs/cli/gen-config.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Local extensions use `file://` URLs pointing to the locally cached binaries.
2323

2424
## Examples
2525

26-
Generate a complete Envoy configuration with the `example-lua` extension:
26+
Generate a complete Envoy configuration for the desired extensions:
2727

2828
```shell
2929
boe gen-config --extension ip-restriction
@@ -64,7 +64,7 @@ Generate configuration from a specific version hosted in a custom OCI registry:
6464
export BOE_REGISTRY_USERNAME=username
6565
export BOE_REGISTRY_PASSWORD=password
6666

67-
boe gen-config --extension example-lua:1.0.0
67+
boe gen-config --extension example-go:0.3.0
6868
```
6969

7070

website/src/pages/docs/cli/list.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ The output shows a table with the extension name, version, type, and a brief des
2525

2626
```
2727
NAME VERSION TYPE DESCRIPTION
28-
example-lua 1.0.0 lua A simple Lua extension that adds a custom header
29-
cors 1.0.0 lua Cross-Origin Resource Sharing (CORS) support
28+
chat-completions-decoder 0.3.0 go Decodes OpenAI Chat Completion requests and responses and...
29+
example-lua 1.0.0 lua Comprehensive example demonstrating Envoy Lua HTTP filter...
30+
ip-restriction 0.1.1 rust IP-based access control using allowlists or denylists
3031
```
3132

3233

website/src/pages/docs/custom-registry.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export BOE_REGISTRY_INSECURE=true
5151
Or with the `--insecure` flag:
5252

5353
```bash
54-
boe run --registry localhost:5000/extensions --insecure --extension example-lua
54+
boe run --registry localhost:5000/extensions --insecure --extension example-go
5555
```
5656

5757
## Publishing extensions to a custom registry

website/src/pages/docs/getting-started.mdx

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,13 @@ Choose your preferred installation method:
1818
curl -sL https://builtonenvoy.io/install.sh | sh
1919
```
2020

21+
### Homebrew
22+
23+
```bash
24+
brew tap tetratelabs/boe
25+
brew install boe
26+
```
27+
2128
### Build from source
2229

2330
```bash
@@ -45,7 +52,7 @@ system and architecture, and start it preconfigured with the requested extension
4552
upstream:
4653

4754
```shell
48-
boe run --extension example-lua --extension cache
55+
boe run --extension example-go --extension chat-completions-decoder
4956
```
5057

5158
Or run extensions directly from a local directory:
@@ -59,7 +66,7 @@ boe run --local ./my-extension
5966
Inspect the Envoy configuration so that you can replicate it in your environment:
6067

6168
```shell
62-
boe gen-config --extension example-lua --local ./my-extension >envoy.yaml
69+
boe gen-config --extension example-go --local ./my-extension --output /tmp/config-export
6370
```
6471

6572
## Next steps

0 commit comments

Comments
 (0)