Skip to content

Commit

Permalink
Merge pull request #32 from hacklab-fi/more_pages
Browse files Browse the repository at this point in the history
new pages for services and websites, shuffled some things around
  • Loading branch information
tswfi authored Dec 11, 2023
2 parents 98f233c + 31c23ea commit af8381b
Show file tree
Hide file tree
Showing 21 changed files with 181 additions and 73 deletions.
9 changes: 9 additions & 0 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -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/)
38 changes: 27 additions & 11 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -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)
8 changes: 4 additions & 4 deletions src/matrix/general.md → src/matrix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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: <https://github.com/hifi/heisenbridge>
- Appservice-irc (run by others!): <https://github.com/matrix-org/matrix-appservice-irc/wiki>
- Telegram: [mautrix-telegram](telegram.md)
- Whatsapp: [mautrix-whatsapp](whatsapp.md)
- Facebook: [mautrix-facebook](facebook.md)
Expand Down
12 changes: 0 additions & 12 deletions src/readme.md

This file was deleted.

3 changes: 3 additions & 0 deletions src/services/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Services

Other services
5 changes: 5 additions & 0 deletions src/services/discourse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Discourse

Discourse is an open source Internet forum system.

<https://discourse.hacklab.fi/>
5 changes: 5 additions & 0 deletions src/services/jitsi.md
Original file line number Diff line number Diff line change
@@ -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.

<https://jitsi.hacklab.fi>
8 changes: 8 additions & 0 deletions src/services/mumble.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Mumble

Mumble is a free, open source, low latency, high quality voice chat application.

Documentation currently here:

<https://mumble.hacklab.fi/>

3 changes: 3 additions & 0 deletions src/services/peertube.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Peertube

Under construction, see <https://github.com/hacklab-fi/itinfra/issues/23>
3 changes: 3 additions & 0 deletions src/sysops/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Sysops

We have range of services and servers running all of this.
5 changes: 5 additions & 0 deletions src/sysops/dns.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions src/sysops/gcp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# GCP

Google Cloud Platform

We have mainly DNS running on Google Cloud Platform
7 changes: 7 additions & 0 deletions src/sysops/github.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Github

Github is used for quite a few things

<https://github.com/hacklab-fi>

Ask to join the organization and start making hacking on websites and this documentation!
7 changes: 7 additions & 0 deletions src/sysops/upcloud.md
Original file line number Diff line number Diff line change
@@ -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: <https://upcloud.com/signup/?promo=hacklab>

If you need access to the servers ask Sami Olmari or Tatu Wikman
Original file line number Diff line number Diff line change
@@ -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: <https://docs.mau.fi/bridges/index.html>
* mx-puppet-discord: <https://github.com/matrix-discord/mx-puppet-discord>
* appservice-slack: <https://matrix-appservice-slack.readthedocs.io/en/latest/getting_started/>
* heisenbridge: <https://github.com/hifi/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: <https://docs.mau.fi/bridges/index.html>
* mx-puppet-discord: <https://github.com/matrix-discord/mx-puppet-discord>
* appservice-slack: <https://matrix-appservice-slack.readthedocs.io/en/latest/getting_started/>
* heisenbridge: <https://github.com/hifi/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`.
3 changes: 3 additions & 0 deletions src/thanks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Thanks

Thanks to all the hackers that make this possible!!
3 changes: 3 additions & 0 deletions src/websites/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Websites

Hacklab.fi runs a few websites.
7 changes: 7 additions & 0 deletions src/websites/docs.hacklab.fi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# docs.hacklab.fi

This site generated with [mdBook](https://rust-lang.github.io/mdBook/)

## Repo

<https://github.com/hacklab-fi/itinfra>
11 changes: 11 additions & 0 deletions src/websites/hackab.fi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# hacklab.fi

The main site for Hacklabs <https://www.hacklab.fi>

Jekyll site in Github Pages.

## Repo

<https://github.com/hacklab-fi/hacklab-website>

Repo readme has more information on how to set up a local test site.
11 changes: 11 additions & 0 deletions src/websites/hsf.hacklab.fi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# hsf.hacklab.fi

Hacklab Summit Finland website

<https://hsf.hacklab.fi/>

Jekyll site on Github Pages

## Repo

<https://github.com/hacklab-fi/hsf-website>
9 changes: 9 additions & 0 deletions src/websites/robotit.hacklab.fi.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# robotit.hacklab.fi

Robots in Strömberg park

<https://robotit.hacklab.fi>

## Repo

<https://github.com/hacklab-fi/robotit>

0 comments on commit af8381b

Please sign in to comment.