From 785be74160d92194f8fc98cf989b1f3440814963 Mon Sep 17 00:00:00 2001 From: Andrea Ciceri Date: Mon, 16 Sep 2024 14:36:20 +0200 Subject: [PATCH 1/2] Fix docs generation when used from third repos Not sure why this happens, anyway should be harmless --- docs/render.nix | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/render.nix b/docs/render.nix index 42fbb92..a01f5c8 100644 --- a/docs/render.nix +++ b/docs/render.nix @@ -253,6 +253,7 @@ in { unpackPhase = '' cp -r $src docs chmod -R +w docs + rm -rf ${docsPath} ''; buildPhase = '' From c48b55e67a23ac13a2bed0bdeb9d3c6e5e069ce0 Mon Sep 17 00:00:00 2001 From: Andrea Ciceri Date: Mon, 16 Sep 2024 14:36:32 +0200 Subject: [PATCH 2/2] Fix wrong links --- docs/getting-started/load-balancer.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/getting-started/load-balancer.md b/docs/getting-started/load-balancer.md index ef9d7ec..1ef6de0 100644 --- a/docs/getting-started/load-balancer.md +++ b/docs/getting-started/load-balancer.md @@ -1,4 +1,4 @@ -`cardano.nix` provides the [`cardano.http`](../reference/module-options/cardano.http/) and [`services.http-proxy`](../reference/module-options/services.http-proxy/) NixOS modules, which implement a HTTP Load Balancing Reverse Proxy and TLS Endpoint using the [`nginx`](https://nginx.org/en/) HTTP server. +`cardano.nix` provides the [`cardano.http`](../reference/module-options/cardano.http.md) and [`services.http-proxy`](../reference/module-options/services.http-proxy.md) NixOS modules, which implement a HTTP Load Balancing Reverse Proxy and TLS Endpoint using the [`nginx`](https://nginx.org/en/) HTTP server. Our focus here is to facilitate robust, secure, and efficient HTTP traffic management for Cardano services through load balancing and TLS termination. @@ -13,7 +13,7 @@ Key features of this module include: - **TLS Termination**: Manage SSL/TLS certificates with Let's Enctypt ACME and handle encryption/decryption at the proxy level. - **Integration with Cardano Services**: Define default forwarded services for backend services included in `cardano.nix`. -See documentation for the [`cardano.http`](../reference/module-options/cardano.http/) and [`services.http-proxy`](../reference/module-options/services.http-proxy/) NixOS modules. +See documentation for the [`cardano.http`](../reference/module-options/cardano.http.md) and [`services.http-proxy`](../reference/module-options/services.http-proxy.md) NixOS modules. ## Flake template with load balancer @@ -73,7 +73,7 @@ Alternatively, a wildcard record may be added for `*.my.example.com`. NixOS has to be installed on the cloud machines. If the cloud provider does not have NixOS images, this can be achieved starting from mainstream distros like Debian or Ubuntu using [nixos-infect](https://github.com/elitak/nixos-infect) from cloud-init user data. A better option is to generate cloud images, eg. using [nixos-generators]https://github.com/nix-community/nixos-generators) and start the cloud machines from those. -To deploy operating system configuration via SSH, `services.openssh` needs to be configured and `users.users.root.openssh.authorizedKeys.keys` set. Deployment can be done via `nixos-rebuild --flake . --target-host HOST` or using a [deployment app](https://github.com/nix-community/awesome-nix?tab=readme-ov-file#deployment-tools) such as [https://github.com/zhaofengli/colmena](colmena), or integrated into an infrastructure tool like [terraform-nixos](https://github.com/nix-community/terraform-nixos). +To deploy operating system configuration via SSH, `services.openssh` needs to be configured and `users.users.root.openssh.authorizedKeys.keys` set. Deployment can be done via `nixos-rebuild --flake . --target-host HOST` or using a [deployment app](https://github.com/nix-community/awesome-nix?tab=readme-ov-file#deployment-tools) such as [colmena](https://github.com/zhaofengli/colmena), or integrated into an infrastructure tool like [terraform-nixos](https://github.com/nix-community/terraform-nixos). #### Node Adresses @@ -110,8 +110,8 @@ This will set up [Let's Encrypt ACME TLS certificates](https://letsencrypt.org/h Check out the following documentation: -[`cardano.http` NixOS module documentation](../reference/module-options/cardano.http/) +[`cardano.http` NixOS module documentation](../reference/module-options/cardano.http.md) -[`services.http-proxy` NixOS module documentation](../reference/module-options/services.http-proxy/) +[`services.http-proxy` NixOS module documentation](../reference/module-options/services.http-proxy.md) [NixOS options](https://search.nixos.org/options) such as `services.nginx`, `networking.firewall`.