Make renderable by mkdocs-material

Move docs into a renderable form for mkdocs. This necessitated a
reordering of things inside this repo.

Signed-off-by: Wachtl Enterprises LLC <tyrolyean@escpe.net>
This commit is contained in:
Wachtl Enterprises LLC 2025-03-15 22:21:42 +01:00
parent 03cb2972ce
commit ccb747c82b
43 changed files with 234 additions and 34 deletions

View file

@ -0,0 +1,25 @@
name: ci # (1)!
on:
push:
branches:
- master # (2)!
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV # (3)!
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache # (4)!
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material # (5)!
- run: mkdocs gh-deploy --force

View file

@ -13,14 +13,14 @@ including our physical space as well as the cloudy infrastructure.
## PoP Space Devices
The [[space/]](space/) network includes (but is not limited to) network
The [[space/]](space/README.md) network includes (but is not limited to) network
infrastructure:
- IP [[Router]](space/router.md)
- 802.1 Ethernet [[Switches]](space/switch.md)
- 802.11 WLAN [[Access-Points]](space/access_points.md)
a general purpose hypervísér
a general purpose hypervisor
- Proxmox Hypervisor [[acraze]](space/srv-acraze/acraze.md) running
- Database VM [[pgsql]](space/srv-acraze/database.md)
@ -49,7 +49,8 @@ and manufacturing equipment
We own and operate VMs on other peoples hardware, also known as VPSes. These are
currently limited to:
- General use server [[srv.hc]](cloud/srv.md)
- Hetzner VPS, reverse proxy [[srv.hc]](cloud/srv.md)
- Alwyzon VPS, IPv6 and DNS [[srv.hc]](cloud/srv.md)
## Archival links

77
docs/img/its.svg Normal file
View file

