BunkerM/mkdocs.yml at main · bunkeriot/BunkerM · 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
site_name: BunkerM - MQTT Made Easy!
site_url: https://bunkeriot.github.io/BunkerM/

theme:
  name: material
  custom_dir: theme
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
      primary: "#011D8F"
      accent: purple
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
      primary: "#011D8F"
      accent: lime
  icon:
    logo: material/library
  generator: false

plugins:
  - search

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - First Login: getting-started/first-login.md
    - Persistent Storage: getting-started/persistent-storage.md
  - User Guide:
    - Dashboard: ui/dashboard.md
    - Connected Clients: user-guide/connected-clients.md
    - ACL Management:
      - Clients: user-guide/acl-clients.md
      - Roles: user-guide/acl-roles.md
      - Groups: user-guide/acl-groups.md
    - MQTT Browser: user-guide/mqtt-browser.md
    - Tools:
      - Agents: user-guide/agents.md
      - Anomalies: user-guide/anomalies.md
    - Logs:
      - Broker Logs: user-guide/broker-logs.md
      - Client Logs: user-guide/client-logs.md
    - Settings:
      - Broker: user-guide/settings-broker.md
      - Integrations: user-guide/settings-integrations.md
      - Annotations: user-guide/settings-annotations.md
      - Subscription: user-guide/settings-subscription.md
    - Admin:
      - Users: user-guide/admin-users.md
  - Integrations:
    - Home Assistant: integrations/home-assistant.md
    - Web Chat: integrations/web-chat.md
    - Slack: integrations/slack.md
    - Telegram: integrations/telegram.md
    - Shared AI Memory: integrations/shared-memory.md
  - Advanced:
    - Dynamic Security: advanced/dynamic-security.md
    - Password Management: advanced/password-management.md
  - FAQ: faq.md
  - Troubleshooting: troubleshooting.md

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/bunkeriot/BunkerM
    - icon: fontawesome/brands/reddit
      link: https://www.reddit.com/r/BunkerM/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/mehdi-idrissi/

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

copyright: |
  &copy; 2025 <a href="https://github.com/bunkeriot" target="_blank" rel="noopener">BunkerM</a>