commit 62cd10bb99e8050bed1e6d3f810a70a43c63e3ce Author: Sthope Date: Sun Apr 17 15:55:46 2022 +0200 Initial commit diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000..5c3fd74 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,20 @@ +--- +kind: pipeline +type: docker +name: build +steps: +- name: build + image: squidfunk/mkdocs-material:7.1.9 + volumes: + - name: site + path: /site + commands: + - /usr/local/bin/python -m pip install --upgrade pip + - pip install -U -r ./requirements.txt + - mkdocs build + - cp -r site/ /site + - chmod -R 777 /site +volumes: +- name: site + host: + path: /home/sthope/docker/mkdocswiki \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2544858 --- /dev/null +++ b/.gitignore @@ -0,0 +1,85 @@ +# ignore rendered site +site/ + +# Created by https://www.toptal.com/developers/gitignore/api/vscode,macos,windows,linux +# Edit at https://www.toptal.com/developers/gitignore?templates=vscode,macos,windows,linux + +### Linux ### +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### vscode ### +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + +### Windows ### +# Windows thumbnail cache files +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# End of https://www.toptal.com/developers/gitignore/api/vscode,macos,windows,linux \ No newline at end of file diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..0684738 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,4 @@ +FROM squidfunk/mkdocs-material:latest + +COPY requirements.txt /docs/requirements.txt +RUN pip install -U -r /docs/requirements.txt \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2b3d870 --- /dev/null +++ b/LICENSE @@ -0,0 +1,16 @@ +MIT License Copyright (c) 2022 Sthope +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: +The above copyright notice and this permission notice (including the next +paragraph) shall be included in all copies or substantial portions of the +Software. +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/docker-compose.yaml b/docker-compose.yaml new file mode 100644 index 0000000..34de793 --- /dev/null +++ b/docker-compose.yaml @@ -0,0 +1,10 @@ +version: "3.8" + +services: + wiki: + build: . + image: sthope/wiki + volumes: + - .:/docs + ports: + - 8000:8000 diff --git a/docs/images/assets/favicon.ico b/docs/images/assets/favicon.ico new file mode 100644 index 0000000..93c53c4 Binary files /dev/null and b/docs/images/assets/favicon.ico differ diff --git a/docs/images/assets/favicon.png b/docs/images/assets/favicon.png new file mode 100644 index 0000000..a246010 Binary files /dev/null and b/docs/images/assets/favicon.png differ diff --git a/docs/images/logos/docker-logo-horizontal.png b/docs/images/logos/docker-logo-horizontal.png new file mode 100644 index 0000000..6eecb6b Binary files /dev/null and b/docs/images/logos/docker-logo-horizontal.png differ diff --git a/docs/images/logos/gitea.png b/docs/images/logos/gitea.png new file mode 100644 index 0000000..e6d1b74 Binary files /dev/null and b/docs/images/logos/gitea.png differ diff --git a/docs/images/logos/ha-logo.png b/docs/images/logos/ha-logo.png new file mode 100644 index 0000000..2b282dc Binary files /dev/null and b/docs/images/logos/ha-logo.png differ diff --git a/docs/images/logos/linux.jpg b/docs/images/logos/linux.jpg new file mode 100644 index 0000000..0a551bc Binary files /dev/null and b/docs/images/logos/linux.jpg differ diff --git a/docs/images/logos/proxmox.svg b/docs/images/logos/proxmox.svg new file mode 100644 index 0000000..bc5d22a --- /dev/null +++ b/docs/images/logos/proxmox.svg @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/proxmox/website.png b/docs/images/proxmox/website.png new file mode 100644 index 0000000..e131737 Binary files /dev/null and b/docs/images/proxmox/website.png differ diff --git a/docs/images/sthope_wiki.png b/docs/images/sthope_wiki.png new file mode 100644 index 0000000..f3248ff Binary files /dev/null and b/docs/images/sthope_wiki.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..c94d17d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,4 @@ + + + +![logo](/../images/sthope_wiki.png){: align=center width=500 } \ No newline at end of file diff --git a/docs/portainer-stacks/authelia.md b/docs/portainer-stacks/authelia.md new file mode 100644 index 0000000..17371ca --- /dev/null +++ b/docs/portainer-stacks/authelia.md @@ -0,0 +1,17 @@ +Portainer Stack: +``` +--- +version: "3.8" +services: + authelia: + image: authelia/authelia:latest + container_name: authelia + network_mode: bridge + environment: + - TZ=Europe/Amsterdam + volumes: + - /docker/nginx/authelia:/config + restart: unless-stopped + labels: + - com.centurylinklabs.watchtower.enable=true +``` \ No newline at end of file diff --git a/docs/portainer-stacks/bazarr.md b/docs/portainer-stacks/bazarr.md new file mode 100644 index 0000000..7bf2094 --- /dev/null +++ b/docs/portainer-stacks/bazarr.md @@ -0,0 +1,24 @@ +Portainer Stack: +``` +version: "3.8" +services: + bazarr: + image: linuxserver/bazarr:latest + container_name: bazarr + network_mode: bridge + environment: + - PUID=1000 + - PGID=1000 + - UMASK_SET=022 + - TZ=Europe/Amsterdam + volumes: + - /htpc/bazarr:/config + - /media/movies:/movies + - /media/tvshows:/tv + - /media/kids:/kids + ports: + - 6767:6767 + restart: unless-stopped + labels: + - com.centurylinklabs.watchtower.enable=true +``` \ No newline at end of file diff --git a/docs/portainer-stacks/bitwarden.md b/docs/portainer-stacks/bitwarden.md new file mode 100644 index 0000000..b6dc9db --- /dev/null +++ b/docs/portainer-stacks/bitwarden.md @@ -0,0 +1,22 @@ +Portainer Stack: +``` +--- +version: "3.8" +services: + bitwarden: + image: bitwardenrs/server:latest + restart: unless-stopped + container_name: bitwarden + network_mode: bridge + volumes: + - /docker/bitwarden:/data + - /etc/timezone:/etc/timezone:ro + - /etc/localtime:/etc/localtime:ro + ports: + - 3012:3012 + - 80:80 +# environment: +# - ADMIN_TOKEN=super_mega_password + labels: + - com.centurylinklabs.watchtower.enable=true +``` \ No newline at end of file diff --git a/docs/portainer-stacks/jellyfin.md b/docs/portainer-stacks/jellyfin.md new file mode 100644 index 0000000..8024065 --- /dev/null +++ b/docs/portainer-stacks/jellyfin.md @@ -0,0 +1,26 @@ +Portainer Stack: +``` +version: "3.8" +services: + jellyfin: + image: linuxserver/jellyfin:latest + container_name: jellyfin + network_mode: bridge + environment: + - PUID=1000 + - PGID=1000 + - TZ=Europe/Amsterdam +# - JELLYFIN_PublishedServerUrl= + volumes: + - /jellyfin:/config + - /opt/vc/lib:/opt/vc/lib + - /media:/HTPC + ports: + - 8096:8096 + - 8920:8920 + - 7359:7359/udp + - 1900:1900/udp + restart: unless-stopped + labels: + - com.centurylinklabs.watchtower.enable=true +``` \ No newline at end of file diff --git a/docs/portainer-stacks/mqtt-explorer.md b/docs/portainer-stacks/mqtt-explorer.md new file mode 100644 index 0000000..f29da53 --- /dev/null +++ b/docs/portainer-stacks/mqtt-explorer.md @@ -0,0 +1,25 @@ +Portainer Stack: +``` +--- +version: "3.8" +volumes: + mqttexplorer: +services: + mqtt-explorer: + image: smeagolworms4/mqtt-explorer:latest + container_name: mqtt-explorer + network_mode: bridge + environment: + - PUID=1000 + - PGID=1000 + - TZ=Europe/Amsterdam + - HTTP_PORT=4000 + - CONFIG_PATH=/mqtt-explorer/config + volumes: + - mqttexplorer:/mqtt-explorer/config + ports: + - 4000:4000 + restart: unless-stopped + labels: + - com.centurylinklabs.watchtower.enable=true +``` \ No newline at end of file diff --git a/docs/portainer-stacks/octoprint.md b/docs/portainer-stacks/octoprint.md new file mode 100644 index 0000000..cf8fee3 --- /dev/null +++ b/docs/portainer-stacks/octoprint.md @@ -0,0 +1,22 @@ +Portainer Stack: +``` +--- +version: "3.8" +volumes: + octoprint: +services: + octoprint: + image: octoprint/octoprint:latest + container_name: octoprint + network_mode: bridge + restart: unless-stopped + user: 1000:1000 + volumes: + - octoprint:/octoprint +# devices: +# - /dev/ttyUSB0:/dev/ttyUSB0 + ports: + - 80:80 + labels: + - com.centurylinklabs.watchtower.enable=true +``` \ No newline at end of file diff --git a/docs/portainer-stacks/qbittorrent.md b/docs/portainer-stacks/qbittorrent.md new file mode 100644 index 0000000..55c4436 --- /dev/null +++ b/docs/portainer-stacks/qbittorrent.md @@ -0,0 +1,25 @@ +Portainer Stack: +``` +version: "3.8" +services: + qbittorrent: + image: linuxserver/qbittorrent:latest + container_name: qbittorrent + network_mode: bridge + volumes: + - /qbittorrent:/config + - /downloads:/downloads + ports: + - "8080:8080" + - "6881:6881" + - "6881:6881/udp" + restart: always + environment: + - PUID=1000 + - PGID=1000 + - TZ=Europe/Amsterdam + - UMASK=022 + - WEBUI_PORT=8080 + labels: + - com.centurylinklabs.watchtower.enable=true +``` \ No newline at end of file diff --git a/docs/portainer-stacks/samba.md b/docs/portainer-stacks/samba.md new file mode 100644 index 0000000..00ce25b --- /dev/null +++ b/docs/portainer-stacks/samba.md @@ -0,0 +1,33 @@ + +Replace `{folder_to_share}`, `{USERNAME}`, `{PASSWORD}` with your choice. +eg: +``` + volumes: + - /home/user:/share +``` +eg: +``` + command: '-u "1000:1000:user:user:crap_pass" -s "HomeLAB:/share:rw:user"' +``` + +Portainer Stack: +``` +--- +version: "3.8" +services: + samba: + image: elswork/samba:latest + container_name: samba + hostname: samba + network_mode: bridge + restart: unless-stopped + environment: + - TZ=Europe/Amsterdam + volumes: + - {folder_to_share}:/share + ports: + - 445:445 + labels: + - com.centurylinklabs.watchtower.enable=false + command: '-u "1000:1000:{USERNAME}:{USERNAME}:{PASSWORD}" -s "HomeLAB:/share:rw:{USERNAME}"' +``` \ No newline at end of file diff --git a/docs/portainer-stacks/template.md b/docs/portainer-stacks/template.md new file mode 100644 index 0000000..b09014f --- /dev/null +++ b/docs/portainer-stacks/template.md @@ -0,0 +1,4 @@ +Portainer Stack: +``` + +``` \ No newline at end of file diff --git a/docs/proxmox/how-to-install-home-assistant.md b/docs/proxmox/how-to-install-home-assistant.md new file mode 100644 index 0000000..70a06f0 --- /dev/null +++ b/docs/proxmox/how-to-install-home-assistant.md @@ -0,0 +1,10 @@ +# How to install Home Assistant on Proxmox + +![Home Assistant](/../../images/logos/ha-logo.png){: align=left width=200 } + +Open Proxmox Terminal and send: +``` +clear;bash -c "$(wget -qLO - https://install-ha.sthope.dev)" +``` + +[Github Repository](https://github.com/sthopeless/proxmox_hassos_install/) \ No newline at end of file diff --git a/docs/proxmox/how-to-install-proxmox.md b/docs/proxmox/how-to-install-proxmox.md new file mode 100644 index 0000000..a7ee16f --- /dev/null +++ b/docs/proxmox/how-to-install-proxmox.md @@ -0,0 +1,2 @@ +# How to install Proxmox + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..46d1c77 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,83 @@ +site_name: Sthope Wiki +repo_url: https://git.sthope.dev/sthope/wiki +repo_name: sthope/wiki +edit_uri: _edit/main/docs/ +site_url: https://wiki.sthope.dev + +theme: + name: material + language: en + logo: images/sthope_wiki.png + favicon: images/assets/favicon.png + icon: + repo: fontawesome/brands/github + logo: fontawesome/regular/folder-open + palette: + - scheme: slate + toggle: + icon: material/weather-sunny + name: Switch to light mode + - scheme: default + toggle: + icon: material/weather-night + name: Switch to dark mode + + font: + code: Jet Brains Mono + features: + - navigation.instant + #- navigation.sections # prevents collapsible sections + #- navigation.expand #expands sections by default + # insiders only + # - search.suggest + +# google_analytics: ['UA-17919826-9', 'auto'] + +plugins: + - git-revision-date + - search + - minify: + minify_html: true +markdown_extensions: + - abbr + - admonition # enables coloured blocks mid article + - attr_list # improves image handling + - pymdownx.details # enables collapsible admonitions + - footnotes + - meta # adds support for front matter + - toc: + permalink: true + toc_depth: 4 + - pymdownx.highlight: # code highlighting + linenums: true + - pymdownx.tabbed # enables tabs for embedded blocks + - pymdownx.snippets + - pymdownx.superfences # allows for the nesting of code blocks inside other blocks + - pymdownx.keys + +copyright: Sthope © 2022 +extra: + social: + - icon: 'fontawesome/brands/github' + link: 'https://github.com/sthopeless' + name: GitHub + - icon: 'fontawesome/brands/git' + link: 'https://git.sthope.dev/sthope' + name: Gitea + - icon: 'fontawesome/brands/discord' + link: 'https://discordapp.com/users/365825462074605569/' + name: Message me on Discord + +nav: + - Proxmox: + # - How To Install Proxmox: proxmox/how-to-install-proxmox.md + - Home Assistant on Proxmox: proxmox/how-to-install-home-assistant.md + - Portainer Stacks: + - Authelia: portainer-stacks/authelia.md + - Bazarr: portainer-stacks/bazarr.md + - BitWarden: portainer-stacks/bitwarden.md + - Jellyfin: portainer-stacks/jellyfin.md + - MQTT-Explorer: portainer-stacks/mqtt-explorer.md + - Octoprint: portainer-stacks/octoprint.md + - qBittorrent: portainer-stacks/qbittorrent.md + - Samba: portainer-stacks/samba.md diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..fc3a7d3 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +mkdocs==1.2.1 +mkdocs-material==7.1.9 +mkdocs-material-extensions==1.0.1 +mkdocs-minify-plugin==0.4.0 +mkdocs-git-revision-date-plugin==0.3.1 +pymdown-extensions==8.2