Skip to content

Commit

Permalink
feat: upgrade docusaurus
Browse files Browse the repository at this point in the history
Signed-off-by: Russ Savage <[email protected]>
  • Loading branch information
russorat committed Sep 10, 2024
1 parent bbe325b commit 94b3bc5
Show file tree
Hide file tree
Showing 5 changed files with 5,545 additions and 8,031 deletions.
4 changes: 2 additions & 2 deletions docs/guides/device-gateway/arm64.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ If you want to perform remote administration on your ARM64 device using a reserv
Separately from SSH access, you can also use ngrok to create an [HTTP tunnel](/docs/http/index.mdx) to route traffic to specific applications or services running on your ARM64 device's `localhost` network.

:::note
If you already established a TCP tunnel for SSH access, you'll either need to create a second tunnel for the HTTP tunnel, or use the [agent configuration file](/docs/agent/config.mdx) to define multiple tunnels.
If you already established a TCP tunnel for SSH access, you'll either need to create a second tunnel for the HTTP tunnel, or use the [agent configuration file](/docs/agent/config/v3/) to define multiple tunnels.
:::
1. Use ngrok to create an HTTP tunnel at the port on which your service operates, e.g. port `8080`.
Expand Down Expand Up @@ -160,5 +160,5 @@ Now that you have SSH tunneling and service ingress handled via ngrok, you may a
Now that you can create ngrok tunnels on your Linux ARM64 device and understand the fundamentals of managing traffic with policies, you can extend your usage to make your device—or even a fleet of them—ready for production usage.

- Bring a [custom domain](/docs/guides/how-to-set-up-a-custom-domain.md) to ngrok to create static endpoints.
- Learn how to write an [agent configuration file](/docs/agent/config.mdx) to define and create multiple tunnels from a single command line.
- Learn how to write an [agent configuration file](/docs/agent/config/v3/) to define and create multiple tunnels from a single command line.
- Install [ngrok as a service](/docs/agent/index.mdx#background-service) to start after your ARM64 device boots and automatically restart after crashes.
2 changes: 1 addition & 1 deletion docs/integrations/digitalocean/gslb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ To get some tunnels online and quickly see how ngrok's GSLB works, you'll use an
1. A straightforward Go-based API with a single endpoint at `/api`, which returns a randomly generated UUID and the machine's `hostname`, which should reflect the regions of your VMs.
2. A `Dockerfile` for containerizing said Go-based API.
3. A `docker-compose.yml` file for starting the API container and a containerized edition of the ngrok agent on the same network.
4. A `ngrok.yml` [agent configuration file](/docs/agent/config.mdx) to connect the agent to your ngrok account and one of the Tunnel Group backends you previously created.
4. A `ngrok.yml` [agent configuration file](/docs/agent/config/v3/) to connect the agent to your ngrok account and one of the Tunnel Group backends you previously created.

Repeat the following steps on **each** VM:

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/linode/gslb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ To get some tunnels online and quickly see how ngrok's GSLB works, you'll use an
1. A straightforward Go-based API with a single endpoint at `/api`, which returns a randomly generated UUID and the machine's `hostname`, which should reflect the regions of your VMs.
2. A `Dockerfile` for containerizing said Go-based API.
3. A `docker-compose.yml` file for starting the API container and a containerized edition of the ngrok agent on the same network.
4. A `ngrok.yml` [agent configuration file](/docs/agent/config.mdx) to connect the agent to your ngrok account and one of the Tunnel Group backends you previously created.
4. A `ngrok.yml` [agent configuration file](/docs/agent/config/v3/) to connect the agent to your ngrok account and one of the Tunnel Group backends you previously created.

Repeat the following steps on **each** VM:

Expand Down
22 changes: 11 additions & 11 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@
"write-heading-ids": "docusaurus write-heading-ids"
},
"dependencies": {
"@docusaurus/core": "3.4.0",
"@docusaurus/plugin-client-redirects": "3.4.0",
"@docusaurus/plugin-google-analytics": "3.4.0",
"@docusaurus/preset-classic": "3.4.0",
"@docusaurus/theme-mermaid": "3.4.0",
"@docusaurus/utils": "3.4.0",
"@docusaurus/core": "3.5.2",
"@docusaurus/plugin-client-redirects": "3.5.2",
"@docusaurus/plugin-google-analytics": "3.5.2",
"@docusaurus/preset-classic": "3.5.2",
"@docusaurus/theme-mermaid": "3.5.2",
"@docusaurus/utils": "3.5.2",
"@loadable/component": "5.16.4",
"@mdx-js/react": "3.0.1",
"@stackql/docusaurus-plugin-hubspot": "^1.1.0",
Expand All @@ -46,11 +46,11 @@
"zod": "3.23.8"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.4.0",
"@docusaurus/plugin-content-docs": "3.4.0",
"@docusaurus/theme-classic": "3.4.0",
"@docusaurus/tsconfig": "3.4.0",
"@docusaurus/types": "3.4.0",
"@docusaurus/module-type-aliases": "3.5.2",
"@docusaurus/plugin-content-docs": "3.5.2",
"@docusaurus/theme-classic": "3.5.2",
"@docusaurus/tsconfig": "3.5.2",
"@docusaurus/types": "3.5.2",
"@ianvs/prettier-plugin-sort-imports": "4.2.1",
"@types/loadable__component": "5.13.9",
"@types/node": "20.14.2",
Expand Down
Loading

0 comments on commit 94b3bc5

Please sign in to comment.