mkdocs.yml

# Project information
site_name: "LUG @ USTC"
site_description: "Documentation for LUG service maintenance"
site_author: "USTC Linux User Group"
site_url: "https://docs.ustclug.org/"

# Repository
repo_name: ustclug/documentations
repo_url: "https://github.com/ustclug/documentations"

# Copyright
copyright: 'Copyright &copy; 2003-2021 USTC Linux User Group. <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY-NC-SA 4.0</a>.'

# Configuration
theme:
  name: material
  language: en
  palette:
    - scheme: default
      media: "(prefers-color-scheme: light)"
      primary: teal
      accent: teal
      toggle:
        icon: material/lightbulb-off-outline
        name: Switch to dark mode
    - scheme: slate
      media: "(prefers-color-scheme: dark)"
      primary: green
      accent: green
      toggle:
        icon: material/lightbulb-on-outline
        name: Switch to light mode
  icon:
    logo: fontawesome/brands/linux
    repo: octicons/mark-github-16
  features:
    - content.code.annotate
    - content.code.copy
    - navigation.indexes
    - navigation.sections
    - navigation.top

# Customization
extra:
  social:
    - icon: octicons/globe-16
      link: "https://lug.ustc.edu.cn/"
    - icon: octicons/mark-github-16
      link: "https://github.com/ustclug"

extra_css:
  - https://101.ustclug.org/css/extra.css

# Extensions
markdown_extensions:
  - admonition
  - attr_list
  - footnotes
  - markdown.extensions.def_list
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.snippets:
      base_path: [docs/assets/]
  - pymdownx.superfences
  - pymdownx.tilde
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Workflow:
    - New Server Setup Checklist: "workflow/new-server.md"
    - Mirrors maintenance: "workflow/mirrors/maintenance.md"
    - New VM in Proxmox VE: "workflow/new-vm.md"
    - Add New User in LDAP: "workflow/ldap/add-new-user.md"
  - Infrastructure:
    - Intranet:
      - infrastructure/intranet/index.md
      - Tinc: "infrastructure/tinc.md"
      - LUGi VPN: "infrastructure/intranet/lugivpn.md"
      - Gateway: "infrastructure/intranet/gateway.md"
    - Proxmox Cluster:
      - Proxmox VE: "infrastructure/proxmox/pve.md"
      - Proxmox Backup Server: "infrastructure/proxmox/pbs.md"
      - NFS: "infrastructure/proxmox/nfs.md"
    - "LDAP: Servers Unified Authentication": "infrastructure/ldap.md"
    - SSH Certificate Authority: "infrastructure/sshca.md"
    - Authoritative DNS: "infrastructure/auth-dns.md"
    - SSL Certificates: "infrastructure/ssl.md"
    - Monitor: "infrastructure/monitor.md"
    - Office 365 and Mail: "infrastructure/office.md"
    - GitHub: infrastructure/github.md
    - Docker Hub: infrastructure/dockerhub.md
    - Mail Agent: infrastructure/mail.md
    - RAID: infrastructure/raid.md
    - Discontinued Infrastructure:
      - infrastructure/discontinued/index.md
      - G Suite: infrastructure/google.md
      - vSphere Cluster:
        - ESXi: "infrastructure/discontinued/vsphere/esxi.md"
        - vCenter: "infrastructure/discontinued/vsphere/vcenter.md"
        - VDP: "infrastructure/discontinued/vsphere/vdp.md"
  - Services:
    - services/index.md
    - Mirrors:
      - services/mirrors/index.md
      - Current (4):
        - services/mirrors/4/index.md
        - Volumes (Old): services/mirrors/4/volumes-old.md
        - Networking: services/mirrors/4/networking/index.md
        - Networking - Routing: services/mirrors/4/networking/route.md
        - Networking - Misc: services/mirrors/4/networking/misc.md
      - Auxiliary (3):
        - services/mirrors/3/index.md
      - Auxiliary (2):
        - services/mirrors/2/index.md
      - Obsolete (1): services/mirrors/1/index.md
      - Docker: "services/mirrors/docker.md"
      - IPMI: "services/mirrors/ipmi.md"
      - Repositories: services/mirrors/repos.md
      - ZFS: services/mirrors/zfs.md
      - XFS: services/mirrors/xfs.md
      - Services: services/mirrors/services.md
      - Monitoring: services/mirrors/monitor.md
      - Limiter: "services/mirrors/limiter.md"
      - Rsync: "services/mirrors/rsync.md"
    - Gateway EL: "services/gateway-el.md"
    - Gateway NIC: "services/gateway-nic.md"
    - Gateway JP: "services/gateway-jp.md"
    - Docker2: "services/docker2.md"
    - Neat DNS: services/neat-dns.md
    - GitLab: "services/gitlab.md"
    - LUG VPN: "services/vpn.md"
    - Light: "services/light.md"
    - PXE:
      - "services/pxe/index.md"
      - Images: "services/pxe/images.md"
      - LIIMS: "services/pxe/liims.md"
    - FTP: "services/ftp.md"
    - Documentations: services/documentations.md
    - Generate 204: "services/generate-204.md"
    - MirrorZ: services/mirrorz.md
    - Discontinued Services: "services/discontinued.md"
  - Common Issues:
    - DNS: faq/dns.md
    - LDAP: faq/ldap.md
    - Nginx: faq/nginx.md
    - systemd-timer: faq/systemd-timer.md
    - Docker: faq/docker.md
    - VM: faq/vm.md
    - SSD Firmware: faq/ssd.md
    - AppArmor: faq/apparmor.md