mkdocs.yml

site_name: Turris Documentation
site_description: Official Turris documentation for both hardware and software
site_author: CZ.NIC z.s.p.o.
copyright: CC-BY-SA-4.0


theme:
    name: null
    custom_dir: 'material-turris/material/'
    logo: '/theme/turris-logo.svg'
    favicon: '/theme/favicon.ico'
    font: false
    language: 'en'
    palette:
        primary: "turris"
        accent: "turris"
    feature:
        tabs: false
    static_templates:
      - 404.html


markdown_extensions:
    - markdown_include.include:
        base_path: docs
    - admonition
    - cell_row_span
    - extra
    - pymdownx.details
    - pymdownx.superfences
    - codehilite
    - markdown_jinja:
        fs_loader_dir: 'docs'
    - smarty
    - toc
    - wikilinks
    - admonition
    - pyembed.markdown

plugins:
    - search:
        lang: ['en']
        prebuild_index: False
    - git-revision-date:
        modify_md: False


extra:
  social:
    - type: 'globe'
      link: 'https://turris.cz'
    - type: 'gitlab'
      link: 'https://gitlab.labs.nic.cz/turris'
    - type: 'github'
      link: 'https://github.com/CZ-NIC'
    - type: 'twitter'
      link: 'https://twitter.com/turris_cz'

nav:
- Introduction: 'index.md'
- First setup:
    - 'MOX': 'basics/first-setup/mox_first_setup.md'
    - 'Turris 1.X and Omnia': 'basics/first-setup/simple_setup.md'
- Software:
    - Data Collection: 'basics/collect.md'
    - Foris:
        - 'Secure access': 'basics/foris/https/https.md'
        - LAN: 'basics/foris/lan/foris-lan.md'
        - WAN: 'basics/foris/wan/foris_wan.md'
        - DNS: 'basics/foris/dns/foris-dns.md'
        - 'Guest network': 'basics/foris/guest-network/guest-network.md'
        - 'Storage': 'basics/foris/storage-plugin/storage-plugin.md'
    - LuCI:
        - Introduction: basics/luci/luci.md
        - Static IP: basics/luci/static_dhcp/static_dhcp.md
    - Applications:
        - 'Netmetr': 'basics/apps/netmetr.md'
        - 'Nextcloud': 'geek/nextcloud/nextcloud.md'
        - 'OpenVPN': 'basics/apps/openvpn/openvpn.md'
        - 'PaKon': 'basics/apps/pakon.md'
        - 'Sentinel': 'basics/apps/sentinel.md'
    - Advanced:
        - 'LXC': 'geek/lxc/lxc.md'
        - 'Netboot': 'basics/apps/netboot.md'
        - 'Schnapps': 'geek/schnapps/schnapps.md'
    - 'OS versions':
        - Versions: 'basics/tos_versions.md'
        - Changelog: 'basics/changelog.md'
        - 'Early access': 'geek/testing.md'
- Hardware:
    - Models: 'basics/models.md'
    - MOX:
        - About: 'hw/mox/intro.md'
        - Sets:
            - 'Start': 'hw/mox/sets/start.md'
            - 'Pocket Wi-Fi': 'hw/mox/sets/pocketwifi.md'
            - 'Power Wi-Fi': 'hw/mox/sets/powerwifi.md'
            - 'Classic': 'hw/mox/sets/classic.md'
        - Modules:
            - 'MOX A (Basic)': 'hw/mox/modules/a.md'
            - 'MOX B (Extension)': 'hw/mox/modules/b.md'
            - 'MOX C (Ethernet)': 'hw/mox/modules/c.md'
            - 'MOX D (SFP)': 'hw/mox/modules/d.md'
            - 'MOX E (Super Ethernet)': 'hw/mox/modules/e.md'
            - 'MOX F (USB)': 'hw/mox/modules/f.md'
            - 'MOX G (Super Extension)': 'hw/mox/modules/g.md'
        - Add-ons: 'hw/mox/addons.md'
        - Hardware details: 'hw/mox/hw.md'
    - Omnia:
        - About: 'hw/omnia/omnia.md'
        - Revisions: 'hw/omnia/revisions.md'
    - Turris 1.X: 'hw/turris-1x/turris-1x.md'
- Troubleshooting:
    - Basics: 'basics/common_errors.md'
    - Rescue modes:
        - 'MOX': 'hw/mox/rescue_modes.md'
        - 'Omnia': 'hw/omnia/rescue_modes.md'
    - 'Serial connection': 'hw/serial.md'
    - 'Serial boot':
        - 'Omnia': 'hw/omnia/serial-boot.md'
    - Support: 'basics/support.md'