Skip to content

Commit 43acb3b

Browse files
authored
add QoL features: tags, social embed, better search, improved toc (#29)
* mkdocs: add various quality of life features * add frontmatter, tags, fix links * fix excess newlines * tags.md: add comment on why it exists
1 parent d71d839 commit 43acb3b

27 files changed

+225
-43
lines changed

.github/workflows/ci.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,5 +25,5 @@ jobs:
2525
path: .cache
2626
restore-keys: |
2727
mkdocs-material-
28-
- run: pip install mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-awesome-pages-plugin mkdocs-callouts material-plausible-plugin mkdocs-glightbox mkdocs-redirects
28+
- run: pip install -r requirements.txt
2929
- run: mkdocs gh-deploy --force

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
site/
22
docs/.obsidian/workspace.json
33
docs/.obsidian/graph.json
4+
.cache/
5+
venv/

docs/hardware/aperture/about.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: About Aperture
3+
tags:
4+
- aperture
5+
- hardware
6+
---
7+
18
# About Aperture
29

310
Aperture is Redbrick's fleet of hardware that was installed in May 2022 by `distro`, `pints`, `skins`, `cawnj`, `ymacomp` and `arkues`.
@@ -6,9 +13,9 @@ It consists of:
613

714
- 3x Dell R6515 - [`glados`](glados.md), [`wheatley`](wheatley.md), [`chell`](chell.md)
815

9-
| CPU | RAM | Storage |
10-
|:-----------------------------------------:|:---------------------------------:|:--------------------------------:|
11-
| AMD 7302P 3GHz, 16C/32T, 128M, 155W, 3200 | 2x 16GB RDIMM, 3200MT/s Dual Rank | 4x 2TB SATA HDDs (hardware RAID) |
16+
| CPU | RAM | Storage |
17+
| ----------------------------------------- | --------------------------------- | -------------------------------- |
18+
| AMD 7302P 3GHz, 16C/32T, 128M, 155W, 3200 | 2x 16GB RDIMM, 3200MT/s Dual Rank | 4x 2TB SATA HDDs (hardware RAID) |
1219

1320
- 2x Ubiquiti USW Pro - `rivendell`, `isengard`
1421
- 1x Ubiquiti UDM Pro - `mordor`

docs/hardware/aperture/chell.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
title: Chell
3+
tags:
4+
- hardware
5+
- aperture
6+
- chell
7+
- details
8+
---
9+
110
# Chell
211

312
## Details

docs/hardware/aperture/glados.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
title: Glados
3+
tags:
4+
- hardware
5+
- aperture
6+
- glados
7+
- details
8+
---
9+
110
# Glados
211

312
## Details

docs/hardware/aperture/images.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
title: Images
3+
tags:
4+
- hardware
5+
- aperture
6+
- install
7+
- images
8+
---
9+
110
# Images
211

312
## Servers

docs/hardware/aperture/index.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
---
2+
title: Aperture
3+
tags:
4+
- aperture
5+
- details
6+
- getting-started
7+
---
8+
19
# Aperture
210

311
## What is Aperture?

docs/hardware/aperture/johnson.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
title: Johnson
3+
tags:
4+
- aperture
5+
- hardware
6+
- johnson
7+
- details
8+
---
9+
110
# Johnson
211

312
## Details

docs/hardware/aperture/wheatley.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
title: Wheatley
3+
tags:
4+
- aperture
5+
- hardware
6+
- wheatley
7+
- details
8+
---
9+
110
# Wheatley
211

312
## Details

docs/hardware/azazel.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
title: Azazel
3+
tags:
4+
- login-box
5+
- hardware
6+
- azazel
7+
- details
8+
- debian
9+
---
10+
111
# Azazel
212

313
## Details

docs/hardware/nix/hardcase.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
title: Hardcase
3+
tags:
4+
- nixos
5+
- hardware
6+
- details
7+
- hardcase
8+
---
9+
110
# Hardcase
211

312
## Details

docs/hardware/nix/icarus.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
title: Icarus
3+
tags:
4+
- nixos
5+
- hardware
6+
- icarus
7+
- daedalus
8+
- details
9+
---
10+
111
# Icarus
212

313
Daedalus and Icarus ~~are~~ were twins ~~and thus share documentation.~~

docs/hardware/nix/motherlode.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
---
2+
title: Motherlode
3+
tags:
4+
- nixos
5+
- hardware
6+
- motherlode
7+
- details
8+
- qemu
9+
- libvirt
10+
---
11+
112
# Motherlode
213

314
## Details

docs/hardware/paphos.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
---
2+
title: Paphos
3+
tags:
4+
- hardware
5+
- paphos
6+
- details
7+
- dns
8+
- bind
9+
- ubuntu
10+
---
11+
112
# Paphos
213

314
## Details

docs/hardware/pygmalion.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
title: Pygmalion
3+
tags:
4+
- login-box
5+
- hardware
6+
- pygmalion
7+
- ubuntu
8+
---
9+
110
# Pygmalion
211

312
## Details

docs/hardware/zeus.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
title: Zeus
3+
tags:
4+
- hardware
5+
- zeus
6+
- details
7+
- docker
8+
- ubuntu
9+
---
10+
111
# Zeus
212

313
## Details
@@ -21,5 +31,5 @@
2131
- [Admin API](../services/api.md) at: [api.redbrick.dcu.ie](https://api.redbrick.dcu.ie)
2232
- brickbot2
2333
- Secretary's email generator at: [generator.redbrick.dcu.ie](https://generator.redbrick.dcu.ie)
24-
- [CodiMD](../services/codimd.md) at: [md.redbrick.dcu.ie](https://md.redbrick.dcu.ie)
34+
- [CodiMD](../services/md.md) at: [md.redbrick.dcu.ie](https://md.redbrick.dcu.ie)
2535
- all of this is routed through [traefik](../services/traefik.md) as a reverse proxy

docs/services/api.md

+7
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: API
3+
tags:
4+
- services
5+
- api
6+
---
7+
18
# API
29

310
## Redbrick Administrator Web API

docs/services/bastion-vm.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
title: Bastion VM
3+
tags:
4+
- aperture
5+
- services
6+
- nomad
7+
- vm
8+
- ingress
9+
---
10+
111
# Bastion VM
212

313
This VM is an ephemeral machine that can be placed on any nomad client that has the qemu driver enabled.

docs/services/bind.md

+10
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
---
2+
title: Bind9
3+
tags:
4+
- services
5+
- dns
6+
author:
7+
- distro
8+
- ylmcc
9+
---
10+
111
# Bind9 - `distro`, `ylmcc`
212

313
Bind9 is our DNS provider. Currently it runs on [`paphos`](../hardware/paphos.md), but this may change in the near future.

docs/services/exposed.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
---
2+
title: Services Exposed to the Internet
3+
author:
4+
- wizzdom
5+
tags:
6+
- services
7+
- exposed
8+
---
9+
110
# Services Exposed to the Internet - `wizzdom`
211

312
Firstly, it's important to mention that Redbrick is currently split in 2 parts:
@@ -40,7 +49,7 @@ Firstly, it's important to mention that Redbrick is currently split in 2 parts:
4049
- [Wetty](servers.md#Logging%20in%20to%20Wetty) at: [wetty.redbrick.dcu.ie](https://wetty.redbrick.dcu.ie)
4150
- [Admin API](api.md) at: [api.redbrick.dcu.ie](https://api.redbrick.dcu.ie)
4251
- Secretary's email generator at: [generator.redbrick.dcu.ie](https://generator.redbrick.dcu.ie)
43-
- [CodiMD](codimd.md) at: [md.redbrick.dcu.ie](https://md.redbrick.dcu.ie)
52+
- [CodiMD](md.md) at: [md.redbrick.dcu.ie](https://md.redbrick.dcu.ie)
4453
- all of this is routed through [traefik](traefik.md) as a reverse proxy
4554
- [paphos](../hardware/paphos.md) - `136.206.15.53`
4655
- **OS**: Ubuntu 14.04 LTS

docs/services/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Here you will find a list of all the services Redbrick runs, along with some con
55
- [api](api.md)
66
- [bastion-vm](bastion-vm.md)
77
- [bind](bind.md)
8-
- [codimd](codimd.md)
8+
- [md](md.md)
99
- [consul](consul.md)
1010
- [gitea](gitea.md)
1111
- [irc](irc.md)

docs/services/irc.md

+12-32
Original file line numberDiff line numberDiff line change
@@ -2,64 +2,44 @@
22

33
## Redbrick InspIRCd
44

5-
In 2016/2017 we began work to move to InspIRCd. This was due to the complications in ircd-hybrid and how old it was.
6-
These complications stopped new netsocs joining us so we all agreed to move irc. $ 4 years later after multiple attempts
7-
we had not migrated. Until TCD decided to shutdown their server breaking the network.
5+
In 2016/2017 we began work to move to InspIRCd. This was due to the complications in ircd-hybrid and how old it was. These complications stopped new netsocs joining us so we all agreed to move irc. $ 4 years later after multiple attempts we had not migrated. Until TCD decided to shutdown their server breaking the network.
86

97
We run Inspircd v3 on Metharme. InspIRCd's docs can be found [here](https://docs.inspircd.org/) for configuration specifics.
108

11-
IRC is available at `irc.redbrick.dcu.ie` on port `6697`. SSL is required for connection, we do not support non-SSL.
9+
IRC is available at `irc.redbrick.dcu.ie` on port `6697`. SSL is required for connection, we do not support non-SSL. When connecting from a redbrick server a user will be automatically logged in. If connecting from an external server a user must pass their password on login.
1210

13-
When connecting from a redbrick server a user will be automatically logged in. If connecting from an external server a
14-
user must pass their password on login.
15-
16-
For the purpose of external peering of other servers the port `7001` is expose as well. Similarly to clients we only
17-
support SSL on this port.
11+
For the purpose of external peering of other servers the port `7001` is exposed as well. Similarly to clients we only support SSL on this port.
1812

1913
For docs on connecting and using an IRC client please refer to the [wiki](https://wiki.redbrick.dcu.ie/index.php/IRC).
2014

2115
## Installation
2216

23-
InspIRCd is installed with Nix. There is no Nix package for InspIRCd so we compile a specific git tag from source. See
24-
[Nix package](https://github.com/redbrick/nix-configs/tree/master/packages/inspircd) for details on how it is compiled.
25-
26-
Given we only support SSL and require LDAP, we need to enable both at compile time.
17+
InspIRCd is installed with Nix. There is no Nix package for InspIRCd so we compile a specific git tag from source. See [Nix package](https://github.com/redbrick/nix-configs/tree/master/packages/inspircd) for details on how it is compiled. Given we only support SSL and require LDAP, we need to enable both at compile time.
2718

2819
## Configuration
2920

30-
InspIRCd's configuration is in Nix [here](https://github.com/redbrick/nix-configs/blob/master/services/ircd/inspircd/conf.nix).
31-
This config will be converted to xml on disc.
21+
InspIRCd's configuration is in Nix [here](https://github.com/redbrick/nix-configs/blob/master/services/ircd/inspircd/conf.nix). This config will be converted to xml on disc.
3222

3323
### Important Configuration
3424

35-
_oper_ is a list of admin users on the irc server. Their `OPER` password will need to be manually hashed with
36-
`hmac-sha256`, and placed in a secret on the server to be read in by inspircd.
37-
38-
_ldapwhitelist_ is a list of cidr addresses that do no require authentication. The list consists of Redbrick public and
39-
private addresses as well as `oldsoc`.
40-
41-
_link_ is a list of all servers we peer with including the anope services server that runs on the same box.
25+
- _oper_ is a list of admin users on the irc server. Their `OPER` password will need to be manually hashed with `hmac-sha256`, and placed in a secret on the server to be read in by inspircd.
26+
- _ldapwhitelist_ is a list of cidr addresses that do no require authentication. The list consists of Redbrick public and private addresses as well as `oldsoc`.
27+
- _link_ is a list of all servers we peer with including the anope services server that runs on the same box.
4228

4329
### oldsoc.net
4430

45-
`oldsoc.net` is a server run by old TCD netsocers. All the users on it are the remaining TCD associates following the
46-
shutdown of TCD IRCd. This server is maintained by its own users and has explicit permission to join IRC without LDAP auth.
31+
`oldsoc.net` is a server run by old TCD netsocers. All the users on it are the remaining TCD associates following the shutdown of TCD IRCd. This server is maintained by its own users and has explicit permission to join IRC without LDAP auth.
4732

4833
## Anope
4934

50-
Redbrick runs Anope services for the entire network. As with
51-
[inspircd we compile](https://github.com/redbrick/nix-configs/tree/master/packages/inspircd) from source. Refer to anopes
52-
[github docs](https://github.com/anope/anope/tree/2.0/docs) for configuration specifics.
35+
Redbrick runs Anope services for the entire network. As with [inspircd we compile](https://github.com/redbrick/nix-configs/tree/master/packages/inspircd) from source. Refer to anopes [github docs](https://github.com/anope/anope/tree/2.0/docs) for configuration specifics.
5336

5437
Our current Anope is configured with standard mods of chanserv, nickserv and operserv. All config is in [here](https://github.com/redbrick/nix-configs/tree/master/services/ircd/anope/confs).
5538

5639
Anope stores all info in a custom db file on disk.
5740

5841
## Discord Bridge - `butlerx`
5942

60-
We run a [bridge](https://github.com/qaisjp/go-discord-irc) between the Redbrick Discord and irc. The configuration for
61-
this is [here](https://github.com/redbrick/nix-configs/tree/master/services/ircd/discord/conf.nix).
43+
We run a [bridge](https://github.com/qaisjp/go-discord-irc) between the Redbrick Discord and irc. The configuration for this is [here](https://github.com/redbrick/nix-configs/tree/master/services/ircd/discord/conf.nix).
6244

63-
The bridge adds all users from discord with the suffix `_d2` and all irc users appear as them self but tagged as a bot
64-
in discord. Not all discord channels are on IRC, the config above contains a mapping of irc channels to discord channels
65-
id's. This needs to be manually updated to add more channels.
45+
The bridge adds all users from discord with the suffix `_d2` and all irc users appear as them self but tagged as a bot in discord. Not all discord channels are on IRC, the config above contains a mapping of irc channels to discord channels id's. This needs to be manually updated to add more channels.

docs/services/socs.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Socs Using Redbrick Infrastructure
22

33
- MPS/DCUfm - [`icecast`](icecast.md)
4-
- MPS/TheCollegeView - https://thecollegeview.ie - `wordpress`
5-
- DCU Style - https://thelookonline.dcu.ie - `wordpress`
6-
- DCU Solar Racing - https://solarracing.ie
7-
-
4+
- MPS/TheCollegeView - [TheCollegeView](https://thecollegeview.ie) - `wordpress`
5+
- DCU Style - [The Look](https://thelookonline.dcu.ie) - `wordpress`
6+
- DCU Solar Racing - [Solarracing.ie](https://solarracing.ie)

docs/stylesheets/extra.css

+12
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,15 @@
99
[data-md-color-scheme="slate"] * {
1010
--md-typeset-a-color: #d62e2e;
1111
}
12+
13+
@keyframes logo {
14+
0%, 40%, 80%, 100% {
15+
transform: scale(1);
16+
}
17+
20%, 60% {
18+
transform: scale(1.5);
19+
}
20+
}
21+
.md-logo {
22+
animation: logo 1000ms 1;
23+
}

docs/tags.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
2+
<!--Do not remove this file-->
3+
<!--This is required for mkdocs to generate a tags page-->

0 commit comments

Comments
 (0)