geek-cookbook/mkdocs.yml

site_name: Funky Penguin's Geek Cookbook
site_description: 'The "Geek Cookbook" is a collection of guides for establishing your own highly-available docker container cluster (swarm). This swarm enables you to run self-hosted services such as GitLab, Plex, NextCloud, etc.'
site_author: 'David Young'
site_url: 'https://geek-cookbook.funkypenguin.co.nz'
edit_uri: 'edit/master/manuscript/'

# Fail to build if we have broken links
strict: true

# Repository
repo_name: 'funkypenguin/geek-cookbook'
repo_url: 'https://github.com/funkypenguin/geek-cookbook'

# Set this to "manuscript" so that we can produce leanpub content
docs_dir: 'manuscript'

# Copyright
copyright: 'Copyright © 2016 - 2017 David Young'


#theme_dir: mkdocs-material
pages:
    - Home : index.md
    - Introduction:
      - README: README.md
      - CHANGELOG: CHANGELOG.md
      - whoami: whoami.md
    - Essential:
      - Design: ha-docker-swarm/design.md
      - VMs: ha-docker-swarm/vms.md
      - Shared Storage (Ceph): ha-docker-swarm/shared-storage-ceph.md
      - Shared Storage (GlusterFS): ha-docker-swarm/shared-storage-gluster.md
      - Keepalived: ha-docker-swarm/keepalived.md
      - Docker Swarm Mode: ha-docker-swarm/docker-swarm-mode.md
      - Traefik: ha-docker-swarm/traefik.md
      - Registry: ha-docker-swarm/registry.md
      - Mail Server: recipies/mail.md
      - Duplicity: recipies/duplicity.md
    - Chef's Favorites:
      - Huginn: recipies/huginn.md
      - Kanboard: recipies/kanboard.md
      - Miniflux: recipies/miniflux.md
      - Auto Pirate:
        - Start: recipies/autopirate.md
        - SABnzbd: recipies/autopirate/sabnzbd.md
        - NZBGet: recipies/autopirate/nzbget.md
        - Rtorrent: recipies/autopirate/rtorrent.md
        - Sonarr: recipies/autopirate/sonarr.md
        - Radarr: recipies/autopirate/radarr.md
        - Mylar: recipies/autopirate/mylar.md
        - Lazy Librarian: recipies/autopirate/lazylibrarian.md
        - Headphones: recipies/autopirate/headphones.md
        - Lidarr: recipies/autopirate/lidarr.md
        - NZBHydra: recipies/autopirate/nzbhydra.md
        - NZBHydra 2: recipies/autopirate/nzbhydra2.md
        - Ombi: recipies/autopirate/ombi.md
        - Jackett: recipies/autopirate/jackett.md
        - Heimdall: recipies/autopirate/heimdall.md
        - End: recipies/autopirate/end.md
      - NextCloud: recipies/nextcloud.md
      - Plex: recipies/plex.md
      - Emby: recipies/emby.md
      - Munin: recipies/munin.md
      - Home Assistant: recipies/homeassistant.md
      - OwnTracks: recipies/owntracks.md
      - PrivateBin: recipies/privatebin.md
      - Swarmprom: recipies/swarmprom.md
      - Turtle Pool: recipies/turtle-pool.md
    - Menu:
      - Bookstack: recipies/bookstack.md
      - CryptoMiner:
        - Start: recipies/cryptominer.md
        - Mining Rig: recipies/cryptominer/mining-rig.md
        - AMD GPU: recipies/cryptominer/amd-gpu.md
        - NVidia GPU: recipies/cryptominer/nvidia-gpu.md
        - Mining Pools : recipies/cryptominer/mining-pool.md
        - Wallets : recipies/cryptominer/wallet.md
        - Exchanges: recipies/cryptominer/exchange.md
        - Minerhotel: recipies/cryptominer/minerhotel.md
        - Monitoring: recipies/cryptominer/monitor.md
        - Profit!: recipies/cryptominer/profit.md
      - Calibre-Web: recipies/calibre-web.md
      - Ghost: recipies/ghost.md
      - GitLab: recipies/gitlab.md
      - GitLab Runner: recipies/gitlab-runner.md
      - Gollum: recipies/gollum.md
      - InstaPy: recipies/instapy.md
      - Piwik: recipies/piwik.md
      - Portainer: recipies/portainer.md
      - Realms: recipies/realms.md
      - Tiny Tiny RSS: recipies/tiny-tiny-rss.md
      - Wallabag: recipies/wallabag.md
      - Wekan: recipies/wekan.md
      - Wetty: recipies/wetty.md
#      - CryptoNote Mining Pool:
#        - Start: recipies/cryptonote-mining-pool.md
#        - Masari: recipies/cryptonote-mining-pool/masari.md
#        - Athena: recipies/cryptonote-mining-pool/athena.md
#      - SSO Stack:
#        - Start: recipies/sso-stack.md
#        - OpenLDAP: recipies/sso-stack/openldap.md
#        - KeyCloak: recipies/sso-stack/keycloak.md
    - Reference:
      - OAuth Proxy: reference/oauth_proxy.md
      - Data Layout: reference/data_layout.md
      - Networks: reference/networks.md
      - Containers: reference/containers.md
      - git-docker : reference/git-docker.md
      - OpenVPN : reference/openvpn.md
      - Troubleshooting: reference/troubleshooting.md
    - Support: support.md
    - Sponsored Projects: sponsored-projects.md

theme:
  name: 'material'
  custom_dir: 'overrides'
  disqus: 'geeks-cookbook'
  logo: 'images/site-logo.png'
  favicon: 'images/favicon.ico'
  feature:
    tabs: false
  palette:
    primary: 'brown'
    accent: 'indigo'
  font:
    text: 'Roboto'
    code: 'Roboto Mono'
  social:
    - type: 'github'
      link: 'https://github.com/funkypenguin'
    - type: 'twitter'
      link: 'https://twitter.com/funkypenguin'
    - type: 'stack-overflow'
      link: 'https://stackoverflow.com/cv/funkypenguin'
    - type: 'rss'
      link: 'https://www.funkypenguin.co.nz/blog/'
    - type: 'envelope'
      link: 'mailto:davidy@funkypenguin.co.nz?Subject=Hello%2C%20from%20a%20geek-cookbook%20reader%20%3B%29'
    - type: 'book'
      link: 'https://leanpub.com/geeks-cookbook'

# Google Analytics
google_analytics:
  - 'UA-139253-18'
  - 'auto'

extra_javascript:
  - 'extras/javascript/piwik.js'

# Extensions
markdown_extensions:
  - admonition
  - codehilite(linenums=true)
  - toc(permalink=true)
  - footnotes
  - pymdownx.arithmatex
  - pymdownx.betterem(smart_enable=all)
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tasklist(custom_checkbox=true)
  - pymdownx.tilde
  - meta