config.yml

site_name: "de.NBI Cloud Wiki"
docs_dir: /srv_root/docs/wiki
site_dir: /var/www/html/wiki
theme:
  name: material
  font: false
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: 'light blue'
      accent: 'light blue'
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: 'light blue'
      accent: 'light blue'
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  custom_dir: wiki/overrides

  logo: 'img/denbi.svg'
  favicon: 'img/denbi.svg'
  features:
    - navigation.top
    - navigation.indexes
repo_name: 'deNBI/cloud-user-docs'
repo_url: 'https://github.com/deNBI/cloud-user-docs'
edit_uri: blob/master/wiki/
use_directory_urls: true
site_url: !ENV [ SITE_URL, 'https://cloud.denbi.de/wiki/' ]

plugins:
  - search
  - glightbox
  - macros
  - git-revision-date-localized:
      fallback_to_build_date: true
  - htmlproofer:
      enabled: !ENV [ ENABLED_HTMLPROOFER,False ]
      raise_error_after_finish: True
      retry_max_times: 3
      raise_error_excludes:
        -1: [ "https://cloud.denbi.de/portal/webapp/#/userinfo", "http://169.254.169.254", "https://signup.aai.lifescience-ri.eu/fed/registrar/?vo=lifescience", "https://login.elixir-czech.org/oidc/", "https://spreg-legacy.aai.elixir-czech.org/spreg/auth/facilities/myServices","http://BIBIGRID_MASTER/ganglia", "https://bastion-prod(dot)denbi(dot)cloud(dot)embl(dot)de" ]
        400: [ "http://169.254.169.254" ]
        403: [ "https://s3.denbi.uni-tuebingen.de","https://www.netapp.com/trident/","https://cloud-init.io", "https://linux.die.net/man/5/nfs", "https://geant.org/Services/", "https://www.netapp.com/trident/ " ]
        404: ["https://cloud.denbi.de/about/credits-calculator/"]
        429: [ "https://docs.ansible.com" ]
        500: [ "https://cloud.denbi.de/register", "https://signup.aai.lifescience-ri.eu/fed/registrar/?vo=elixir_test" ]
        503: [ "https://s3.denbi.uni-tuebingen.de" ]
        504: [ "https://denbi.cloud.embl.de", "https://cloud.denbi.de/about/credits-calculator/", "https://packages.ubuntu.com/","https://denbi-cloud.bihealth.org","http://apt-cache.bi.denbi.de:9999","http://129.70.51.2:9999","https://cloud.denbi.dkfz-heidelberg.de","https://denbi-cloud.bioquant.uni-heidelberg.de","https://denbi-cloud.bioquant.uni-heidelberg.de", "https://docs.kubermatic.com" ]
      ignore_urls:
        - "https://services.aai.lifescience-ri.eu/spreg/auth/facilities/myServices"
        - "https://spreg-legacy.aai.elixir-czech.org/spreg/auth/requests/new"
        # Ignore everything in the MathJax assets folder (includes CONTRIBUTING.md)
        - ".*assets/mathjax/.*"
        - ".*wiki/assets/mathjax/.*"
        # URLs blocked by bot protection (e.g. Cloudflare challenge)
        - "https://stackoverflow.com/questions/41137494/ha-proxy-rule-404-not-found"
        # Ansible docs frequently return 429 (Too Many Requests)
        - "https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html"
        - "https://docs.ansible.com/ansible/2.9/modules/modules_by_category.html"
        - "https://docs.ansible.com/ansible/latest/user_guide/playbooks.html"
        - "https://docs.ansible.com/ansible/latest/getting_started/index.html"
      ignore_pages:
       - assets/mathjax/CONTRIBUTING.md

markdown_extensions:
  - abbr
  - attr_list
  - admonition
  - codehilite
  - def_list
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: True
      auto_append:
        - /srv_root/docs/wiki/includes/glossary.md
  - pymdownx.superfences
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.arithmatex:
      generic: true

extra_javascript:
  - !ENV [ MATOMO_SCRIPT_FILE, matomo.js]
  - mathjax.js
  - assets/mathjax/tex-mml-chtml-mathjax-stix2.js


extra_css:
  - assets/css/fonts.css

