summaryrefslogtreecommitdiff
path: root/docs/development/setting_up_a_gitlab_runner.md
diff options
context:
space:
mode:
authormarcin mikołajczak <git@mkljczk.pl>2023-12-22 14:34:30 +0100
committermarcin mikołajczak <git@mkljczk.pl>2023-12-22 14:34:30 +0100
commit6051715a990b7eb4379daec46d5ea0d63dce2c09 (patch)
treee53a6e689839a188e1dd8770e19135fb28bf8a0b /docs/development/setting_up_a_gitlab_runner.md
parent5846e7d5f6b91ab63270f2104543d874589d39ca (diff)
parent5f1d70736711275ac9f0c95e5ada4cb2f1a96e11 (diff)
downloadpleroma-6051715a990b7eb4379daec46d5ea0d63dce2c09.tar.gz
pleroma-6051715a990b7eb4379daec46d5ea0d63dce2c09.zip
Merge remote-tracking branch 'origin/develop' into instance_rules
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
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).