summaryrefslogtreecommitdiff
path: root/docs/development/setting_up_a_gitlab_runner.md
diff options
context:
space:
mode:
authorHaelwenn (lanodan) Monnier <contact@hacktivis.me>2022-12-23 17:05:05 +0100
committerHaelwenn (lanodan) Monnier <contact@hacktivis.me>2022-12-23 17:05:05 +0100
commit7d68d64d633a8ba43965a6f93d22cb0ae76027e0 (patch)
tree6c00d45be1aa1fe63ffff71bc2153cdff34e104f /docs/development/setting_up_a_gitlab_runner.md
parentd8e326467c30b95c5164f6e29512057dce3c2077 (diff)
parent6bce88b9e7876d32ea9146a580454053f0ef3790 (diff)
downloadpleroma-7d68d64d633a8ba43965a6f93d22cb0ae76027e0.tar.gz
pleroma-7d68d64d633a8ba43965a6f93d22cb0ae76027e0.zip
Merge back 2.4.5
Diffstat (limited to 'docs/development/setting_up_a_gitlab_runner.md')
-rw-r--r--docs/development/setting_up_a_gitlab_runner.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/development/setting_up_a_gitlab_runner.md b/docs/development/setting_up_a_gitlab_runner.md
new file mode 100644
index 000000000..88beb82f2
--- /dev/null
+++ b/docs/development/setting_up_a_gitlab_runner.md
@@ -0,0 +1,9 @@
+# Setting up a Gitlab-runner
+
+When you push changes, a pipeline will start some automated jobs. These are done with so called [runners](https://docs.gitlab.com/runner/), services that run somewhere on a server and run these automated jobs. These jobs typically run tests and should pass. If not, you probably need to fix something.
+
+Generally, Pleroma provides a runner, so you don't need to set up your own. However, if for whatever reason you want to set up your own, here's some high level instructions.
+
+1. We use docker to run the jobs, so you should install that. For Debian, you need to allow non-free packages in the [source list](https://wiki.debian.org/SourcesList). Then you can install docker with `apt install docker-compose`.
+2. You can [install](https://docs.gitlab.com/runner/install/index.html) and [configure](https://docs.gitlab.com/runner/register/index.html) a Gitlab-runner. It's probably easiest to install from the packages, but there are other options as well.
+3. When registering the runner, you'll need some values. You can find them in the project under your own name. Choose "Settings", "CI/CD", and then expand "Runners". For executor you can choose "docker". For default image, you can use the image used in <https://git.pleroma.social/pleroma/pleroma/-/blob/develop/.gitlab-ci.yml#L1> (although it shouldn't matter much).