@ -0,0 +1,77 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Generator: Adobe Illustrator 15.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
version="1.1"
id="Ebene_1"
x="0px"
y="0px"
width="283.00204"
height="192.60927"
viewBox="0 0 283.00205 192.60928"
enable-background="new 0 0 327.228 277.8"
xml:space="preserve"
inkscape:version="0.48.5 r10040"
sodipodi:docname="logo2013.svg"><metadata
id="metadata45"><rdf:RDF><cc:Work
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /></cc:Work></rdf:RDF></metadata><defs
id="defs43" /><sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1600"
inkscape:window-height="834"
id="namedview41"
showgrid="false"
inkscape:zoom="0.84953207"
inkscape:cx="-6.8159251"
inkscape:cy="91.59616"
inkscape:window-x="0"
inkscape:window-y="27"
inkscape:window-maximized="1"
inkscape:current-layer="Ebene_1"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0" /><g
id="g5"
style="fill:#ffffff"
transform="matrix(1.211673,0,0,1.211673,-58.357605,-48.01254)"><circle
sodipodi:ry="18.76"
sodipodi:rx="18.76"
sodipodi:cy="58.384998"
sodipodi:cx="70.221001"
id="circle7"
r="18.76"
cy="58.384998"
cx="70.221001"
style="fill:#ffffff"
d="m 88.981001,58.384998 c 0,10.360862 -8.399138,18.760001 -18.76,18.760001 -10.360862,0 -18.760001,-8.399139 -18.760001,-18.760001 0,-10.360862 8.399139,-18.76 18.760001,-18.76 10.360862,0 18.76,8.399138 18.76,18.76 z" /><g
id="g9"
style="fill:#ffffff"><path
inkscape:connector-curvature="0"
id="path11"
d="m 262.107,86.738 c -3.213,0 -6.232,0.814 -8.875,2.241 -0.67,0.362 -1.623,-0.303 -1.623,-1.102 0,-4.884 -3.959,-8.843 -8.842,-8.843 -4.885,0 -8.844,3.959 -8.844,8.843 0,4.882 3.959,8.841 8.844,8.841 1.088,0 2.217,1.077 1.875,1.947 -0.834,2.116 -1.297,4.417 -1.297,6.829 0,10.36 8.4,18.759 18.762,18.759 10.359,0 18.758,-8.398 18.758,-18.759 0,-10.357 -8.398,-18.756 -18.758,-18.756 z"
style="fill:#ffffff" /><path
inkscape:connector-curvature="0"
id="path13"
d="m 281.6,166.018 c -0.426,-13.476 -8.039,-26.154 -21.037,-30.815 -6.316,-2.266 -12.584,-2.097 -19.143,-1.548 -2.504,0.207 -5.115,0.693 -7.545,-0.168 -3.383,-1.199 -5.777,-4.411 -5.953,-7.996 -0.127,-2.584 1.693,-5.291 2.309,-7.762 0.76,-3.033 0.848,-6.188 0.344,-9.268 -0.879,-5.357 -3.512,-10.425 -7.691,-13.939 C 217.603,90.081 210.993,88.96 204.345,88.95 189.107,88.929 173.866,88.908 158.63,88.888 138.362,88.86 118.099,88.831 97.833,88.804 90.925,88.794 84.015,88.784 77.104,88.775 72.858,88.769 68.733,88.523 64.655,89.65 51.843,93.193 44.8,107.625 49.76,119.909 c 1.41,3.497 3.818,6.201 6.164,8.867 2.588,2.939 4.389,6.54 5.176,10.377 0.807,3.958 0.543,8.126 -0.777,11.946 -0.633,1.834 -1.508,3.583 -2.59,5.195 -0.314,0.469 -3.422,4.006 -3.377,4.082 -10.48,10.483 -6.988,28.797 5.797,35.582 12.314,6.535 28.111,0.018 32.213,-13.344 1.848,-6.009 1.201,-13.42 -2.039,-18.833 -1.775,-2.968 -4.666,-4.768 -6.547,-7.612 -2.336,-3.533 -3.637,-7.697 -3.734,-11.931 -0.348,-15.086 14.549,-26.507 29.035,-22.224 15.182,4.486 21.156,23.603 11.15,35.934 -1.215,1.498 -2.682,2.75 -3.855,4.284 -1.271,1.659 -2.312,3.495 -3.078,5.44 -1.586,4.026 -1.977,8.496 -1.129,12.74 1.693,8.469 7.9,15.123 16.26,17.384 15.057,4.076 30.102,-8.317 28.67,-23.922 -0.383,-4.166 -1.941,-8.187 -4.461,-11.523 -2.379,-3.148 -5.146,-5.7 -6.75,-9.476 -2.992,-7.047 -2.146,-15.347 2.191,-21.644 4.018,-5.829 10.674,-9.511 17.752,-9.784 5.588,-0.216 12.305,1.91 16.301,5.852 2.236,2.206 3.898,4.965 4.977,7.906 0.975,2.665 1.064,5.205 1.393,7.972 0.705,6.001 5.246,8.878 10.697,10.235 2.617,0.65 5.291,1.038 7.914,1.656 2.998,0.706 6.211,1.38 8.324,3.799 4.691,5.369 0.896,16.088 -7.031,14.802 -2.611,-0.423 -4.932,-1.22 -7.586,-0.677 -3.43,0.701 -6.479,2.824 -8.342,5.783 -4.154,6.598 -1.408,16.133 6.053,18.896 3.768,1.395 8.891,1.33 12.236,-1.135 2.721,-2.005 3.162,-6.658 6.869,-7.48 4.391,-1.783 7.611,0.51 10.893,3.162 1.859,1.504 4.049,2.544 6.309,3.296 3.5,1.167 7.193,1.71 10.857,2.037 3.994,0.354 7.908,0.403 11.818,-0.595 6.818,-1.745 12.807,-6.023 17.115,-11.533 4.268,-5.45 7.194,-12.396 6.972,-19.405 -0.553,-17.409 0.466,14.73 0,0 z"
style="fill:#ffffff" /><path
style="fill:#ffffff;stroke:#000000;stroke-miterlimit:10"
inkscape:connector-curvature="0"
id="path15"
d="M 209.236,167.063"
stroke-miterlimit="10" /></g></g></svg>

After

(image error) Size: 5.1 KiB

36
docs/space/README.md Normal file
View file

@ -0,0 +1,36 @@
# IT-Syndikat local infrastructure
Most of our infrastructure is hosted locally on our own hardware.
## Virtualized Infrastructure
On our proxmox hypervisor [Acraze](srv-acraze/acraze.md), we operate a number of
services:
* [Database server](srv-acraze/database.md)
* [Discourse Instance](srv-acraze/discourse.md)
* [DNS Master](srv-acraze/dns.md)
* [Forgejo instance](srv-acraze/gitea.md)
* [LDAP server](srv-acraze/ldap.md)
* [Centralized logging](srv-acraze/logging.md)
* [E-Mail](srv-acraze/mail.md)
* [Synapse - Matrix Homeserver](srv-acraze/matrix.md)
* [Member IRC Bouncer](srv-acraze/thelounge.md)
* [Vaultwarden](srv-acraze/vaultwarden.md)
* [New old web](srv-acraze/web-general.md)
* [Old web](srv-acraze/web-its.md)
* [Our Zabbix monitoring](srv-acraze/zabbix.md)
## Hardware infrastructure
We do operate non-virtual infrastructure as well:
* [VoIP Telephony thingimagic](voip.md)
* [PF-Sense Router](router.md)
* [2D printers](2d-printer.md)
* [3d-printer.md](3d-printer.md)
* [WIFI APs](access_points.md)
* [Mimaki Plotter](mimaki.md)
* [Switch(es)](switch.md)
* [LaaS - Lo-Fi as a Service](laas.md)
* [Member PC - Schmuddelkiste](schmuddelkiste.md)

