docs: add provisioning steps for eq12 (#1913)

Author: ferrarimarco

.github/workflows/build-mkdocs-site.yaml

@@ -14,15 +14,16 @@ on: # yamllint disable-line rule:truthy
       site-repository:
         required: true
         type: string
+      site-repository-branch:
+        required: true
+        type: string
       site-source-path:
         default: src
         required: false
         type: string
     secrets:
-      github-token:
-        required: false
-      repository-ssh-key:
-        required: false
+      repository-github-token:
+        required: true
 
 permissions:
   contents: read
@@ -33,7 +34,7 @@ jobs:
       # Ref: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
       # github.head_ref: head_ref or source branch of the pull request
       # github.ref: ref of the branch that triggered the workflow
-      group: ${{ github.workflow }}-build-push-${{ inputs.site-name }}-site-${{ github.head_ref || github.ref }}-${{ github.event_name }}
+      group: ${{ github.workflow }}-build-push-${{ inputs.site-name }}-site-${{ inputs.site-repository-branch }}-${{ github.event_name }}
       cancel-in-progress: true
     runs-on: ubuntu-latest
     steps:
@@ -44,7 +45,7 @@ jobs:
         with:
           path: "${{ inputs.site-name }}"
           repository: "${{ inputs.site-repository }}"
-          ssh-key: "${{ secrets.repository-ssh-key }}"
+          token: "${{ secrets.repository-github-token }}"
       - name: Build the ${{ inputs.site-name }} site
         run: |
           scripts/run-mkdocs.sh "build" "${{ inputs.site-name }}" "./${{ inputs.site-name }}/${{ inputs.site-source-path }}" "./${{ inputs.site-name }}/${{ inputs.site-destination-path }}"
@@ -55,7 +56,7 @@ jobs:
           github.ref_name != github.event.repository.default_branch
         uses: stefanzweifel/[email protected]
         with:
-          branch: ${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}
+          branch: ${{ inputs.site-repository-branch }}
           commit_message: "chore: update ${{ inputs.site-name }} site"
           commit_user_name: github-actions[bot]
           commit_user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/documentation.yaml

@@ -26,10 +26,26 @@ jobs:
     permissions:
       # To commit the newly built documentation site
       contents: write
-    uses: ./.github/workflows/build-mkdocs-site.yaml
-    with:
-      site-name: home-lab-docs
-      site-repository: "${{ github.repository }}"
-      site-source-path: "websites-src/home-lab-docs"
-    secrets:
-      github-token: "${{ github.token }}"
+    concurrency:
+      # Ref: https://docs.github.com/en/actions/learn-github-actions/contexts#github-context
+      # github.head_ref: head_ref or source branch of the pull request
+      # github.ref: ref of the branch that triggered the workflow
+      group: ${{ github.workflow }}-build-push-home-lab-docs-site-${{ github.event.pull_request.head.ref || github.head_ref || github.ref }}-${{ github.event_name }}
+      cancel-in-progress: true
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the current repository
+        uses: actions/checkout@v4
+      - name: Build the home-lab-docs site
+        run: |
+          scripts/run-mkdocs.sh "build" "home-lab-docs" "./websites-src/home-lab-docs" "./docs"
+      - name: Commit and push updates to the home-lab-docs site
+        if: >
+          github.event.pull_request.user.login != 'dependabot[bot]' &&
+          github.event_name == 'pull_request' &&
+          github.ref_name != github.event.repository.default_branch
+        uses: stefanzweifel/[email protected]
+        with:
+          commit_message: "chore: update home-lab-docs site"
+          commit_user_name: github-actions[bot]
+          commit_user_email: 41898282+github-actions[bot]@users.noreply.github.com

docs/installation/production/provision-new-hosts/index.html

@@ -823,6 +823,30 @@
       </ul>
     </nav>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#beelink-eq12" class="md-nav__link">
+    <span class="md-ellipsis">
+      Beelink EQ12
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Beelink EQ12">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#enable-auto-power-on-after-a-power-loss" class="md-nav__link">
+    <span class="md-ellipsis">
+      Enable auto-power on after a power loss
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
     </ul>
@@ -938,6 +962,30 @@
       </ul>
     </nav>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#beelink-eq12" class="md-nav__link">
+    <span class="md-ellipsis">
+      Beelink EQ12
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="Beelink EQ12">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#enable-auto-power-on-after-a-power-loss" class="md-nav__link">
+    <span class="md-ellipsis">
+      Enable auto-power on after a power loss
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
     </ul>
@@ -963,7 +1011,7 @@ <h1 id="provision-new-hosts">Provision new hosts</h1>
 <p>This document is about the steps that are necessary to prepare new hosts for the
 home lab. We define this process as <code>provisioning new hosts</code>.</p>
 <p>The provisioning process is as follows:</p>
-<ul>
+<ol>
 <li>Gather information about the host:</li>
 <li>Unique name to assign to the host.</li>
 <li>MAC address of each network interface.</li>
@@ -975,7 +1023,7 @@ <h1 id="provision-new-hosts">Provision new hosts</h1>
 <li>Enable <a href="https://en.wikipedia.org/wiki/Wake-on-LAN">Wake-on-LAN</a>.</li>
 <li>Enable hardware-assisted virtualization capabilities.</li>
 <li>Add the machine to the inventory.</li>
-</ul>
+</ol>
 <p>For hosts that support it, we automate the setup using an out-of-band
 configuration mechanisms, such as
 <a href="https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface">Intelligent Platform Management Interface (IPMI)</a>,
@@ -987,6 +1035,7 @@ <h1 id="provision-new-hosts">Provision new hosts</h1>
 following types of hosts:</p>
 <ul>
 <li>Raspberry Pi 4</li>
+<li>Beelink EQ12</li>
 </ul>
 <h2 id="raspberry-pi-4">Raspberry Pi 4</h2>
 <p>This section is about the manual configuration steps for Raspberry Pi 4 hosts.</p>
@@ -1021,6 +1070,19 @@ <h3 id="configure-ssh-authentication">Configure SSH authentication</h3>
 <p>By using <a href="https://www.paramiko.org/">Paramiko</a> to connect to a host using SSH,
 you can authenticate using a password without having the <code>sshpass</code> program
 installed on the host that runs Ansible.</p>
+<h2 id="beelink-eq12">Beelink EQ12</h2>
+<p>This section is about the manual configuration steps for Beelink EQ12 hosts.</p>
+<h3 id="enable-auto-power-on-after-a-power-loss">Enable auto-power on after a power loss</h3>
+<ol>
+<li>Press the Del key repeatedly after powering on the PC to enter the BIOS
+   setup.</li>
+<li>Use the arrow keys to enter the Chipset page. Select “PCH-IO Configuration”
+   and press the Enter key.</li>
+<li>Select “State After G3”.</li>
+<li>Select “S0 State”. “S0 State” is to enable auto power on and “S5 State” is to
+   disable auto power on.</li>
+<li>Press the F4 and select “Yes” to save the configuration.</li>
+</ol>
 
 
 

docs/search/search_index.json

@@ -2,70 +2,70 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://ferrarimarco.info/home-lab/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/architecture/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/architecture/network-configuration/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/architecture/references/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/architecture/storage-configuration/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/guides/capture-proxmox-vm-network-traffic/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/guides/configure-monitoring/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/guides/configure-network-shares/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/guides/configure-tailscale/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/guides/container-migration/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/guides/copy-jinja-templates/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/guides/linux-disk-setup/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/guides/useful-linux-admin-commands/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/guides/useful-proxmox-commands/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/installation/production/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/installation/production/provision-new-hosts/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
     <url>
          <loc>https://ferrarimarco.info/home-lab/installation/production/setup-proxmox/</loc>
-         <lastmod>2025-06-18</lastmod>
+         <lastmod>2025-08-09</lastmod>
     </url>
 </urlset>

docs/sitemap.xml

@@ -97,12 +97,17 @@ echo "Run container command: ${RUN_CONTAINER_COMMAND[*]}"
 # Check if changed files only include files that we can ignore, such as
 # when only updating the sitemap
 declare -i RET_CODE
+# Disable errexit because we want to get the return code
+set +o errexit
 check_if_uncommitted_files_only_include_mkdocs_files_to_ignore "${MKDOCS_DESTINATION_DIRECTORY_PATH}"
 RET_CODE=$?
-if [[ "${RET_CODE}" -gt 1 ]]; then
-  echo "Error while checking changed files"
-  exit 1
+set -o errexit
+if [[ "${RET_CODE}" -eq 1 ]]; then
+  echo "Documentation commit doesn't contain only files to ignore"
 elif [[ "${RET_CODE}" -eq 0 ]]; then
   echo "Documentation commit only contains files to ignore. Checking them out from the Git repository to avoid unnecessary site publishing"
   git -C "${MKDOCS_DESTINATION_DIRECTORY_PATH}" checkout .
+else
+  echo "Error while checking changed files"
+  exit 1
 fi

docs/sitemap.xml.gz

@@ -5,17 +5,17 @@ home lab. We define this process as `provisioning new hosts`.
 
 The provisioning process is as follows:
 
-- Gather information about the host:
-  - Unique name to assign to the host.
-  - MAC address of each network interface.
-  - Name of each network interface.
-  - Static IP address to assign to each network interface.
-  - Boot disk name.
-- Update the BIOS and UEFI firmware to the latest available version.
-- Enable network boot.
-- Enable [Wake-on-LAN](https://en.wikipedia.org/wiki/Wake-on-LAN).
-- Enable hardware-assisted virtualization capabilities.
-- Add the machine to the inventory.
+1. Gather information about the host:
+   1. Unique name to assign to the host.
+   1. MAC address of each network interface.
+   1. Name of each network interface.
+   1. Static IP address to assign to each network interface.
+   1. Boot disk name.
+1. Update the BIOS and UEFI firmware to the latest available version.
+1. Enable network boot.
+1. Enable [Wake-on-LAN](https://en.wikipedia.org/wiki/Wake-on-LAN).
+1. Enable hardware-assisted virtualization capabilities.
+1. Add the machine to the inventory.
 
 For hosts that support it, we automate the setup using an out-of-band
 configuration mechanisms, such as
@@ -29,6 +29,7 @@ In this document, we provide information about the manual steps to provision the
 following types of hosts:
 
 - Raspberry Pi 4
+- Beelink EQ12
 
 ## Raspberry Pi 4
 
@@ -71,3 +72,18 @@ running.
 By using [Paramiko](https://www.paramiko.org/) to connect to a host using SSH,
 you can authenticate using a password without having the `sshpass` program
 installed on the host that runs Ansible.
+
+## Beelink EQ12
+
+This section is about the manual configuration steps for Beelink EQ12 hosts.
+
+### Enable auto-power on after a power loss
+
+1. Press the Del key repeatedly after powering on the PC to enter the BIOS
+   setup.
+1. Use the arrow keys to enter the Chipset page. Select “PCH-IO Configuration”
+   and press the Enter key.
+1. Select “State After G3”.
+1. Select “S0 State”. “S0 State” is to enable auto power on and “S5 State” is to
+   disable auto power on.
+1. Press the F4 and select “Yes” to save the configuration.