docs.slicervm.com/mkdocs.yml at master · slicervm/docs.slicervm.com · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
site_name: Slicer
site_description: Slice bare-metal into sandboxes and services
site_author: OpenFaaS Ltd
site_url: https://docs.slicervm.com/

# Repository
repo_name: slicervm/docs.slicervm.com
repo_url: https://github.com/slicervm/docs.slicervm.com
edit_uri: ""

copyright: |
  Copyright &copy; 2025 OpenFaaS Ltd
theme:
  name: material
  # custom_dir: docs/theme
  logo: images/logo.png

  palette:
    - scheme: default
      primary: black
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

  font:
    text: Roboto, Helvetica
    code: Roboto Mono
  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top

  include_search_page: false
  search_index_only: true

  language: en

  favicon: images/favicon.ico

extra_css:
  - stylesheets/extra.css

extra:
  search:
    languages: "en"
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/self-actuated/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/selfactuated

plugins:
  - search

markdown_extensions:
  - attr_list
  - tables
  - md_in_html
  - markdown.extensions.admonition
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown.extensions.def_list
  - markdown.extensions.footnotes
  - markdown.extensions.meta
  - markdown.extensions.toc:
      permalink: true
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      # emoji_generator: !!python/name:pymdownx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Slicer for Linux:
      - Introduction: index.md
      - Contact us: contact.md
      - Getting Started:
          - Installation: getting-started/install.md
          - Walkthrough: getting-started/walkthrough.md
          - Running in the background: getting-started/daemon.md
      - Examples:
          - Run a one-shot task via API: examples/run-a-task.md
          - Kubernetes:
              - HA Kubernetes: examples/ha-k3s.md
              - Autoscaling Kubernetes: examples/autoscaling-k3s.md
              - Large scale Kubernetes: examples/large-scale-k3s.md
              - Multiple machine Kubernetes: examples/multiple-machine-k3s.md
              - K3s with a GPU: examples/k3s-gpu.md
              - OpenFaaS on K3s: examples/openfaas.md
          - AI/LLMs:
              - Ollama with a GPU: examples/gpu-ollama.md
              - Headless OpenCode Coding Agent: examples/opencode-agent.md
              - Headless Cursor Coding Agent: examples/cursor-cli-agent.md
          - Productivity:
              - Remote Docker builds over SSH: examples/buildkit.md
              - Remote VSCode: examples/remote-vscode.md
              - PiHole Adblocker: examples/pihole-adblock.md
          - Run Jenkins for CI/CD: examples/jenkins.md
          - Create a Linux Router/Firewall: examples/router-firewall.md
          - Run containers with Docker: examples/docker.md
          - OpenFaaS Edge (All-In-One): examples/openfaas-edge.md
      - Tasks:
          - Customise with userdata: tasks/userdata.md
          - Copy files to/from a VM: tasks/copy-files.md
          - Execute commands in a VM: tasks/execute-commands.md
          - Expose ports from a VM: tasks/expose-ports.md
          - Build a custom root filesystem: tasks/custom-image.md
          - Logs & Monitoring: tasks/monitoring.md
          - Share files over NFS: tasks/share-files-with-nfs.md
          - Nested Virtualization: tasks/nested-virtualization.md
          - Run slicer without KVM on cloud VMs: tasks/pvm.md
          - Execute commands in VMs with the SDK: tasks/execute-commands-with-sdk.md
      - Storage:
          - Overview: storage/overview.md
          - ZFS: storage/zfs.md
          - Devmapper: storage/devmapper.md
      - Reference:
          - Slicer REST API: reference/api.md
          - Images for microVMs: reference/images.md
          - SSH access to VMs: reference/ssh.md
          - Secret management: reference/secrets.md
          - Serial Over SSH (SOS): reference/sos.md
          - Networking: reference/networking.md
          - VFIO Passthrough: reference/vfio.md
          - Troubleshooting: reference/troubleshooting.md
  - Slicer for Mac:
      - Overview: mac/overview.md
      - Installation: mac/installation.md
      - Linux VM: mac/linux-vm.md
      - Sandboxes: mac/sandboxes.md
      - Configuration:
          - Enable Rosetta: mac/rosetta.md
          - Storage: mac/storage.md
          - Folder sharing: mac/folder-sharing.md
          - Docker: mac/docker.md
          - Sleep behavior: mac/sleep.md
          - Tray integration: mac/tray-integration.md
      - Examples:
          - Coding agents: mac/coding-agents.md
# extra:
#   analytics:
#     provider: google
#     property: G-PTK21TFJ7V
#     anonymize_ip: true