From 31c23eaf3a52c3805c367f33682e4e344b8add43 Mon Sep 17 00:00:00 2001 From: Tatu Wikman Date: Mon, 11 Dec 2023 20:01:19 +0200 Subject: [PATCH] new pages for services and websites, shuffled some things around --- src/README.md | 9 ++ src/SUMMARY.md | 38 +++++--- src/matrix/{general.md => README.md} | 8 +- src/readme.md | 12 --- src/services/README.md | 3 + src/services/discourse.md | 5 + src/services/jitsi.md | 5 + src/services/mumble.md | 8 ++ src/services/peertube.md | 3 + src/sysops/README.md | 3 + src/sysops/dns.md | 5 + src/sysops/gcp.md | 5 + src/sysops/github.md | 7 ++ src/sysops/upcloud.md | 7 ++ .../server-admin-minutes.md} | 92 +++++++++---------- src/thanks.md | 3 + src/websites/README.md | 3 + src/websites/docs.hacklab.fi.md | 7 ++ src/websites/hackab.fi.md | 11 +++ src/websites/hsf.hacklab.fi.md | 11 +++ src/websites/robotit.hacklab.fi.md | 9 ++ 21 files changed, 181 insertions(+), 73 deletions(-) create mode 100644 src/README.md rename src/matrix/{general.md => README.md} (96%) delete mode 100644 src/readme.md create mode 100644 src/services/README.md create mode 100644 src/services/discourse.md create mode 100644 src/services/jitsi.md create mode 100644 src/services/mumble.md create mode 100644 src/services/peertube.md create mode 100644 src/sysops/README.md create mode 100644 src/sysops/dns.md create mode 100644 src/sysops/gcp.md create mode 100644 src/sysops/github.md create mode 100644 src/sysops/upcloud.md rename src/sysops/{general.md => upcloud/server-admin-minutes.md} (97%) create mode 100644 src/thanks.md create mode 100644 src/websites/README.md create mode 100644 src/websites/docs.hacklab.fi.md create mode 100644 src/websites/hackab.fi.md create mode 100644 src/websites/hsf.hacklab.fi.md create mode 100644 src/websites/robotit.hacklab.fi.md diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..d893c28 --- /dev/null +++ b/src/README.md @@ -0,0 +1,9 @@ +# Hacklab IT Infra documentation + +This site contains documentation for Hacklab IT services for both users and for sysops. + +Site is WIP and more information will be added as time permits. + +* [Websites](/websites/) +* [Services](/services/) +* [Sysops](./sysops/) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 9d22d59..6bacc80 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,14 +1,30 @@ # Summary -[Readme](./readme.md) +[Readme](./README.md) -- [Matrix](./matrix/general.md) - - [Discord](./matrix/discord.md) - - [Facebook](./matrix/facebook.md) - - [GMessages](./matrix/gmessages.md) - - [Signal](./matrix/signal.md) - - [Slack](./matrix/slack.md) - - [Telegram](./matrix/telegram.md) - - [Whatsapp](./matrix/whatsapp.md) - - [Hookshot](./matrix/hookshot.md) -- [Sysops](./sysops/general.md) +- [Websites](./websites/README.md) + - [hacklab.fi](./websites/hackab.fi.md) + - [docs.hacklab.fi](./websites/docs.hacklab.fi.md) + - [robotit.hacklab.fi](./websites/robotit.hacklab.fi.md) + - [hsf.hacklab.fi](./websites/hsf.hacklab.fi.md) +- [Services](./services/README.md) + - [Mumble](./services/mumble.md) + - [Discourse](./services/discourse.md) + - [Jitsi](./services/jitsi.md) + - [Matrix](./matrix/README.md) + - [Discord](./matrix/discord.md) + - [Facebook](./matrix/facebook.md) + - [GMessages](./matrix/gmessages.md) + - [Signal](./matrix/signal.md) + - [Slack](./matrix/slack.md) + - [Telegram](./matrix/telegram.md) + - [Whatsapp](./matrix/whatsapp.md) + - [Hookshot](./matrix/hookshot.md) + - [Peertube](./services/peertube.md) +- [Sysops](./sysops/README.md) + - [Upcloud](./sysops/upcloud.md) + - [Server admin minutes](./sysops/upcloud/server-admin-minutes.md) + - [Github](./sysops/github.md) + - [GCP](./sysops/gcp.md) + - [DNS](./sysops/dns.md) +- [Thanks](./thanks.md) \ No newline at end of file diff --git a/src/matrix/general.md b/src/matrix/README.md similarity index 96% rename from src/matrix/general.md rename to src/matrix/README.md index 5dcbd13..a7b1e18 100644 --- a/src/matrix/general.md +++ b/src/matrix/README.md @@ -2,7 +2,7 @@ ## What? -Matrix is versatile federated instant messaging protocol and we offer Matrix homeserver and services to Finnish hacklab members. +Matrix is versatile federated instant messaging protocol and we offer Matrix homeserver and services to Finnish hacklab members. Matrix also supports bridges, both puppeted and relaybot, to various other networks and systems, like IRC, Telegram, Whatsapp, SMS, etc for example. @@ -38,7 +38,7 @@ In Matrix usernames allways starts with `@` -sign, rooms an spaces with `#` -sig - Surf to [hacklab.fi Element login](https://chat.hacklab.fi/#/login) and select `Continue with Hacklab Finland Keycloak` - Your local Hacklab should have implemented Single Sign-On method that is used by our Matrix-server login-flow, if not, nag them hard ;) - after SSO-autorization figure an username and continue - + - Secondary method, eventually obsoleted: - Surf to [hacklab.fi Matrix user registration](https://matrix.hacklab.fi/register) website - Fill out your details @@ -68,8 +68,8 @@ Hacklab member using `hacklab.fi` homeserver, thus having MXID of `@user:hacklab Links to specific bridge instructions: - IRC: - - Heisenbridge: https://github.com/hifi/heisenbridge - - Appservice-irc (run by others!): https://github.com/matrix-org/matrix-appservice-irc/wiki + - Heisenbridge: + - Appservice-irc (run by others!): - Telegram: [mautrix-telegram](telegram.md) - Whatsapp: [mautrix-whatsapp](whatsapp.md) - Facebook: [mautrix-facebook](facebook.md) diff --git a/src/readme.md b/src/readme.md deleted file mode 100644 index fac76c8..0000000 --- a/src/readme.md +++ /dev/null @@ -1,12 +0,0 @@ -# Hacklab IT Infra documentation - -This site contains documentation for Hacklab IT services for both users and for sysops. - -Site is WIP and more information will be added as time permits. - -* [Matrix](/matrix/general.html) -* TODO: [DNS](/dns/general.html) -* TODO: [Websites](/websites/general.html) -* TODO: [Jitsi](/jitsi/general.html) -* TODO: [Discourse](/websites/general.html) -* [Sysops](/sysops/general.html) \ No newline at end of file diff --git a/src/services/README.md b/src/services/README.md new file mode 100644 index 0000000..938a4b9 --- /dev/null +++ b/src/services/README.md @@ -0,0 +1,3 @@ +# Services + +Other services \ No newline at end of file diff --git a/src/services/discourse.md b/src/services/discourse.md new file mode 100644 index 0000000..34d35c2 --- /dev/null +++ b/src/services/discourse.md @@ -0,0 +1,5 @@ +# Discourse + +Discourse is an open source Internet forum system. + + \ No newline at end of file diff --git a/src/services/jitsi.md b/src/services/jitsi.md new file mode 100644 index 0000000..a2edeed --- /dev/null +++ b/src/services/jitsi.md @@ -0,0 +1,5 @@ +# Jitsi + +Jitsi (from Bulgarian: жици — "wires") is a collection of free and open-source multiplatform voice (VoIP), video conferencing and instant messaging applications for the Web platform, Windows, Linux, macOS, iOS and Android. + + diff --git a/src/services/mumble.md b/src/services/mumble.md new file mode 100644 index 0000000..bfb0ac4 --- /dev/null +++ b/src/services/mumble.md @@ -0,0 +1,8 @@ +# Mumble + +Mumble is a free, open source, low latency, high quality voice chat application. + +Documentation currently here: + + + diff --git a/src/services/peertube.md b/src/services/peertube.md new file mode 100644 index 0000000..310045d --- /dev/null +++ b/src/services/peertube.md @@ -0,0 +1,3 @@ +# Peertube + +Under construction, see \ No newline at end of file diff --git a/src/sysops/README.md b/src/sysops/README.md new file mode 100644 index 0000000..6691520 --- /dev/null +++ b/src/sysops/README.md @@ -0,0 +1,3 @@ +# Sysops + +We have range of services and servers running all of this. \ No newline at end of file diff --git a/src/sysops/dns.md b/src/sysops/dns.md new file mode 100644 index 0000000..16736b7 --- /dev/null +++ b/src/sysops/dns.md @@ -0,0 +1,5 @@ +# DNS + +hacklab.fi zone lives in GCP Cloud DNS + +Sami Olmari and Tatu Wikman can help with setting up your city zone \ No newline at end of file diff --git a/src/sysops/gcp.md b/src/sysops/gcp.md new file mode 100644 index 0000000..863796c --- /dev/null +++ b/src/sysops/gcp.md @@ -0,0 +1,5 @@ +# GCP + +Google Cloud Platform + +We have mainly DNS running on Google Cloud Platform \ No newline at end of file diff --git a/src/sysops/github.md b/src/sysops/github.md new file mode 100644 index 0000000..823e622 --- /dev/null +++ b/src/sysops/github.md @@ -0,0 +1,7 @@ +# Github + +Github is used for quite a few things + + + +Ask to join the organization and start making hacking on websites and this documentation! \ No newline at end of file diff --git a/src/sysops/upcloud.md b/src/sysops/upcloud.md new file mode 100644 index 0000000..eb75058 --- /dev/null +++ b/src/sysops/upcloud.md @@ -0,0 +1,7 @@ +# Upcloud + +We have few servers running on upcloud (thanks, we love you <3 !!!) + +If you are considering using upcloud service, please you use this link to order: + +If you need access to the servers ask Sami Olmari or Tatu Wikman \ No newline at end of file diff --git a/src/sysops/general.md b/src/sysops/upcloud/server-admin-minutes.md similarity index 97% rename from src/sysops/general.md rename to src/sysops/upcloud/server-admin-minutes.md index 29469d1..c50c1c1 100644 --- a/src/sysops/general.md +++ b/src/sysops/upcloud/server-admin-minutes.md @@ -1,46 +1,46 @@ -# Creating new system user for daemons and bots etc - -We use /opt/ for base home folder for system users, give it nologin as shell, etc - -```bash -sudo useradd --shell /usr/sbin/nologin \ - --system --user-group \ - --create-home \ - --comment "Service longname" \ - --home-dir /opt/servicehomedir username -``` - -# Getting shell as system user for admin to do thing as the user - -```bash -sudo -Hu username /bin/bash -l -``` - -Same can be used to run psql on postgres user directly - -```bash -sudo -Hu postgres psql -``` - -# Software installations - -We've used apt repositories where possible and rest is "directly on the host" installations, following given documentation per bot or automaton, provides update instructions too - -Links to most of them: - -* mautrix-bridges: -* mx-puppet-discord: -* appservice-slack: -* heisenbridge: - -# SSH related - -We allow only publickey auth and user needs to belong into `ssh-user` group in order to connect into server with SSH - -SSH server related settings resides in `/etc/ssh/sshd_config.d/` "confd" directory, edit settings in files under that dir and **not** directly `/etc/ssh/sshd_config` file. Same goes for possible client settings (ssh_config.d/). - -# DNS resolving - -We run Bind9/named as resolving DNS-server to provide credible DNSSEC resolving and OCSP-stapling. - -If you need to define DNS-server to some service, use `localhost` or it's IP-variations `127.0.0.1` and `::1`. +# Creating new system user for daemons and bots etc + +We use /opt/ for base home folder for system users, give it nologin as shell, etc + +```bash +sudo useradd --shell /usr/sbin/nologin \ + --system --user-group \ + --create-home \ + --comment "Service longname" \ + --home-dir /opt/servicehomedir username +``` + +# Getting shell as system user for admin to do thing as the user + +```bash +sudo -Hu username /bin/bash -l +``` + +Same can be used to run psql on postgres user directly + +```bash +sudo -Hu postgres psql +``` + +# Software installations + +We've used apt repositories where possible and rest is "directly on the host" installations, following given documentation per bot or automaton, provides update instructions too + +Links to most of them: + +* mautrix-bridges: +* mx-puppet-discord: +* appservice-slack: +* heisenbridge: + +# SSH related + +We allow only publickey auth and user needs to belong into `ssh-user` group in order to connect into server with SSH + +SSH server related settings resides in `/etc/ssh/sshd_config.d/` "confd" directory, edit settings in files under that dir and **not** directly `/etc/ssh/sshd_config` file. Same goes for possible client settings (ssh_config.d/). + +# DNS resolving + +We run Bind9/named as resolving DNS-server to provide credible DNSSEC resolving and OCSP-stapling. + +If you need to define DNS-server to some service, use `localhost` or it's IP-variations `127.0.0.1` and `::1`. diff --git a/src/thanks.md b/src/thanks.md new file mode 100644 index 0000000..f3256ac --- /dev/null +++ b/src/thanks.md @@ -0,0 +1,3 @@ +# Thanks + +Thanks to all the hackers that make this possible!! \ No newline at end of file diff --git a/src/websites/README.md b/src/websites/README.md new file mode 100644 index 0000000..f80a050 --- /dev/null +++ b/src/websites/README.md @@ -0,0 +1,3 @@ +# Websites + +Hacklab.fi runs a few websites. \ No newline at end of file diff --git a/src/websites/docs.hacklab.fi.md b/src/websites/docs.hacklab.fi.md new file mode 100644 index 0000000..8d6e84f --- /dev/null +++ b/src/websites/docs.hacklab.fi.md @@ -0,0 +1,7 @@ +# docs.hacklab.fi + +This site generated with [mdBook](https://rust-lang.github.io/mdBook/) + +## Repo + + \ No newline at end of file diff --git a/src/websites/hackab.fi.md b/src/websites/hackab.fi.md new file mode 100644 index 0000000..1bb270f --- /dev/null +++ b/src/websites/hackab.fi.md @@ -0,0 +1,11 @@ +# hacklab.fi + +The main site for Hacklabs + +Jekyll site in Github Pages. + +## Repo + + + +Repo readme has more information on how to set up a local test site. \ No newline at end of file diff --git a/src/websites/hsf.hacklab.fi.md b/src/websites/hsf.hacklab.fi.md new file mode 100644 index 0000000..a95ea01 --- /dev/null +++ b/src/websites/hsf.hacklab.fi.md @@ -0,0 +1,11 @@ +# hsf.hacklab.fi + +Hacklab Summit Finland website + + + +Jekyll site on Github Pages + +## Repo + + \ No newline at end of file diff --git a/src/websites/robotit.hacklab.fi.md b/src/websites/robotit.hacklab.fi.md new file mode 100644 index 0000000..22d5dd2 --- /dev/null +++ b/src/websites/robotit.hacklab.fi.md @@ -0,0 +1,9 @@ +# robotit.hacklab.fi + +Robots in Strömberg park + + + +## Repo + + \ No newline at end of file