From 27e7901bab0b17931a95c68b40ffaa18c175bc8b Mon Sep 17 00:00:00 2001 From: Kenneth Bingham Date: Fri, 3 May 2024 10:33:13 -0400 Subject: [PATCH] organize nginx guide in linux category --- docs/concepts/hosting.md | 2 +- docs/concepts/index.md | 2 +- docs/getting-started.mdx | 7 ++++--- docs/guides/self-hosting/linux/_category_.json | 8 ++++++++ docs/guides/self-hosting/{linux.mdx => linux/index.mdx} | 6 +++--- .../self-hosting/{nginx_tls_guide.md => linux/nginx.mdx} | 2 +- website/docusaurus.config.js | 4 ++++ 7 files changed, 22 insertions(+), 9 deletions(-) create mode 100644 docs/guides/self-hosting/linux/_category_.json rename docs/guides/self-hosting/{linux.mdx => linux/index.mdx} (95%) rename docs/guides/self-hosting/{nginx_tls_guide.md => linux/nginx.mdx} (94%) diff --git a/docs/concepts/hosting.md b/docs/concepts/hosting.md index b48f88a7..69ad4ceb 100644 --- a/docs/concepts/hosting.md +++ b/docs/concepts/hosting.md @@ -6,7 +6,7 @@ sidebar_position: 200 ## Self-Hosted -`zrok` is not limited to a managed offering. You can [host your own](/guides/self-hosting/linux.mdx) instance of `zrok` as well. `zrok` is +`zrok` is not limited to a managed offering. You can [host your own]/guides/self-hosting/linux/index.mdx) instance of `zrok` as well. `zrok` is also freely available as open source software hosted by GitHub under a very permissive Apache v2 license. ## Managed Service diff --git a/docs/concepts/index.md b/docs/concepts/index.md index 4fba24ba..410ca6ad 100644 --- a/docs/concepts/index.md +++ b/docs/concepts/index.md @@ -10,4 +10,4 @@ sidebar_position: 25 Sharing with `zrok` can be either [`public`](./sharing-public.md) or [`private`](./sharing-private.md). Naturally, regular web-based resources can be shared but `zrok` also includes support for sharing raw [TCP](./tunnels.md) and [UDP](./tunnels.md) network connections, and also includes a [website and file sharing](./files.md) feature. -Learn about `zrok` [hosting here](./hosting.md), including instructions on how to [install your own `zrok` instance](/guides/self-hosting/linux.mdx). +Learn about `zrok` [hosting here](./hosting.md), including instructions on how to [install your own `zrok` instance]/guides/self-hosting/linux/index.mdx). diff --git a/docs/getting-started.mdx b/docs/getting-started.mdx index 38b60ba3..a0ab1046 100644 --- a/docs/getting-started.mdx +++ b/docs/getting-started.mdx @@ -356,7 +356,8 @@ You use the `zrok reserve` command to create _reserved shares_. Reserved shares ## Self-Hosting an Instance -Interested in self-hosting your own `zrok` instance? See the [self-hosting guide](./guides/self-hosting/linux.mdx) for details. +Interested in self-hosting your own `zrok` instance? See the [self-hosting guides](/docs/category/self-hosting/)! -[openziti]: https://docs.openziti.io/docs/learn/introduction/ "OpenZiti" -[ zrok-download]: https://zrok.io "zrok Download" +## Resources + +- Learn about [OpenZiti](https://openziti.io/) diff --git a/docs/guides/self-hosting/linux/_category_.json b/docs/guides/self-hosting/linux/_category_.json new file mode 100644 index 00000000..b2e94028 --- /dev/null +++ b/docs/guides/self-hosting/linux/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Linux", + "position": 10, + "link": { + "type": "doc", + "id": "index" + } +} diff --git a/docs/guides/self-hosting/linux.mdx b/docs/guides/self-hosting/linux/index.mdx similarity index 95% rename from docs/guides/self-hosting/linux.mdx rename to docs/guides/self-hosting/linux/index.mdx index 926a40ca..b23dbb7f 100644 --- a/docs/guides/self-hosting/linux.mdx +++ b/docs/guides/self-hosting/linux/index.mdx @@ -109,9 +109,9 @@ The `ziti` section defines how the `zrok` controller should communicate with you :::note -Be sure to see the [reference configuration at `etc/ctrl.yml`](../../../etc/ctrl.yml) for the complete documentation of the current configuration file format for the `zrok` controller and service instance components. +Be sure to see the [reference configuration at `etc/ctrl.yml`](../../../../etc/ctrl.yml) for the complete documentation of the current configuration file format for the `zrok` controller and service instance components. -See the separate guides on [configuring metrics](./metrics-and-limits/configuring-metrics.md) and [configuring limits](./metrics-and-limits/configuring-limits.md) for details about both of these specialized areas of service instance configuration. +See the separate guides on [configuring metrics](/guides/self-hosting/metrics-and-limits/configuring-metrics.md) and [configuring limits](/guides/self-hosting/metrics-and-limits/configuring-limits.md) for details about both of these specialized areas of service instance configuration. ::: @@ -233,7 +233,7 @@ This frontend config file has a `host_match` pattern that represents the DNS zon The frontend does not provide server TLS, but you may front the server with a reverse proxy. It is essential the reverse proxy forwards the `Host` header supplied by the viewer. This example will expose the non-TLS listener for the frontend. -You can also specify an `oauth` configuration in this file, full details of are found in [OAuth Public Frontend Configuration](oauth/configuring-oauth.md#configuring-your-public-frontend). +You can also specify an `oauth` configuration in this file, full details of are found in [OAuth Public Frontend Configuration](/guides/self-hosting/oauth/configuring-oauth.md#configuring-your-public-frontend). ## Start Public Frontend diff --git a/docs/guides/self-hosting/nginx_tls_guide.md b/docs/guides/self-hosting/linux/nginx.mdx similarity index 94% rename from docs/guides/self-hosting/nginx_tls_guide.md rename to docs/guides/self-hosting/linux/nginx.mdx index d36d6f21..427521ea 100644 --- a/docs/guides/self-hosting/nginx_tls_guide.md +++ b/docs/guides/self-hosting/linux/nginx.mdx @@ -11,7 +11,7 @@ sidebar_label: NGINX TLS ## Before You Begin -I'll assume you have a running zrok controller and frontend and wish to front both with NGINX providing server TLS. Go back to [Self-Hosting Guide](./linux.mdx) if you still need to spin those up. +I'll assume you have a running `zrok` controller and frontend and wish to front both with NGINX providing server TLS. Go back to [Self-Hosting Guide](/guides/self-hosting/linux/index.mdx) if you still need to spin those up. ## Choose a Reverse Proxy Address diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 8ed21f19..d0521ffd 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -38,6 +38,10 @@ const config = { to: '/docs/guides/self-hosting/linux', from: ['/docs/guides/self-hosting/self_hosting_guide'], }, + { + to: '/docs/guides/self-hosting/linux/nginx', + from: ['/docs/guides/self-hosting/nginx_tls_guide/'] + }, { to: '/docs/guides/self-hosting/metrics-and-limits/configuring-limits', from: ['/docs/guides/metrics-and-limits/configuring-limits'],