Update after migrating from GitLab to Forgejo
All checks were successful
/ test (push) Successful in 41s
All checks were successful
/ test (push) Successful in 41s
This commit is contained in:
parent
1d84438430
commit
eb7d402328
|
|
@ -41,10 +41,9 @@
|
|||
### Digital Infrastructure
|
||||
* [Email](digital/email.md)
|
||||
* [Expfloorer](digital/expfloorer.md)
|
||||
* [GitLab](digital/gitlab.md)
|
||||
* [Git](digital/forgejo.md)
|
||||
* [Residence record](digital/residencerecord.md)
|
||||
* [Evaluation record](digital/evaluationrecord.md)
|
||||
* [Forgejo](digital/forgejo.md)
|
||||
* [Grafana](digital/grafana.md)
|
||||
* [kanthaus.online](digital/kanthausonline.md)
|
||||
* [Local server](digital/server.md)
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@
|
|||
"noticeTpl":"More than {passed} years have passed since last update."
|
||||
},
|
||||
"edit-link": {
|
||||
"base": "https://gitlab.com/kanthaus/handbook/edit/master",
|
||||
"base": "https://git.kanthaus.online/kanthaus/kanthaus.online/_edit/master",
|
||||
"label": "Edit This Page"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,18 +1,37 @@
|
|||
# Forgejo
|
||||
# :clipboard: Git
|
||||
|
||||
We are in the process of migrating away from GitLab to a self-hosted Forgejo instance. This is a work in progress and this page documents the setup. For now, please continue to use [GitLab](gitlab.md) where our repositories are still hosted.
|
||||
We use Git to store mutable data. Our Git repositories are hosted with [Forgejo](https://forgejo.org). For immutable files we have a [Nextcloud](nextcloud.md).
|
||||
|
||||
## Instructions for users
|
||||
### What is Forgejo?
|
||||
Forgejo is basically a social network built on top of the [git technology](https://git-scm.com/book/en/v2/Getting-Started-Git-Basics) for version control. It is normally used for code, because it makes it easy to collaborate on common projects without breaking anything.
|
||||
|
||||
### Why did you decide to use this?
|
||||
- We want to help people learn things and appreciate technology!
|
||||
- Data that was put in git is extremely secure, because it's stored on multiple people's computers.
|
||||
- If multiple people work on the same file it's possible to tell who changed which exact character.
|
||||
- It's easy to put content from Forgejo onto our website.
|
||||
- Everybody becomes a webmaster. :)
|
||||
- The people who decided on this were already used to it... ;)
|
||||
|
||||
### What is stored where?
|
||||
So far we have the following repositories:
|
||||
- [kanthaus.online](https://git.kanthaus.online/kanthaus/kanthaus.online), where we store our website, [https://kanthaus.online/](https://kanthaus.online/).
|
||||
- [kanthaus-private](https://git.kanthaus.online/kanthaus/kanthaus-private), where we store our [residence record](residencerecord.md), internal meeting minutes, financial plans and other stuff that contains personal information. Everything of relevance that consists of text and has pieces of confidential data should be put here.
|
||||
- [kanthaus-public](https://git.kanthaus.online/kanthaus/kanthaus-public), which is publicly accessible as the name suggests. In this repository we do our task management via issues (which you can find [here](https://git.kanthaus.online/kanthaus/kanthaus-public/issues)). This is especially important for our [roadmap plannings](../social/roadmap.md). Other than that we have drafts, policies, signs, data on our water, electricity and gas usage and much more in here.
|
||||
- [kanthaus-ansible](https://git.kanthaus.online/kanthaus/kanthaus-ansible) is for keeping our server tidy. Nothing you need to worry about, except you're actually interested. In that case feel free to ask Matthias about it!
|
||||
- [handbook](https://git.kanthaus.online/kanthaus/handbook) is where this handbook is stored.
|
||||
- [expfloorer](https://gitlab.com/kanthaus/expfloorer) hosts a floorplan of Kanthaus.
|
||||
|
||||
### How to use it
|
||||
Go to https://git.kanthaus.online and log in with your Nextcloud account.
|
||||
You will be automatically added to the "Kanthaus" organization in which our repositories are stored:
|
||||
https://git.kanthaus.online/kanthaus
|
||||
|
||||
You can modify the files as you are used to from GitLab.
|
||||
You can modify the files there directly via your web browser.
|
||||
|
||||
### Cloning repositories on your machine
|
||||
|
||||
If you are working with local clones, you need to update those to point to Kanthaus Git instead of GitLab.
|
||||
If you are working with local clones, you need to update those to point to Kanthaus Git instead of GitLab (which we were using before Forgejo).
|
||||
|
||||
On the page of each repository, such as https://git.kanthaus.online/kanthaus/handbook, copy the clone URL you prefer.
|
||||
Then, in your local clone, run:
|
||||
|
|
@ -1,24 +0,0 @@
|
|||
# :clipboard: GitLab
|
||||
|
||||
We use GitLab to store mutable data. For immutable files we have a [Nextcloud](nextcloud.md)
|
||||
|
||||
### What is GitLab?
|
||||
GitLab is basically a social network built on top of the [git technology](https://git-scm.com/book/en/v2/Getting-Started-Git-Basics) for version control. It is normally used for code, because it makes it easy to collaborate on common projects without breaking anything.
|
||||
|
||||
### Why did you decide to use this?
|
||||
- We want to help people learn things and appreciate technology!
|
||||
- Data that was put in git is extremely secure, because it's stored on multiple people's computers.
|
||||
- If multiple people work on the same file it's possible to tell who changed which exact character.
|
||||
- It's easy to put content from GitLab onto our website.
|
||||
- Everybody becomes a webmaster. :)
|
||||
- The people who decided on this were already used to it... ;)
|
||||
|
||||
### What is stored where?
|
||||
So far we have the following repositories:
|
||||
- [kanthaus.online](https://gitlab.com/kanthaus/kanthaus.online), where we store our website, [https://kanthaus.online/](https://kanthaus.online/).
|
||||
- [kanthaus-private](https://gitlab.com/kanthaus/kanthaus-private), where we store our [residence record](residencerecord.md), internal meeting minutes, financial plans and other stuff that contains personal information. Everything of relevance that consists of text and has pieces of confidential data should be put here.
|
||||
- [kanthaus-public](https://gitlab.com/kanthaus/kanthaus-public), which is publicly accessible as the name suggests. In this repository we do our task management via issues (which you can find [here](https://gitlab.com/kanthaus/kanthaus-public/issues)). This is especially important for our [roadmap plannings](../social/roadmap.md). Other than that we have drafts, policies, signs, data on our water, electricity and gas usage and much more in here.
|
||||
- [kanthaus-ansible](https://gitlab.com/kanthaus/kanthaus-ansible) is for keeping our server tidy. Nothing you need to worry about, except you're actually interested. In that case feel free to ask Matthias about it!
|
||||
- [handbook](https://gitlab.com/kanthaus/handbook) is where this handbook is stored.
|
||||
- [expfloorer](https://gitlab.com/kanthaus/expfloorer) hosts a floorplan of Kanthaus.
|
||||
|
||||
26
handbook.md
26
handbook.md
|
|
@ -8,19 +8,17 @@ We use [HonKit](https://github.com/honkit/honkit) to build the handbook.
|
|||
|
||||
## :clap: How to contribute
|
||||
|
||||
The content is stored at [gitlab.com/kanthaus/handbook](https://gitlab.com/kanthaus/handbook).
|
||||
The content is stored at [git.kanthaus.online/kanthaus/handbook](https://git.kanthaus.online/kanthaus/handbook).
|
||||
|
||||
First, make sure you have access rights:
|
||||
* create an account at [gitlab.com](https://gitlab.com) if you don't already have one
|
||||
* ask someone in **#kanthaus** [slack](https://slackin.yunity.org) channel to give you the right permissions
|
||||
First, make sure you have access rights: you need a [NextCloud](./nextcloud.md) account part of the "Kanthaus" team.
|
||||
|
||||
Next, understand the two approaches you can take:
|
||||
1. edit directly in the GitLab interface
|
||||
1. edit directly in the web interface
|
||||
2. clone the git repository to your computer, make changes, then push them back
|
||||
|
||||
### :cloud: Editing in GitLab interface
|
||||
### :cloud: Editing in web interface
|
||||
|
||||
You can click the _EDIT THIS PAGE_ button at the top of any page, and it will take you to the appropriate page to edit on GitLab.
|
||||
You can click the _EDIT THIS PAGE_ button at the top of any page, and it will take you to the appropriate page to edit on Forgejo.
|
||||
|
||||
The content is written in markdown, if you are not familiar with markdown you can learn more about it at [markdownguide.org](https://www.markdownguide.org/).
|
||||
|
||||
|
|
@ -41,10 +39,10 @@ For this you will (probably) need to become familiar with:
|
|||
Firstly, clone the repository:
|
||||
|
||||
```
|
||||
git clone https://gitlab.com/kanthaus/handbook.git
|
||||
git clone https://git.kanthaus.online/kanthaus/handbook.git
|
||||
```
|
||||
|
||||
(note if you want to use ssh keys you'll need to use `git@gitlab.com:kanthaus/handbook.git` instead).
|
||||
(note if you want to use ssh keys you'll need to use `ssh://git@ssh.git.kanthaus.online:2222/kanthaus/handbook.git` instead).
|
||||
|
||||
You'll then have a directory called `handbook` wherever you ran the command. We need to enter the directory and install the dependencies:
|
||||
|
||||
|
|
@ -65,7 +63,7 @@ Now you can edit the content, I recommend using [visual studio code](https://cod
|
|||
|
||||
Any changes you make will trigger your browser to reload the new content!
|
||||
|
||||
Once you're happy with your changes, we need to commit them to the repository, and push them back to GitLab:
|
||||
Once you're happy with your changes, we need to commit them to the repository, and push them back to Forgejo:
|
||||
|
||||
```
|
||||
# tip: see which files you've added/changed
|
||||
|
|
@ -85,7 +83,7 @@ git diff --staged
|
|||
# note: make sure your commit message is informative!
|
||||
git commit -m "Clarified the handbook page"
|
||||
|
||||
# push the changes back to GitLab
|
||||
# push the changes back to Forgejo
|
||||
git push
|
||||
```
|
||||
|
||||
|
|
@ -95,7 +93,7 @@ When you next come to edit, you should make sure you have the latest changes fro
|
|||
other people too:
|
||||
|
||||
```
|
||||
# fetch changes from the remote GitLab server
|
||||
# fetch changes from the remote Forgejo server
|
||||
git pull
|
||||
```
|
||||
|
||||
|
|
@ -109,9 +107,9 @@ confusing.
|
|||
|
||||
## :car: Deployment
|
||||
|
||||
We use GitLab CI to build the gitbook, then rsync to deploy it to yuca.yunity.org where it is served at [handbook.kanthaus.online](https://handbook.kanthaus.online/).
|
||||
We use Forgejo actions to build the gitbook, then rsync to deploy it to yuca.yunity.org where it is served at [handbook.kanthaus.online](https://handbook.kanthaus.online/).
|
||||
|
||||
You can check the status or progress by viewing the [pipelines](https://gitlab.com/kanthaus/handbook/pipelines).
|
||||
You can check the status or progress by viewing the [actions](https://git.kanthaus.online/kanthaus/handbook/actions?workflow=ci.yaml&actor=0&status=0).
|
||||
|
||||
## :zap: Emojis
|
||||
|
||||
|
|
|
|||
|
|
@ -17,13 +17,13 @@
|
|||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+ssh://git@gitlab.com/kanthaus/handbook.git"
|
||||
"url": "git+ssh://git@ssh.git.kanthaus.online:2222/kanthaus/handbook.git"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "",
|
||||
"license": "ISC",
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/kanthaus/handbook/issues"
|
||||
"url": "https://git.kanthaus.online/kanthaus/handbook/issues"
|
||||
},
|
||||
"homepage": "https://gitlab.com/kanthaus/handbook#README"
|
||||
"homepage": "https://git.kanthaus.online/kanthaus/handbook#README"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ Every person that wants to stay for some days should be given an introductory ho
|
|||
|
||||
### Tour document
|
||||
|
||||
To achieve a more standardized way of relaying (and not forgetting) important information about living in Kanthaus, Doug created an accompanying [visiTour document](https://gitlab.com/kanthaus/kanthaus-public/blob/master/visiTour.md).
|
||||
To achieve a more standardized way of relaying (and not forgetting) important information about living in Kanthaus, Doug created an accompanying [visiTour document](https://cloud.kanthaus.online/apps/files/?dir=/kanthaus-public/social%20structure&openfile=364152).
|
||||
|
||||
### Handbook
|
||||
|
||||
|
|
|
|||
|
|
@ -54,11 +54,11 @@ the backbone of our network, connecting all Access Points and the central firewa
|
|||
|Managed Switch| k20 firewall switch| 192.168.178.9 | K20-B rack | TL-SG108E
|
||||
|Managed Switch| k22 trunk switch | 192.168.178.10 | K22-B stairs | GS108E v3
|
||||
| Switch | k20 trunk switch | - | K20-B Rack | | provides PoE for some AP's in K20
|
||||
| Server | `kanthaus-server` | 192.168.\*.2 | K20-0 hallway | Server, i5-2500K, 16GB Ram | file storage, nextcloud, foodsharing gitlab CI Server, housebus logging & time/sunset provider (see [Repo](https://gitlab.com/kanthaus/kanthaus-server-services/))
|
||||
| Server | `kanthaus-server` | 192.168.\*.2 | K20-0 hallway | Server, i5-2500K, 16GB Ram | file storage, nextcloud, foodsharing gitlab CI Server, housebus logging & time/sunset provider (see [Repo](https://git.kanthaus.online/kanthaus/kanthaus-server-services/))
|
||||
| Main water meter reader | `mainwatermeter` | 192.168.5.37 | K20 basement (former heating room) | ESP32-CAM | see [Water usage tracking](./water.html)
|
||||
| Warm water meter reader | `warmwatermeter` | 192.168.5.38 | K20 basement (rainwater room) | ESP32-CAM | see [Water usage tracking](./water.html)
|
||||
| Ventilation watcher | `ventilation` | 192.168.5.39 | K20 attic | ESP32-WROOM | see [docs](https://gitlab.com/kanthaus/ventilation-watcher)
|
||||
| K20 door | `k20-door` | 192.168.5.40 | K20 hallway | ESP32-CAM| see [docs](https://gitlab.com/kanthaus/door-esp32)
|
||||
| Ventilation watcher | `ventilation` | 192.168.5.39 | K20 attic | ESP32-WROOM | see [docs](https://git.kanthaus.online/kanthaus/ventilation-watcher)
|
||||
| K20 door | `k20-door` | 192.168.5.40 | K20 hallway | ESP32-CAM| see [docs](https://git.kanthaus.online/kanthaus/door-esp32)
|
||||
|
||||
## Firewall / Router
|
||||
central point of all subnets, routes between them
|
||||
|
|
@ -84,7 +84,7 @@ central point of all subnets, routes between them
|
|||
|
||||
## kanthaus-server
|
||||
- Most of the services are running inside a docker-compose setup
|
||||
- Repo: https://gitlab.com/kanthaus/kanthaus-server-services
|
||||
- Repo: https://git.kanthaus.online/kanthaus/kanthaus-server-services
|
||||
- in `/opt/kh-services`
|
||||
- checking state: `docker-compose ps`
|
||||
- starting everything: `docker-compose up -d`
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Also, ventilation piping is work-in-progress and will be extended as the house e
|
|||
|
||||
## Statistics
|
||||
|
||||
You can get some statistics about the ventilation system in [Grafana](../digital/grafana.html). Those statistics are pulled from the ventilation unit via [an ESP32 device communicating with it via Modbus](https://gitlab.com/kanthaus/ventilation-watcher).
|
||||
You can get some statistics about the ventilation system in [Grafana](../digital/grafana.html). Those statistics are pulled from the ventilation unit via [an ESP32 device communicating with it via Modbus](https://git.kanthaus.online/kanthaus/ventilation-watcher).
|
||||
|
||||
## Maintenance
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue