Gitlab-plugin: Need to document GitLab -> Jenkins authentication setup

Created on 14 Sep 2016  路  10Comments  路  Source: jenkinsci/gitlab-plugin

We need to document how to set up the optional authentication between GitLab and Jenkins for triggering jobs.

doc improvement

Most helpful comment

Note to self: the way to configure this is:

  1. Jenkins global configuration -> require authorization for /project endpoint
  2. Copy userid and API key for a Jenkins user who has authorization to run the job
  3. Create a webhook on GitLab to trigger the job, and use HTTP basic auth: http://user:apikey@gitlab/project/jobname

All 10 comments

Btw. we should start moving the documentation from the full-blown README where nobody finds what he's looking for to the wiki. There we can create pages for different use-cases which should make it easy to find the thing you are looking for.

I agree. I can try to work on that.

Maybe we should also add them screenshots to the documentation. IMHO it's easier to tell somebody what he needs to click or where he has to enter something if you show him a picture of the UI.

Note to self: the way to configure this is:

  1. Jenkins global configuration -> require authorization for /project endpoint
  2. Copy userid and API key for a Jenkins user who has authorization to run the job
  3. Create a webhook on GitLab to trigger the job, and use HTTP basic auth: http://user:apikey@gitlab/project/jobname

Great! The user:apikey was the missing configuration step which drove me nuts. Since I am just working on our internal documentation I could / would like to contribute to the wiki. I am nearly done with the doc, just needs English translation. Have you decided on the wiki pages already? Our use case is a Jenkins behind nginx reverse proxy, with authentication / without anonymous read permissions (no public projects), GitLab 8 (most recent).

@omehegan btw. with 59ee882b8d65dc58b29e0cf21c04be98df3b2496 I added the functionality to configure secret tokens per Jenkins job which then can be configured in the corresponding GitLab web hook in the Secret Token field.

I did some work on clarifying the documentation in PR #414. You might give that a read.

I should also look at https://github.com/jenkinsci/gitlab-plugin/issues/375#issuecomment-295761116 when updating this doc.

Not sure if this is a documentation issue or a bug:

https://gitlab.com/Ian-T-Price - this fails to connect

http://gitlab.com/Ian-T-Price - this works

Given that the first one is the correct URL and that HTTPS is becoming / has become the standard, then the first line should connect.

After 18 months, this is finally documented.

Was this page helpful?
0 / 5 - 0 ratings