Skip to content

Commit af8381b

Browse files
tswfitswfi
authored
Merge pull request #32 from hacklab-fi/more_pages
new pages for services and websites, shuffled some things around
2 parents 98f233c + 31c23ea commit af8381b

21 files changed

+181
-73
lines changed

‎src/README.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Hacklab IT Infra documentation
2+
3+
This site contains documentation for Hacklab IT services for both users and for sysops.
4+
5+
Site is WIP and more information will be added as time permits.
6+
7+
* [Websites](/websites/)
8+
* [Services](/services/)
9+
* [Sysops](./sysops/)

‎src/SUMMARY.md

+27-11
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,30 @@
11
# Summary
22

3-
[Readme](./readme.md)
3+
[Readme](./README.md)
44

5-
- [Matrix](./matrix/general.md)
6-
- [Discord](./matrix/discord.md)
7-
- [Facebook](./matrix/facebook.md)
8-
- [GMessages](./matrix/gmessages.md)
9-
- [Signal](./matrix/signal.md)
10-
- [Slack](./matrix/slack.md)
11-
- [Telegram](./matrix/telegram.md)
12-
- [Whatsapp](./matrix/whatsapp.md)
13-
- [Hookshot](./matrix/hookshot.md)
14-
- [Sysops](./sysops/general.md)
5+
- [Websites](./websites/README.md)
6+
- [hacklab.fi](./websites/hackab.fi.md)
7+
- [docs.hacklab.fi](./websites/docs.hacklab.fi.md)
8+
- [robotit.hacklab.fi](./websites/robotit.hacklab.fi.md)
9+
- [hsf.hacklab.fi](./websites/hsf.hacklab.fi.md)
10+
- [Services](./services/README.md)
11+
- [Mumble](./services/mumble.md)
12+
- [Discourse](./services/discourse.md)
13+
- [Jitsi](./services/jitsi.md)
14+
- [Matrix](./matrix/README.md)
15+
- [Discord](./matrix/discord.md)
16+
- [Facebook](./matrix/facebook.md)
17+
- [GMessages](./matrix/gmessages.md)
18+
- [Signal](./matrix/signal.md)
19+
- [Slack](./matrix/slack.md)
20+
- [Telegram](./matrix/telegram.md)
21+
- [Whatsapp](./matrix/whatsapp.md)
22+
- [Hookshot](./matrix/hookshot.md)
23+
- [Peertube](./services/peertube.md)
24+
- [Sysops](./sysops/README.md)
25+
- [Upcloud](./sysops/upcloud.md)
26+
- [Server admin minutes](./sysops/upcloud/server-admin-minutes.md)
27+
- [Github](./sysops/github.md)
28+
- [GCP](./sysops/gcp.md)
29+
- [DNS](./sysops/dns.md)
30+
- [Thanks](./thanks.md)

‎src/matrix/general.md renamed to ‎src/matrix/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What?
44

5-
Matrix is versatile federated instant messaging protocol and we offer Matrix homeserver and services to Finnish hacklab members.
5+
Matrix is versatile federated instant messaging protocol and we offer Matrix homeserver and services to Finnish hacklab members.
66

77
Matrix also supports bridges, both puppeted and relaybot, to various other networks and systems, like IRC, Telegram, Whatsapp, SMS, etc for example.
88

