From 07c9f7f84fa8fbb64925adb28fedc4c8dcdca738 Mon Sep 17 00:00:00 2001 From: pcone Date: Thu, 15 Feb 2024 16:49:23 -0500 Subject: [PATCH] simplified process --- docs/hero_mdbook_fullvm.md | 16 +++--------- docs/hero_mdbook_fullvm_script.md | 16 +++--------- scripts/hero_mdbook.sh | 41 +++++++++++++++++++++++++------ 3 files changed, 41 insertions(+), 32 deletions(-) diff --git a/docs/hero_mdbook_fullvm.md b/docs/hero_mdbook_fullvm.md index 6a333f6..afdbf59 100644 --- a/docs/hero_mdbook_fullvm.md +++ b/docs/hero_mdbook_fullvm.md @@ -23,21 +23,13 @@ For this guide, we show an example using the mdbook from the repository [info_tf We show the steps for a full VM deployed on the TFGrid with WireGuard. We use `10.20.4.2` as a WireGuard IP address. Adjust according to your own setup. -We will be using SSH to connect to the VM and to create an SSH tunnel between the local machine and the VM. This will allow the mdbook output to be displayed on a local browser. - -To manage the mdbook files, we will be using the remote explorer feature of either VSCodium or VSCode. +We will be using SSH to connect to the VM and we will access the mdbook output on a local browser. To manage the mdbook files, we will be using the remote explorer feature of either VSCodium or VSCode. ## Setting the Full VM -We start by deploying a full VM with WireGuard on the TFGrid. We also set an SSH tunnel. +We start by deploying a full VM with WireGuard on the TFGrid. -- Deploy a full VM with WireGuard on the TFGrid -- Set an SSH tunnel, on port 3333 for both local and VM - ``` - ssh -4 -L 3333:127.0.0.1:3333 root@10.20.4.2 - ``` - -Instead of working on the SSH tunnel terminal window, we will be using the remote explorer feature of a source-code editor. +To connect to the VM, we will be using a remote explorer. ### Remote Explorer Access @@ -128,7 +120,7 @@ Once you install cargo, all mdbook dependencies will be installed via the hero s - To serve on your local machine, make sure to use the same part as the one set in your SSH tunnel (here it's port 3333) ``` - mdbook serve --port 3333 + mdbook serve --hostname 0.0.0.0 --port 3333 ``` - To see the mdbook live, open a browser on the local machine and go to localhost:3333 diff --git a/docs/hero_mdbook_fullvm_script.md b/docs/hero_mdbook_fullvm_script.md index 9385877..f3aa86a 100644 --- a/docs/hero_mdbook_fullvm_script.md +++ b/docs/hero_mdbook_fullvm_script.md @@ -19,21 +19,13 @@ For this guide, we show an example using the mdbook from the repository [info_tf We show the steps for a full VM deployed on the TFGrid with WireGuard. We use `10.20.4.2` as a WireGuard IP address. Adjust according to your own setup. -We will be using SSH to connect to the VM and to create an SSH tunnel between the local machine and the VM. This will allow the mdbook output to be displayed on a local browser. - -To manage the mdbook files, we will be using the remote explorer feature of either VSCodium or VSCode. +We will be using SSH to connect to the VM and we will access the mdbook output on a local browser. To manage the mdbook files, we will be using the remote explorer feature of either VSCodium or VSCode. ## Setting the Full VM -We start by deploying a full VM with WireGuard on the TFGrid. We also set an SSH tunnel. +We start by deploying a full VM with WireGuard on the TFGrid. -- Deploy a full VM with WireGuard on the TFGrid -- Set an SSH tunnel, on port 3333 for both local and VM - ``` - ssh -4 -L 3333:127.0.0.1:3333 root@10.20.4.2 - ``` - -Instead of working on the SSH tunnel terminal window, we will be using the remote explorer feature of a source-code editor. +To connect to the VM, we will be using a remote explorer. ## Remote Explorer Access @@ -64,7 +56,7 @@ You can use the remote explorer feature of both [VSCode](https://marketplace.vis - Serve the mdbook ``` - mdbook serve --port 3333 + mdbook serve --hostname 0.0.0.0 --port 3333 ``` - Open your browser and use the following URL: ``` diff --git a/scripts/hero_mdbook.sh b/scripts/hero_mdbook.sh index 3dec9d5..d94caa1 100644 --- a/scripts/hero_mdbook.sh +++ b/scripts/hero_mdbook.sh @@ -1,38 +1,63 @@ #!/bin/bash + +# Generate opening text. +cat < /tmp/hero_install.sh bash /tmp/hero_install.sh + +# Start the SSH agent, run hero mdbook and build the mdbook eval $(ssh-agent) hero mdbook -u https://git.ourworld.tf/tfgrid/info_tfgrid/src/branch/main/heroscript cd /root/hero/var/mdbuild/duniayetu mdbook build + +# Generate closing text after successful script. cat < /dev/null; exit \ No newline at end of file -- 2.40.1