extra:
  consent:
    title: Cookie consent
    description: >-
      We use analytics cookies (Matomo) to understand how visitors use the wiki
      so we can improve it. With your consent, you help us make the documentation
      better. You can withdraw consent at any time.
    actions:
      - accept
      - reject
      - manage
    cookies:
      analytics:
        name: Matomo
        checked: true
  social:
  - icon: fontawesome/brands/linkedin
    link: https://www.linkedin.com/company/de-nbi/
    name: de.NBI on LinkedIN
  - icon: fontawesome/brands/github
    link: https://github.com/deNBI/
    name: de.NBI on GitHub
  - icon: fontawesome/brands/youtube
    link: https://www.youtube.com/channel/UCgZ5PU3CyD4c8yxxzJi130g?view_as=subscriber
    name: de.NBI on YouTube
  - icon: fontawesome/brands/wikipedia-w
    link: https://en.wikipedia.org/wiki/German_Network_for_Bioinformatics_Infrastructure
    name: de.NBI on Wikipedia
  footer_links: 
    - { name: "Policies", href: "https://cloud.denbi.de/about/policies/" }
    - { name: "Imprint", href: "https://cloud.denbi.de/about/imprint/" }
    - { name: "Cookie Consent", href: "#__consent", new_tab: false }
    
  simplevm_wiki_link: !ENV [ SIMPLE_VM_WIKI_LINK, 'https://simplevm.denbi.de/wiki/' ]

nav:
  - 'Home': index.md
  - 'Registration': registration.md
  - 'Citation and publication': citation_and_publication.md
  - 'Portal':
      - 'Allocation': portal/allocation.md
      - 'Resource/Lifetime Modifications': portal/modification.md
      - 'Project Termination': portal/termination.md
      - 'Project Overview': portal/project_overview.md
      - 'Profile Page': portal/user_information.md
      - 'Using Vault': portal/vault_user.md
      - 'Cloud Credits': portal/credits.md
      - 'Personal Data': portal/personal_data.md
  - 'Simple VM':
      - simple_vm/index.md
  - 'OpenStack Quickstart': quickstart.md
  - 'Security': security.md
  - 'Concept':
      - 'OpenStack Basics': Concept/basics.md
      - 'OpenStack Components': Concept/openstack.md
      - 'Flavors': Concept/flavors.md
      - 'Images': Concept/images.md
      - 'Image Builder': Concept/image_builder.md
      - 'Network': Concept/network.md
      - 'Object Storage Giessen': Concept/object_storage_giessen.md
      - 'Volumes': Concept/volumes.md
  - 'Tutorials':
      - 'Tutorials': Tutorials/index.md
      - 'Access de.NBI Virtual Machines from Windows 10': Tutorials/Win10_SSH/index.md
      - 'Access project infrastructure with sshuttle': Tutorials/Sshuttle/index.md
      - 'Ansible Automation': Tutorials/Ansible/index.md
      - 'Bibigrid': Tutorials/BiBiGrid/index.md
      - 'Blast on BiBiGrid': Tutorials/BlastOnBiBiGrid/index.md
      - 'Hybridcloud': Tutorials/Hybridcloud/index.md
      - 'Install latest CUDA version': Tutorials/CUDA/index.md
      - 'JupyterHub': Tutorials/JupyterHub/index.md
      - 'Kubermatic': Tutorials/Kubermatic/index.md
      - 'Loadbalancer': Tutorials/Loadbalancer/index.md
      - 'Object Storage': Tutorials/ObjectStorage/index.md
      - 'Public Web Server': Tutorials/PublicWebServer/index.md
      - 'Reverse Proxy with Elixir AAI': Tutorials/Elixir_AAI/Elixir_AAI.md
      - 'Save FloatingIPs': Tutorials/SaveFloatingIPs/index.md
      - 'Set up RStudio': Tutorials/RStudio_Server/index.md
      - 'Persistent SSH Sessions': Tutorials/Persistent_SSH_Sessions/index.md
      - 'Theia Web IDE': Tutorials/TheiaIde/index.md
      - 'UserData': Tutorials/UserData/index.md
  - 'FAQ': 'FAQ.md'
  - 'Compute Center Specific':
      - 'Berlin': Compute_Center/Berlin.md
      - 'Bielefeld': Compute_Center/Bielefeld.md
      - 'EMBL': Compute_Center/EMBL.md
      - 'Freiburg': Compute_Center/Freiburg.md
      - 'Giessen': Compute_Center/Giessen.md
      - 'Heidelberg Uni': Compute_Center/Heidelberg.md
      - 'Heidelberg DKFZ': Compute_Center/Heidelberg-DKFZ.md
      - 'Tuebingen': Compute_Center/Tuebingen.md
  - 'Cloud Admin':
      - 'Project management': cloud_admin/project_management.md
      - 'Configure OpenStack to use Elixir AAI via OpenID Connect': cloud_admin/elixir_OIDC.md
      - 'Register your identity provider for ELIXIR': cloud_admin/identity_provider.md
      - 'News management': cloud_admin/news_management.md
      - 'Vault management': cloud_admin/vault_admin.md