@@ -38,7 +38,7 @@ In Matrix usernames allways starts with `@` -sign, rooms an spaces with `#` -sig
3838
- Surf to [hacklab.fi Element login](https://chat.hacklab.fi/#/login) and select `Continue with Hacklab Finland Keycloak`
3939
- Your local Hacklab should have implemented Single Sign-On method that is used by our Matrix-server login-flow, if not, nag them hard ;)
4040
- after SSO-autorization figure an username and continue
41-
41+
4242
- Secondary method, eventually obsoleted:
4343
- Surf to [hacklab.fi Matrix user registration](https://matrix.hacklab.fi/register) website
4444
- Fill out your details
@@ -68,8 +68,8 @@ Hacklab member using `hacklab.fi` homeserver, thus having MXID of `@user:hacklab
6868
Links to specific bridge instructions:
6969

7070
- IRC:
71-
- Heisenbridge: https://github.com/hifi/heisenbridge
72-
- Appservice-irc (run by others!): https://github.com/matrix-org/matrix-appservice-irc/wiki
71+
- Heisenbridge: <https://github.com/hifi/heisenbridge>
72+
- Appservice-irc (run by others!): <https://github.com/matrix-org/matrix-appservice-irc/wiki>
7373
- Telegram: [mautrix-telegram](telegram.md)
7474
- Whatsapp: [mautrix-whatsapp](whatsapp.md)
7575
- Facebook: [mautrix-facebook](facebook.md)

‎src/readme.md

-12
This file was deleted.

‎src/services/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Services
2+
3+
Other services

‎src/services/discourse.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Discourse
2+
3+
Discourse is an open source Internet forum system.
4+
5+
<https://discourse.hacklab.fi/>

‎src/services/jitsi.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Jitsi
2+
3+
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.
4+
5+
<https://jitsi.hacklab.fi>

‎src/services/mumble.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Mumble
2+
3+
Mumble is a free, open source, low latency, high quality voice chat application.
4+
5+
Documentation currently here:
6+
7+
<https://mumble.hacklab.fi/>
8+

‎src/services/peertube.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Peertube
2+
3+
Under construction, see <https://github.com/hacklab-fi/itinfra/issues/23>

‎src/sysops/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Sysops
2+
3+
We have range of services and servers running all of this.

‎src/sysops/dns.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# DNS
2+
3+
hacklab.fi zone lives in GCP Cloud DNS
4+
5+
Sami Olmari and Tatu Wikman can help with setting up your city zone

‎src/sysops/gcp.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# GCP
2+
3+
Google Cloud Platform
4+
5+
We have mainly DNS running on Google Cloud Platform

‎src/sysops/github.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Github
2+
3+
Github is used for quite a few things
4+
5+
<https://github.com/hacklab-fi>
6+
7+
Ask to join the organization and start making hacking on websites and this documentation!

‎src/sysops/upcloud.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Upcloud
2+
3+
We have few servers running on upcloud (thanks, we love you <3 !!!)
4+
5+
If you are considering using upcloud service, please you use this link to order: <https://upcloud.com/signup/?promo=hacklab>
6+
7+
If you need access to the servers ask Sami Olmari or Tatu Wikman

‎src/sysops/general.md renamed to ‎src/sysops/upcloud/server-admin-minutes.md

+46-46
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
1-
# Creating new system user for daemons and bots etc
2-
3-
We use /opt/ for base home folder for system users, give it nologin as shell, etc
4-
5-
```bash
6-
sudo useradd --shell /usr/sbin/nologin \
7-
--system --user-group \
8-
--create-home \
9-
--comment "Service longname" \
10-
--home-dir /opt/servicehomedir username
11-
```
12-
13-
# Getting shell as system user for admin to do thing as the user
14-
15-
```bash
16-
sudo -Hu username /bin/bash -l
17-
```
18-
19-
Same can be used to run psql on postgres user directly
20-
21-
```bash
22-
sudo -Hu postgres psql
23-
```
24-
25-
# Software installations
26-
27-
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
28-
29-
Links to most of them:
30-
31-
* mautrix-bridges: <https://docs.mau.fi/bridges/index.html>
32-
* mx-puppet-discord: <https://github.com/matrix-discord/mx-puppet-discord>
33-
* appservice-slack: <https://matrix-appservice-slack.readthedocs.io/en/latest/getting_started/>
34-
* heisenbridge: <https://github.com/hifi/heisenbridge>
35-
36-
# SSH related
37-
38-
We allow only publickey auth and user needs to belong into `ssh-user` group in order to connect into server with SSH
39-
40-
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/).
41-
42-
# DNS resolving
43-
44-
We run Bind9/named as resolving DNS-server to provide credible DNSSEC resolving and OCSP-stapling.
45-
46-
If you need to define DNS-server to some service, use `localhost` or it's IP-variations `127.0.0.1` and `::1`.
1+
# Creating new system user for daemons and bots etc
2+
3+
We use /opt/ for base home folder for system users, give it nologin as shell, etc
4+
5+
```bash
6+
sudo useradd --shell /usr/sbin/nologin \
7+
--system --user-group \
8+
--create-home \
9+
--comment "Service longname" \
10+
--home-dir /opt/servicehomedir username
11+
```
12+
13+
# Getting shell as system user for admin to do thing as the user
14+
15+
```bash
16+
sudo -Hu username /bin/bash -l
17+
```
18+
19+
Same can be used to run psql on postgres user directly
20+
21+
```bash
22+
sudo -Hu postgres psql
23+
```
24+
25+
# Software installations
26+
27+
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
28+
29+
Links to most of them:
30+
31+
* mautrix-bridges: <https://docs.mau.fi/bridges/index.html>
32+
* mx-puppet-discord: <https://github.com/matrix-discord/mx-puppet-discord>
33+
* appservice-slack: <https://matrix-appservice-slack.readthedocs.io/en/latest/getting_started/>
34+
* heisenbridge: <https://github.com/hifi/heisenbridge>
35+
36+
# SSH related
37+
38+
We allow only publickey auth and user needs to belong into `ssh-user` group in order to connect into server with SSH
39+
40+
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/).
41+
42+
# DNS resolving
43+
44+
We run Bind9/named as resolving DNS-server to provide credible DNSSEC resolving and OCSP-stapling.
45+
46+
If you need to define DNS-server to some service, use `localhost` or it's IP-variations `127.0.0.1` and `::1`.

‎src/thanks.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Thanks
2+
3+
Thanks to all the hackers that make this possible!!

‎src/websites/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Websites
2+
3+
Hacklab.fi runs a few websites.

‎src/websites/docs.hacklab.fi.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# docs.hacklab.fi
2+
3+
This site generated with [mdBook](https://rust-lang.github.io/mdBook/)
4+
5+
## Repo
6+
7+
<https://github.com/hacklab-fi/itinfra>

‎src/websites/hackab.fi.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# hacklab.fi
2+
3+
The main site for Hacklabs <https://www.hacklab.fi>
4+
5+
Jekyll site in Github Pages.
6+
7+
## Repo
8+
9+
<https://github.com/hacklab-fi/hacklab-website>
10+
11+
Repo readme has more information on how to set up a local test site.

‎src/websites/hsf.hacklab.fi.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# hsf.hacklab.fi
2+
3+
Hacklab Summit Finland website
4+
5+
<https://hsf.hacklab.fi/>
6+
7+
Jekyll site on Github Pages
8+
9+
## Repo
10+
11+
<https://github.com/hacklab-fi/hsf-website>

‎src/websites/robotit.hacklab.fi.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# robotit.hacklab.fi
2+
3+
Robots in Strömberg park
4+
5+
<https://robotit.hacklab.fi>
6+
7+
## Repo
8+
9+
<https://github.com/hacklab-fi/robotit>

0 commit comments

Comments
 (0)