51
mkdocs.yml Normal file
View file

@ -0,0 +1,51 @@
site_name: ITS-Network Docs
site_url: https://docs.it-syndikat.org
nav:
- '~': README.md
- 'space':
- 'overview': space/README.md
- 'virtual':
- 'Database': space/srv-acraze/database.md
- 'Discourse': space/srv-acraze/discourse.md
- 'DNS': space/srv-acraze/dns.md
- 'Forgejo': space/srv-acraze/gitea.md
- 'LDAP': space/srv-acraze/ldap.md
- 'Logging': space/srv-acraze/logging.md
- 'E-Maik': space/srv-acraze/mail.md
- 'Matrix': space/srv-acraze/matrix.md
- 'IRC Bouncer': space/srv-acraze/thelounge.md
- 'Vaultwarden': space/srv-acraze/vaultwarden.md
- 'New Web': space/srv-acraze/web-general.md
- 'Old Web': space/srv-acraze/web-its.md
- 'Zabbix': space/srv-acraze/zabbix.md
- 'hardware':
- 'VOIP': space/voip.md
- 'Router': space/router.md
- '2D-Printers': space/2d-printer.md
- '3D-Printers': space/3d-printer.md
- 'WiFi': space/access_points.md
- 'Mimaki': space/mimaki.md
- 'Switch': space/switch.md
- 'LaaS': space/laas.md
- 'Schmuddelkiste': space/schmuddelkiste.md
- 'cloud':
- 'srv': cloud/srv.md
- 'Hannibass': cloud/hannibass.md
theme:
name: material
logo: 'img/its.svg'
favicon: 'img/its.ico'
features:
- navigation.footer
palette:
scheme: slate
primary: 'black'
accent: pink
markdown_extensions:
- attr_list
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
copyright: Copyright &copy; 2024-2025
extra:
generator: false

41
presentation/main.tex Normal file
View file

@ -0,0 +1,41 @@
\documentclass[aspectratio=169]{beamer}
\usepackage[english]{babel}
\usepackage{svg}
\title{IT-Syndikat Infrastructure}
\subtitle{Workshop}
\author[Daniel P.]{Daniel Plank}
\institute[ITS]{
IT-Syndikat%
\\%
Verein zur Förderung des freien Zugangs zu technischer Fort- und
Weiterbildung jeglicher Art%
}
\date{2022-12-20}
\logo{\includesvg[width= 0.2\textwidth]{images/logo2013.svg}}
\begin{document}
\frame{\titlepage}
\begin{frame}{Summary}
\tableofcontents
\end{frame}
\section*{Acknowledgments} %You can remove this if you do not want to use it
\begin{frame}{Acknowledgments}
The author is extremely thankful to Prof. Antônio F. R. T. Piza for the short, yet wonderful, conversations about this seminar.
\end{frame}
\section*{References} %You can remove this if you do not want to use it
\nocite{Djairo} \nocite{PhilPanof} \nocite{Fleming} \nocite{Shankar}
\begin{frame}{References}
\printbibliography
\end{frame}
\section{}
\begin{frame}{}
\centering
\Huge\bfseries
\textcolor{orange}{The End}
\end{frame}
\end{document}

BIN
presentation/pres.pdf Normal file

Binary file not shown.

View file

@ -1,31 +0,0 @@
# Jade -- DXLD-NET IPv6 router
Maintainer: dxld
Jade provides IPv6 WAN access through
[AS212704 (bgpview.io)](https://bgpview.io/asn/212704#prefixes-v6). We use
Wireguard tunnels on top of IPv4 to egress. DXLD-NET uses the babeld
routing daemon with RTT based routing metric as IGP.
## Internet access
Jade's primary uplink is to the Magenta CPE
[see Sozial [#Internet access]](../router.md#internet-access) via VLAN 5
(MODEM) on FCX1.
A secondary uplink has recently been provisioned via a 5G-NR/LTE modem (on
discretionary lease by dxld). VLAN 6 (MODEM-5G) is used for the connection
to Jade. The modem is connected at FCX2 for wireless reception reasons at
time of writing.
The IPv4 uplinks are currently in a failover configuration discriminated by
the IPv4 default route on Jade. The FOO Link Status Monitor (foolsm) was
briefly tried to tear down the DHCP default route more quickly via
interface restart but this was found to be unreliable.
The current plan is to extend the Wireguard tunnel provisioning automation
with support for multiple uplinks and use babeld to route over all possible
paths.
--Daniel