commit f25e515ff07a7884681c0f4b4841fedc327d81f2 Author: BuildTools Date: Thu Mar 31 18:29:00 2022 +0200 wtf submodule diff --git a/README.md b/README.md new file mode 100644 index 0000000..f015342 --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +### Neues Wiki auf Basis von Hugo + +Wiki +---------------- +* Dokumentation der neuen Infrastruktur +* Anleitungen +* Das alte Wiki wird nicht mit übernommen +* Alles was mit Meshkit zu tun hat, bitte hier http://wiki.leipzig.freifunk.net/Hauptseite nachlesen. \ No newline at end of file diff --git a/archetypes/default.md b/archetypes/default.md new file mode 100644 index 0000000..00e77bd --- /dev/null +++ b/archetypes/default.md @@ -0,0 +1,6 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: {{ .Date }} +draft: true +--- + diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..dbecd6e --- /dev/null +++ b/config.toml @@ -0,0 +1,12 @@ +baseURL = "https://wiki.freifunk-leipzig.de" +languageCode = "de-de" +title = "FFL Wiki" +theme = "hugo-book" + +[params] +BookRepo = "https://git.dezentrale.cloud/freifunk-leipzig/wiki" +BookEditPath = "src/" +BookLogo = "/ffl.svg" +#BookSection = "docs" +BookComments = true +BookPortableLinks = true \ No newline at end of file diff --git a/content/docs/Gluon/_index.md b/content/docs/Gluon/_index.md new file mode 100644 index 0000000..0c19997 --- /dev/null +++ b/content/docs/Gluon/_index.md @@ -0,0 +1,9 @@ +--- +title: "Gluon" +bookCollapseSection: true +weight: 20 +--- + +# Gluon + + diff --git a/content/docs/Infrastuktur/_index.md b/content/docs/Infrastuktur/_index.md new file mode 100644 index 0000000..b12c72b --- /dev/null +++ b/content/docs/Infrastuktur/_index.md @@ -0,0 +1,7 @@ +--- +title: "Infrastruktur" +bookCollapseSection: true +weight: 40 +--- + +# Infrastruktur diff --git a/content/docs/Infrastuktur/ip_netze.md b/content/docs/Infrastuktur/ip_netze.md new file mode 100644 index 0000000..4dc45a9 --- /dev/null +++ b/content/docs/Infrastuktur/ip_netze.md @@ -0,0 +1,354 @@ +Freifunk Leipzig +======================= + +Übersicht der vorhandenen Netze +---------------- + +## IPv4 + +Für das Leipziger-Netz sind folgende Subnetze reserviert: + +| IPv4 | Range | +|-----------------|------------------------------| +| `10.59.0.0/21` | `10.59.0.1 - 10.59.7.254` | +| `10.59.16.0/20` | `10.59.16.1 - 10.59.23.254` | +| `10.59.32.0/20` | `10.59.32.1 - 10.59.47.254` | +| `10.61.0.0/16` | `10.61.0.1 - 10.61.255.254` | + +## IPv6 + +Wurde nicht registriert! + +Gateways +-------- + +### aktuell + +| Name | IPv4 | IPv6 | MAC Address | Status | FQDN | Ansprechpartner | +|---------------|----------------|-----------------------|-------------------- |--------|------------------------------------|-----------------| +| vpnf | `77.87.49.5` | `-` | `aa:00:32:68:f0:6c` | aktiv | gluon20171a61.leipzig.freifunk.net | UFO/Mokkin +| gluon20171b61 | `176.9.46.7` | `-` | `de:ad:ca:fe:bb:*` | aktiv | gluon20171b61.leipzig.freifunk.net | UFO/Mokkin +| gluon20171c61 | `77.87.48.30` | `-` | `52:54:00:0c:bb:*` | aktiv | gluon20171c61.leipzig.freifunk.net | UFO/Mokkin + + +### aufbau + +| Name | IPv4 | IPv6 | MAC Address | Status | FQDN | Ansprechpartner | +|----------|----------------|------------------------|--------------------|---------|----------------------------|-----------------| +| vpn04 | `95.216.6.28` | `2a01:4f9:2a:65d::204` | `-` | aufbau | vpn04.freifunk-leipzig.de | Broiler | +| vpn05 | `95.216.6.28` | `2a01:4f9:2a:65d::205` | `-` | aufbau | vpn05.freifunk-leipzig.de | Broiler | +| vpn06 | `95.216.6.28` | `2a01:4f9:2a:65d::206` | `-` | aufbau | vpn06.freifunk-leipzig.de | Broiler | +| vpn07 | `dynamisch` | `dynamisch` | `-` | aufbau | vpn07.freifunk-leipzig.de | Broiler/Max | + + +IP-Ranges +---------- + +Folgende Auslistung sind aktualisierung von den alten Dokumentationen. + + +| CIDR | DHCP Start | DHCP Ende | Gateway | Status | +|------------------|---------------|-----------------|------------|--------| +| `10.59.0.0/24` | `-` | ` - ` | ` - ` | | +| `10.59.1.0/24` | `-` | ` - ` | ` - ` | | +| `10.59.2.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.3.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.4.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.5.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.6.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.7.0/24` | `-` | ` - ` | ` - ` | frei | + + +| CIDR | DHCP Start | DHCP Ende | Gateway | Status | +|------------------|---------------|-----------------|------------|--------| +| `10.59.16.0/24` | `-` | ` - ` | ` - ` | | +| `10.59.17.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.18.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.19.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.20.0/24` | `-` | ` - ` | ` - ` | | +| `10.59.21.0/24` | `-` | ` - ` | ` - ` | | +| `10.59.22.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.23.0/24` | `-` | ` - ` | ` - ` | frei | + +| CIDR | DHCP Start | DHCP Ende | Gateway | Status | +|------------------|---------------|-----------------|------------|--------| +| `10.59.32.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.33.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.34.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.35.0/24` | `-` | ` - ` | ` - ` | Gluon | +| `10.59.36.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.37.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.38.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.39.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.40.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.41.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.42.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.43.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.44.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.45.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.46.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.59.47.0/24` | `-` | ` - ` | ` - ` | frei | + +| CIDR | DHCP Start | DHCP Ende | Gateway | Status | +|------------------|---------------|-----------------|------------|--------| +| `10.61.1.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.2.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.3.0/24` | `-` | ` - ` | ` - ` | für Gluon [Konflikt](http://db.leipzig.freifunk.net/node/3704/) | +| `10.61.4.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.5.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.6.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.7.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.8.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.9.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.10.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.11.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.12.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.13.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.14.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.15.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.16.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.17.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.18.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.19.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.20.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.21.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.22.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.23.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.24.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.25.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.26.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.27.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.28.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.29.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.30.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.31.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.32.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.33.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.34.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.35.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.36.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.37.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.38.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.39.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.40.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.41.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.42.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.43.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.44.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.45.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.46.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.47.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.48.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.49.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.50.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.51.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.52.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.53.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.54.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.55.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.56.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.57.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.58.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.59.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.60.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.61.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.62.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.63.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.64.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.65.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.66.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.67.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.68.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.69.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.70.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.71.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.72.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.73.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.74.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.75.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.76.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.77.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.78.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.79.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.80.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.81.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.82.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.83.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.84.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.85.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.86.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.87.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.88.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.89.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.90.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.91.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.92.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.93.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.94.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.95.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.96.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.97.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.98.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.99.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.100.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.101.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.102.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.103.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.104.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.105.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.106.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.107.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.108.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.109.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.110.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.111.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.112.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.113.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.114.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.115.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.116.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.117.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.118.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.119.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.120.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.121.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.122.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.123.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.124.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.125.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.126.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.127.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.128.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.129.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.130.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.131.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.132.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.133.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.134.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.135.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.136.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.137.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.138.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.139.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.140.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.141.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.142.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.143.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.144.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.145.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.146.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.147.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.148.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.149.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.150.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.151.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.152.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.153.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.154.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.155.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.156.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.157.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.158.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.159.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.160.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.161.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.162.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.163.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.164.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.165.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.166.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.167.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.168.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.169.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.170.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.171.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.172.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.173.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.174.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.175.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.176.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.177.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.178.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.179.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.180.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.181.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.182.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.183.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.184.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.185.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.186.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.187.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.188.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.189.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.190.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.191.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.192.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.193.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.194.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.195.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.196.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.197.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.198.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.199.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.200.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.201.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.202.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.203.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.204.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.205.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.206.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.207.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.208.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.209.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.210.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.211.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.212.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.213.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.214.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.215.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.216.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.217.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.218.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.219.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.220.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.221.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.222.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.223.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.224.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.225.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.226.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.227.0/24` | `-` | ` - ` | ` - ` | frei | +| `10.61.228.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.229.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.230.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.231.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.232.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.233.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.234.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.235.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.236.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.237.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.238.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.239.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.240.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.241.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.242.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.243.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.244.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.245.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.246.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.247.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.248.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.249.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.250.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.251.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.252.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.253.0/24` | `-` | ` - ` | ` - ` | | +| `10.61.254.0/24` | `-` | ` - ` | ` - ` | | + +BGP +----------- + +| Name | IPv4 | IPv6 | +|----------|----------------|------------------------| +| leipzig2 | 10.207.0.2 | fec0::a:cf:0:2 | \ No newline at end of file diff --git a/content/docs/Infrastuktur/server.md b/content/docs/Infrastuktur/server.md new file mode 100644 index 0000000..53e56e3 --- /dev/null +++ b/content/docs/Infrastuktur/server.md @@ -0,0 +1,14 @@ +--- +weight: 50 +--- + +## Server + +| Name | FQDN | Aufgabe | Kontakt | CPU |Kerne | RAM | HDD | +| ----------------- | -------------------------------|-------------------------|---------------|-------------------|------|------|--------------------------| +| gluon20171a61 | vpna.freifunk-leipzig.de | GW | UFO/Mokkin | | | | | +| gluon20171b61 | vpnb.freifunk-leipzig.de | GW | UFO/Mokkin | | | | | +| gluon20171c61 | vpnc.freifunk-leipzig.de | GW | UFO/Mokkin | | | | | +| lida | lida.freifunk-leipzig.de | GW | Broiler | Xeon E3-1246V3 | 8 | 32 GB| 2x 2TB HDD | +| builder | builder.freifunk-leipzig.de | Builder,gitlab-runner | Broiler/Katze | 2x Xeon E5-2650 | 32 | 64 GB| 1x 240 GB SSD 2x 1TB HDD | +| freifunk | freifunk-leipzig.de | Webseite, Wiki, Images | Broiler/Katze | i7-3770 | 2 | 2 GB| 1x 40 GB HDD | \ No newline at end of file diff --git a/resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.content b/resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.content new file mode 100644 index 0000000..bbd5aed --- /dev/null +++ b/resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.content @@ -0,0 +1 @@ +@charset "UTF-8";:root{--gray-100:#f8f9fa;--gray-200:#e9ecef;--gray-500:#adb5bd;--color-link:#0055bb;--color-visited-link:#8440f1;--body-background:white;--body-font-color:black;--icon-filter:none;--hint-color-info:#6bf;--hint-color-warning:#fd6;--hint-color-danger:#f66}/*!normalize.css v8.0.1 | MIT License | github.com/necolas/normalize.css*/html{line-height:1.15;-webkit-text-size-adjust:100%}body{margin:0}main{display:block}h1{font-size:2em;margin:.67em 0}hr{box-sizing:content-box;height:0;overflow:visible}pre{font-family:monospace,monospace;font-size:1em}a{background-color:transparent}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}code,kbd,samp{font-family:monospace,monospace;font-size:1em}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sub{bottom:-.25em}sup{top:-.5em}img{border-style:none}button,input,optgroup,select,textarea{font-family:inherit;font-size:100%;line-height:1.15;margin:0}button,input{overflow:visible}button,select{text-transform:none}button,[type=button],[type=reset],[type=submit]{-webkit-appearance:button}button::-moz-focus-inner,[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner{border-style:none;padding:0}button:-moz-focusring,[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring{outline:1px dotted ButtonText}fieldset{padding:.35em .75em .625em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{vertical-align:baseline}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}details{display:block}summary{display:list-item}template{display:none}[hidden]{display:none}.flex{display:flex}.flex-auto{flex:auto}.flex-even{flex:1 1}.flex-wrap{flex-wrap:wrap}.justify-start{justify-content:flex-start}.justify-end{justify-content:flex-end}.justify-center{justify-content:center}.justify-between{justify-content:space-between}.align-center{align-items:center}.mx-auto{margin:0 auto}.text-center{text-align:center}.text-left{text-align:left}.text-right{text-align:right}.hidden{display:none}input.toggle{height:0;width:0;overflow:hidden;opacity:0;position:absolute}.clearfix::after{content:"";display:table;clear:both}html{font-size:16px;scroll-behavior:smooth;touch-action:manipulation}body{min-width:20rem;color:var(--body-font-color);background:var(--body-background);letter-spacing:.33px;font-weight:400;text-rendering:optimizeLegibility;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale;box-sizing:border-box}body *{box-sizing:inherit}h1,h2,h3,h4,h5{font-weight:400}a{text-decoration:none;color:var(--color-link)}img{vertical-align:baseline}:focus{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}aside nav ul{padding:0;margin:0;list-style:none}aside nav ul li{margin:1em 0;position:relative}aside nav ul a{display:block}aside nav ul a:hover{opacity:.5}aside nav ul ul{padding-inline-start:1rem}ul.pagination{display:flex;justify-content:center;list-style-type:none}ul.pagination .page-item a{padding:1rem}.container{max-width:80rem;margin:0 auto}.book-icon{filter:var(--icon-filter)}.book-brand{margin-top:0;margin-bottom:1rem}.book-brand img{height:1.5em;width:1.5em;margin-inline-end:.5rem}.book-menu{flex:0 0 16rem;font-size:.875rem}.book-menu .book-menu-content{width:16rem;padding:1rem;background:var(--body-background);position:fixed;top:0;bottom:0;overflow-x:hidden;overflow-y:auto}.book-menu a,.book-menu label{color:inherit;cursor:pointer;word-wrap:break-word}.book-menu a.active{color:var(--color-link)}.book-menu input.toggle+label+ul{display:none}.book-menu input.toggle:checked+label+ul{display:block}.book-menu input.toggle+label::after{content:"▸"}.book-menu input.toggle:checked+label::after{content:"▾"}body[dir=rtl] .book-menu input.toggle+label::after{content:"◂"}body[dir=rtl] .book-menu input.toggle:checked+label::after{content:"▾"}.book-section-flat{margin:2rem 0}.book-section-flat>a,.book-section-flat>span,.book-section-flat>label{font-weight:bolder}.book-section-flat>ul{padding-inline-start:0}.book-page{min-width:20rem;flex-grow:1;padding:1rem}.book-post{margin-bottom:3rem}.book-header{display:none;margin-bottom:1rem}.book-header label{line-height:0}.book-header img.book-icon{height:1.5em;width:1.5em}.book-search{position:relative;margin:1rem 0;border-bottom:1px solid transparent}.book-search input{width:100%;padding:.5rem;border:0;border-radius:.25rem;background:var(--gray-100);color:var(--body-font-color)}.book-search input:required+.book-search-spinner{display:block}.book-search .book-search-spinner{position:absolute;top:0;margin:.5rem;margin-inline-start:calc(100% - 1.5rem);width:1rem;height:1rem;border:1px solid transparent;border-top-color:var(--body-font-color);border-radius:50%;animation:spin 1s ease infinite}@keyframes spin{100%{transform:rotate(360deg)}}.book-search small{opacity:.5}.book-toc{flex:0 0 16rem;font-size:.75rem}.book-toc .book-toc-content{width:16rem;padding:1rem;position:fixed;top:0;bottom:0;overflow-x:hidden;overflow-y:auto}.book-toc img{height:1em;width:1em}.book-toc nav>ul>li:first-child{margin-top:0}.book-footer{padding-top:1rem;font-size:.875rem}.book-footer img{height:1em;width:1em;margin-inline-end:.5rem}.book-comments{margin-top:1rem}.book-languages{margin-block-end:2rem}.book-languages .book-icon{height:1em;width:1em;margin-inline-end:.5em}.book-languages ul{padding-inline-start:1.5em}.book-menu-content,.book-toc-content,.book-page,.book-header aside,.markdown{transition:.2s ease-in-out;transition-property:transform,margin,opacity,visibility;will-change:transform,margin,opacity}@media screen and (max-width:56rem){#menu-control,#toc-control{display:inline}.book-menu{visibility:hidden;margin-inline-start:-16rem;font-size:16px;z-index:1}.book-toc{display:none}.book-header{display:block}#menu-control:focus~main label[for=menu-control]{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}#menu-control:checked~main .book-menu{visibility:initial}#menu-control:checked~main .book-menu .book-menu-content{transform:translateX(16rem);box-shadow:0 0 .5rem rgba(0,0,0,.1)}#menu-control:checked~main .book-page{opacity:.25}#menu-control:checked~main .book-menu-overlay{display:block;position:absolute;top:0;bottom:0;left:0;right:0}#toc-control:focus~main label[for=toc-control]{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}#toc-control:checked~main .book-header aside{display:block}body[dir=rtl] #menu-control:checked~main .book-menu .book-menu-content{transform:translateX(-16rem)}}@media screen and (min-width:80rem){.book-page,.book-menu .book-menu-content,.book-toc .book-toc-content{padding:2rem 1rem}}@font-face{font-family:roboto;font-style:normal;font-weight:400;font-display:swap;src:local(""),url(fonts/roboto-v27-latin-regular.woff2)format("woff2"),url(fonts/roboto-v27-latin-regular.woff)format("woff")}@font-face{font-family:roboto;font-style:normal;font-weight:700;font-display:swap;src:local(""),url(fonts/roboto-v27-latin-700.woff2)format("woff2"),url(fonts/roboto-v27-latin-700.woff)format("woff")}@font-face{font-family:roboto mono;font-style:normal;font-weight:400;font-display:swap;src:local(""),url(fonts/roboto-mono-v13-latin-regular.woff2)format("woff2"),url(fonts/roboto-mono-v13-latin-regular.woff)format("woff")}body{font-family:roboto,sans-serif}code{font-family:roboto mono,monospace}@media print{.book-menu,.book-footer,.book-toc{display:none}.book-header,.book-header aside{display:block}main{display:block!important}}.markdown{line-height:1.6}.markdown>:first-child{margin-top:0}.markdown h1,.markdown h2,.markdown h3,.markdown h4,.markdown h5,.markdown h6{font-weight:400;line-height:1;margin-top:1.5em;margin-bottom:1rem}.markdown h1 a.anchor,.markdown h2 a.anchor,.markdown h3 a.anchor,.markdown h4 a.anchor,.markdown h5 a.anchor,.markdown h6 a.anchor{opacity:0;font-size:.75em;vertical-align:middle;text-decoration:none}.markdown h1:hover a.anchor,.markdown h1 a.anchor:focus,.markdown h2:hover a.anchor,.markdown h2 a.anchor:focus,.markdown h3:hover a.anchor,.markdown h3 a.anchor:focus,.markdown h4:hover a.anchor,.markdown h4 a.anchor:focus,.markdown h5:hover a.anchor,.markdown h5 a.anchor:focus,.markdown h6:hover a.anchor,.markdown h6 a.anchor:focus{opacity:initial}.markdown h4,.markdown h5,.markdown h6{font-weight:bolder}.markdown h5{font-size:.875em}.markdown h6{font-size:.75em}.markdown b,.markdown optgroup,.markdown strong{font-weight:bolder}.markdown a{text-decoration:none}.markdown a:hover{text-decoration:underline}.markdown a:visited{color:var(--color-visited-link)}.markdown img{max-width:100%;height:auto}.markdown code{padding:0 .25rem;background:var(--gray-200);border-radius:.25rem;font-size:.875em}.markdown pre{padding:1rem;background:var(--gray-100);border-radius:.25rem;overflow-x:auto}.markdown pre code{padding:0;background:0 0}.markdown p{word-wrap:break-word}.markdown blockquote{margin:1rem 0;padding:.5rem 1rem .5rem .75rem;border-inline-start:.25rem solid var(--gray-200);border-radius:.25rem}.markdown blockquote :first-child{margin-top:0}.markdown blockquote :last-child{margin-bottom:0}.markdown table{overflow:auto;display:block;border-spacing:0;border-collapse:collapse;margin-top:1rem;margin-bottom:1rem}.markdown table tr th,.markdown table tr td{padding:.5rem 1rem;border:1px solid var(--gray-200)}.markdown table tr:nth-child(2n){background:var(--gray-100)}.markdown hr{height:1px;border:none;background:var(--gray-200)}.markdown ul,.markdown ol{padding-inline-start:2rem}.markdown dl dt{font-weight:bolder;margin-top:1rem}.markdown dl dd{margin-inline-start:0;margin-bottom:1rem}.markdown .highlight table tr td:nth-child(1) pre{margin:0;padding-inline-end:0}.markdown .highlight table tr td:nth-child(2) pre{margin:0;padding-inline-start:0}.markdown details{padding:1rem;border:1px solid var(--gray-200);border-radius:.25rem}.markdown details summary{line-height:1;padding:1rem;margin:-1rem;cursor:pointer}.markdown details[open] summary{margin-bottom:0}.markdown figure{margin:1rem 0}.markdown figure figcaption p{margin-top:0}.markdown-inner>:first-child{margin-top:0}.markdown-inner>:last-child{margin-bottom:0}.markdown .book-expand{margin-top:1rem;margin-bottom:1rem;border:1px solid var(--gray-200);border-radius:.25rem;overflow:hidden}.markdown .book-expand .book-expand-head{background:var(--gray-100);padding:.5rem 1rem;cursor:pointer}.markdown .book-expand .book-expand-content{display:none;padding:1rem}.markdown .book-expand input[type=checkbox]:checked+.book-expand-content{display:block}.markdown .book-tabs{margin-top:1rem;margin-bottom:1rem;border:1px solid var(--gray-200);border-radius:.25rem;overflow:hidden;display:flex;flex-wrap:wrap}.markdown .book-tabs label{display:inline-block;padding:.5rem 1rem;border-bottom:1px transparent;cursor:pointer}.markdown .book-tabs .book-tabs-content{order:999;width:100%;border-top:1px solid var(--gray-100);padding:1rem;display:none}.markdown .book-tabs input[type=radio]:checked+label{border-bottom:1px solid var(--color-link)}.markdown .book-tabs input[type=radio]:checked+label+.book-tabs-content{display:block}.markdown .book-tabs input[type=radio]:focus+label{outline-style:auto;outline-color:currentColor;outline-color:-webkit-focus-ring-color}.markdown .book-columns{margin-left:-1rem;margin-right:-1rem}.markdown .book-columns>div{margin:1rem 0;min-width:10rem;padding:0 1rem}.markdown a.book-btn{display:inline-block;font-size:.875rem;color:var(--color-link);line-height:2rem;padding:0 1rem;border:1px solid var(--color-link);border-radius:.25rem;cursor:pointer}.markdown a.book-btn:hover{text-decoration:none}.markdown .book-hint.info{border-color:#6bf;background-color:rgba(102,187,255,.1)}.markdown .book-hint.warning{border-color:#fd6;background-color:rgba(255,221,102,.1)}.markdown .book-hint.danger{border-color:#f66;background-color:rgba(255,102,102,.1)} \ No newline at end of file diff --git a/resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.json b/resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.json new file mode 100644 index 0000000..3af3b14 --- /dev/null +++ b/resources/_gen/assets/scss/book.scss_50fc8c04e12a2f59027287995557ceff.json @@ -0,0 +1 @@ +{"Target":"book.min.82c5dbd23447cee0b4c2aa3ed08ce0961faa40e1fa370eee4f8c9f02e0d46b5f.css","MediaType":"text/css","Data":{"Integrity":"sha256-gsXb0jRHzuC0wqo+0Izglh+qQOH6Nw7uT4yfAuDUa18="}} \ No newline at end of file diff --git a/static/ffl.png b/static/ffl.png new file mode 100644 index 0000000..d5dba95 Binary files /dev/null and b/static/ffl.png differ diff --git a/static/ffl.svg b/static/ffl.svg new file mode 100644 index 0000000..d60bf10 --- /dev/null +++ b/static/ffl.svg @@ -0,0 +1,184 @@ + +image/svg+xml + + + \ No newline at end of file diff --git a/themes/hugo-book/LICENSE b/themes/hugo-book/LICENSE new file mode 100644 index 0000000..e7a669a --- /dev/null +++ b/themes/hugo-book/LICENSE @@ -0,0 +1,20 @@ +The MIT License (MIT) + +Copyright (c) 2018 Alex Shpak + +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 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. diff --git a/themes/hugo-book/README.md b/themes/hugo-book/README.md new file mode 100644 index 0000000..3edbc5c --- /dev/null +++ b/themes/hugo-book/README.md @@ -0,0 +1,354 @@ +# Hugo Book Theme + +[![Hugo](https://img.shields.io/badge/hugo-0.68-blue.svg)](https://gohugo.io) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) +![Build with Hugo](https://github.com/alex-shpak/hugo-book/workflows/Build%20with%20Hugo/badge.svg) + +### [Hugo](https://gohugo.io) documentation theme as simple as plain book + +![Screenshot](https://github.com/alex-shpak/hugo-book/blob/master/images/screenshot.png) + +- [Features](#features) +- [Requirements](#requirements) +- [Installation](#installation) +- [Menu](#menu) +- [Blog](#blog) +- [Configuration](#configuration) +- [Shortcodes](#shortcodes) +- [Versioning](#versioning) +- [Contributing](#contributing) + +## Features + +- Clean simple design +- Light and Mobile-Friendly +- Multi-language support +- Customisable +- Zero initial configuration +- Handy shortcodes +- Comments support +- Simple blog and taxonomy +- Primary features work without JavaScript +- Dark Mode + +## Requirements + +- Hugo 0.68 or higher +- Hugo extended version, read more [here](https://gohugo.io/news/0.48-relnotes/) + +## Installation + +### Install as git submodule +Navigate to your hugo project root and run: + +``` +git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book +``` + +Then run hugo (or set `theme = "hugo-book"`/`theme: hugo-book` in configuration file) + +``` +hugo server --minify --theme hugo-book +``` + +### Install as hugo module + +You can also add this theme as a Hugo module instead of a git submodule. + +Start with initializing hugo modules, if not done yet: +``` +hugo mod init github.com/repo/path +``` + +Navigate to your hugo project root and add [module] section to your `config.toml`: + +```toml +[module] +[[module.imports]] +path = 'github.com/alex-shpak/hugo-book' +``` + +Then, to load/update the theme module and run hugo: + +```sh +hugo mod get -u +hugo server --minify +``` + +### Creating site from scratch + +Below is an example on how to create a new site from scratch: + +```sh +hugo new site mydocs; cd mydocs +git init +git submodule add https://github.com/alex-shpak/hugo-book themes/hugo-book +cp -R themes/hugo-book/exampleSite/content . +``` + +```sh +hugo server --minify --theme hugo-book +``` + +## Menu + +### File tree menu (default) + +By default, the theme will render pages from the `content/docs` section as a menu in a tree structure. +You can set `title` and `weight` in the front matter of pages to adjust the order and titles in the menu. + +### Leaf bundle menu (Deprecated) + +You can also use leaf bundle and the content of its `index.md` file as menu. +Given you have the following file structure: + +``` +├── content +│ ├── docs +│ │ ├── page-one.md +│ │ └── page-two.md +│ └── posts +│ ├── post-one.md +│ └── post-two.md +``` + +Create a file `content/menu/index.md` with the content: + +```md ++++ +headless = true ++++ + +- [Book Example]({{< relref "/docs/" >}}) + - [Page One]({{< relref "/docs/page-one" >}}) + - [Page Two]({{< relref "/docs/page-two" >}}) +- [Blog]({{< relref "/posts" >}}) +``` + +And Enable it by setting `BookMenuBundle: /menu` in Site configuration. + +- [Example menu](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/content/menu/index.md) +- [Example config file](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yaml) +- [Leaf bundles](https://gohugo.io/content-management/page-bundles/) + +## Blog + +A simple blog is supported in the section `posts`. +A blog is not the primary usecase of this theme, so it has only minimal features. + +## Configuration + +### Site Configuration + +There are a few configuration options that you can add to your `config.toml` file. +You can also see the `yaml` example [here](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yaml). + +```toml +# (Optional) Set Google Analytics if you use it to track your website. +# Always put it on the top of the configuration file, otherwise it won't work +googleAnalytics = "UA-XXXXXXXXX-X" + +# (Optional) If you provide a Disqus shortname, comments will be enabled on +# all pages. +disqusShortname = "my-site" + +# (Optional) Set this to true if you use capital letters in file names +disablePathToLower = true + +# (Optional) Set this to true to enable 'Last Modified by' date and git author +# information on 'doc' type pages. +enableGitInfo = true + +# (Optional) Theme is intended for documentation use, therefore it doesn't render taxonomy. +# You can remove related files with config below +disableKinds = ['taxonomy', 'taxonomyTerm'] + +[params] + # (Optional, default light) Sets color theme: light, dark or auto. + # Theme 'auto' switches between dark and light modes based on browser/os preferences + BookTheme = 'light' + + # (Optional, default true) Controls table of contents visibility on right side of pages. + # Start and end levels can be controlled with markup.tableOfContents setting. + # You can also specify this parameter per page in front matter. + BookToC = true + + # (Optional, default none) Set the path to a logo for the book. If the logo is + # /static/logo.png then the path would be 'logo.png' + BookLogo = 'logo.png' + + # (Optional, default none) Set leaf bundle to render as side menu + # When not specified file structure and weights will be used + BookMenuBundle = '/menu' + + # (Optional, default docs) Specify section of content to render as menu + # You can also set value to "*" to render all sections to menu + BookSection = 'docs' + + # Set source repository location. + # Used for 'Last Modified' and 'Edit this page' links. + BookRepo = 'https://github.com/alex-shpak/hugo-book' + + # Specifies commit portion of the link to the page's last modified commit hash for 'doc' page + # type. + # Required if 'BookRepo' param is set. + # Value used to construct a URL consisting of BookRepo/BookCommitPath/ + # Github uses 'commit', Bitbucket uses 'commits' + BookCommitPath = 'commit' + + # Enable 'Edit this page' links for 'doc' page type. + # Disabled by default. Uncomment to enable. Requires 'BookRepo' param. + # Path must point to the site directory. + BookEditPath = 'edit/master/exampleSite' + + # (Optional, default January 2, 2006) Configure the date format used on the pages + # - In git information + # - In blog posts + BookDateFormat = 'Jan 2, 2006' + + # (Optional, default true) Enables search function with flexsearch, + # Index is built on fly, therefore it might slowdown your website. + # Configuration for indexing can be adjusted in i18n folder per language. + BookSearch = true + + # (Optional, default true) Enables comments template on pages + # By default partials/docs/comments.html includes Disqus template + # See https://gohugo.io/content-management/comments/#configure-disqus + # Can be overwritten by same param in page frontmatter + BookComments = true + + # /!\ This is an experimental feature, might be removed or changed at any time + # (Optional, experimental, default false) Enables portable links and link checks in markdown pages. + # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode + # Theme will print warning if page referenced in markdown does not exists. + BookPortableLinks = true + + # /!\ This is an experimental feature, might be removed or changed at any time + # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use. + BookServiceWorker = true +``` + +### Multi-Language Support + +Theme supports Hugo's [multilingual mode](https://gohugo.io/content-management/multilingual/), just follow configuration guide there. You can also tweak search indexing configuration per language in `i18n` folder. + +### Page Configuration + +You can specify additional params in the front matter of individual pages: + +```toml +# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs' +type = 'docs' + +# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set) +weight = 10 + +# (Optional) Set to 'true' to mark page as flat section in file-tree menu (if BookMenuBundle not set) +bookFlatSection = false + +# (Optional) Set to hide nested sections or pages at that level. Works only with file-tree menu mode +bookCollapseSection = true + +# (Optional) Set true to hide page or section from side menu (if BookMenuBundle not set) +bookHidden = false + +# (Optional) Set 'false' to hide ToC from page +bookToC = true + +# (Optional) If you have enabled BookComments for the site, you can disable it for specific pages. +bookComments = true + +# (Optional) Set to 'false' to exclude page from search index. +bookSearchExclude = true +``` + +### Partials + +There are layout partials available for you to easily override components of the theme in `layouts/partials/`. + +In addition to this, there are several empty partials you can override to easily add/inject code. + +| Empty Partial | Placement | +| -------------------------------------------------- | ------------------------------------------- | +| `layouts/partials/docs/inject/head.html` | Before closing `` tag | +| `layouts/partials/docs/inject/body.html` | Before closing `` tag | +| `layouts/partials/docs/inject/footer.html` | After page footer content | +| `layouts/partials/docs/inject/menu-before.html` | At the beginning of `