diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ddf1d0810..39c1331b9 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -49,7 +49,7 @@ nav: - Guides: - Getting Started: - Creating Your First Clan: guides/getting-started/index.md - - Create Installer: guides/getting-started/installer.md + - Create Installer (optional): guides/getting-started/installer.md - Add Machines: guides/getting-started/add-machines.md - Secrets & Facts: guides/getting-started/secrets.md - Deploy Machine: guides/getting-started/deploy.md diff --git a/docs/site/guides/getting-started/installer.md b/docs/site/guides/getting-started/installer.md index e897332c5..a94881d45 100644 --- a/docs/site/guides/getting-started/installer.md +++ b/docs/site/guides/getting-started/installer.md @@ -1,4 +1,4 @@ -# Clan Installer Image for Physical Machines +# Clan Installer Image for Physical Machines (optional) To install Clan on physical machines, you need to use our custom installer image. This is necessary for proper installation and operation. @@ -44,11 +44,16 @@ To install Clan on physical machines, you need to use our custom installer image ```shellSession sudo umount /dev/sdb1 ``` -=== "**Linux OS**" - ### Step 2. Create a Custom Installer - Using clan flash enables the inclusion of ssh public keys into the image. - It also allows to set language and keymap in the installer image. +### Step 2. Installer + +=== "**Linux OS**" + **Create a Custom Installer** + + We recommend to build your own installer because of the following reasons: + + - Include your ssh public keys into the image that allows passwordless ssh connection later on. + - Set your preferred language and keymap ```bash clan flash write --flake git+https://git.clan.lol/clan/clan-core \ @@ -95,11 +100,8 @@ sudo umount /dev/sdb1 clan flash list languages ``` - - - === "**Other OS**" - ### Step 2. Download Generic Installer + **Download Generic Installer** For x86_64: