Can't setup github integration on a sentry onpremise installation #12670

bellini666 · 2019-04-06T20:24:54Z

Important Details

How are you running Sentry?

[ x ] On-Premise docker [Version 9.1]
Saas (sentry.io)
Other [briefly describe your environment]

Description

Tried to setup github integration but nothing happened.

Steps to Reproduce

Go to the organization's Integrations settings
Click on github's Install button. A new window will be opened inside the github marketplace
Add the application to the organization in github
Go back to the sentry integration settings page
See that nothing happened

What you expected to happen

The repository should be linked

Possible Solution

I think it actually linked to the sentry.io installation, which created an account for me. That's not what I want.

The text was updated successfully, but these errors were encountered:

markstory · 2019-04-08T14:02:36Z

The github integration requires the creation of a github-app, and a number of configuration options to be set. The options that need to be set can be found here and can be setup in you sentry.yaml file.

bellini666 · 2019-04-08T14:13:03Z

@markstory thanks for pointing me in the right direction.

Probably there's a doc missing explaining how to do that.

dotconnor · 2019-04-11T06:39:14Z

@markstory What urls are needed for auth and webhook?

Edit:
Found through test files that the webhook url is /extensions/github/webhook/, still looking for the auth callback though

markstory · 2019-04-11T13:58:53Z

The auth callback is /extensions/github/setup/

arizz96 · 2019-04-17T15:17:55Z

Any news here?

markstory · 2019-04-17T15:50:19Z

@arizz96 What kind of news are you looking for?

arizz96 · 2019-04-17T16:03:02Z

@markstory I've encountered this issue and I'm trying to solve it.
I setup the github-app but the activation link brought me to sentry.io.

Can you please help me on that?

dotconnor · 2019-04-17T16:32:45Z

@arizz96 Here is what I did to set mine up:

This only enables Github App Integrations and not Github SSO

Create a new github app:
Set the following values:

Setting	Value
Homepage URL	${urlPrefix}
User authorization callback URL	${urlPrefix}/extensions/github/setup/
Setup URL (optional)	${urlPrefix}/extensions/github/setup/
Webhook URL	${urlPrefix}/extensions/github/webhook/
Webhook secret (optional)	${webhookSecret}

Create a private key and download it, replace all newlines with \n to ensure correct format in config.yml
Add the following options to your config.yml

Not sure which ones are required, but I pulled all of these from the code.

github.apps-install-url: ${urlPrefix}/extensions/github/setup/
github.integration-app-id: ${githubAppId}
github.integration-hook-secret: ${webhookSecret}
github.integration-private-key: "${privateKey}"
github-app.id: ${githubAppId}
github-app.name: ${githubAppName}
github-app.webhook-secret: ${webhookSecret}
github-app.private-key: "${privateKey}"
github-app.client-id: ${githubAppClientId}
github-app.client-secret: ${githubAppClientSecret}

Run docker-compose build && docker-compose run --rm web upgrade && docker-compose up -d to rebuild your installation with the new settings.
Go to ${urlPrefix}/settings/${organization}/integrations/
Remove your github integration is already added
Install github integration

PS: This should be written down somewhere not in a github issue

markstory · 2019-04-17T19:23:09Z

If anyone has the time on-premise docs can be found here

dotconnor · 2019-04-17T19:29:52Z

@markstory I'll work on it, but should I include a full guide or just list the different configuration options?

markstory · 2019-04-18T13:04:44Z

Some context on how to get the integration configured is probably a good start.

chinskiy · 2019-04-19T14:21:01Z

@dotconnor guide works for me. Thanks!
Just 1 comment what can save time for someone(because I spent half the day on it)
private-key must be in format

github-app.private-key: "-----BEGIN RSA PRIVATE KEY-----\n<PRIVATE KEY LINE 1>\n....\n<PRIVATE KEY LINE N>\n-----END RSA PRIVATE KEY-----"

dotconnor · 2019-04-19T14:44:36Z

@chinskiy I included removing the newlines with \n above and in the docs here: getsentry/sentry-docs@529d793#diff-55a17b3c7313e07c55f9777ef6553e1eR35

bellini666 · 2019-04-20T15:57:03Z

I'm following the setup guide described in the issue, I just have one question: What permissions should I give to the app? It's not described anywhere

bellini666 · 2019-04-20T16:24:38Z

Also, I don't know if that is elated to my permissions question, but after installing the integration, when I try to add a repository, nothing happens.

dotconnor · 2019-04-20T16:42:21Z

If you already have the official sentry app installed, you can look there for the permissions.

…

On Apr 20, 2019, at 12:25 PM, Thiago Bellini Ribeiro ***@***.***> wrote: Also, I don't know if that is elated to my permissions question, but after installing the integration, when I try to add a repository, nothing happens. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

bellini666 · 2019-04-20T18:31:02Z

Also, I don't know if that is elated to my permissions question, but after installing the integration, when I try to add a repository, nothing happens.

Regarding to this, this error is appearing in my internal project: https://sentry.zerosoft.com.br/share/issue/0e8459945c744d6a811002beb9cf43c5/

I think I have given all the required permissions to the app as the repositories appear just fine. The issue happen when I click to add one of them

dotconnor · 2019-04-20T18:37:13Z

@bellini666 You need the following permissions:

Permission	Setting
Repository administration	Read-only
Repository contents	Read-only
Issues	Read & write
Pull requests	Read & write
Repository webhooks	Read & write

I subscribed to all events

After you update the permissions and even if you don't, remove your github integration and then re-add it, you should be able to add repos then

bellini666 · 2019-04-20T18:41:28Z

@dotconnor thanks, that solved my issue :)

Probably those permissions should also be added to the documentation IMO

markstory · 2019-04-23T18:59:12Z

Closing as the documentation guide should be live soon. Thanks everyone who helped out with this 👏

riker09 · 2019-06-26T08:33:30Z

With the help of this guide I was able to get the GitHub integration working on my on-premises Sentry installation. Thank you!

But I cannot figure out how to turn on SSO via GitHub. Judging from the integration documentation this should be possible?

I have created a custom Sentry Docker image with my sentry.conf.py and config.yml and this requirements.txt file:

git+https://github.com/getsentry/sentry-auth-github.git@master#egg=sentry-auth-github

I can see "GitHub" listed as SSO provider in "Oorganization Settings" > "Auth", but clicking on "configure" results in a 404 at GitHub. This is the URL:

https://github.com/login/oauth/authorize?scope=user%3Aemail%2Cread%3Aorg%2Crepo&state=abcdef0123456789abcdef0123456789&redirect_uri=https%3A%2F%2Fsentry.mydomain.com%2Fauth%2Fsso%2F&response_type=code&client_id="MyGitHubAppId"

When I remove the quotes around MyGitHubAppId I am redirected to my Sentry installation and see an Invalid request. error on the top of the page. In my log I can see

"GET /extensions/github/setup/?error=redirect_uri_mismatch&error_description=The+redirect_uri+MUST+match+the+registered+callback+URL+for+this+application.&error_uri=https%3A%2F%2Fdeveloper.github.com%2Fapps%2Fmanaging-oauth-apps%2Ftroubleshooting-authorization-request-errors%2F%23redirect-uri-mismatch&state=abcdef0123456789abcdef0123456789 HTTP/1.1" 302 392 "-" "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:67.0) Gecko/20100101 Firefox/67.0"

I believe that I am very close at solving it and I bet it is some stupic configuration mistake that I have made. Any help would be greatly appreciated.

riker09 · 2019-06-26T09:07:45Z

I have managed to get one step further by changing the value of "User authorization callback URL" to https://sentry.mydomain.com/auth/sso/ in my GitHub App. (Got that idea from this issue).

Now my Sentry installation wants me to select an Organization from a drop down list, which is empty. 😕

riker09 · 2019-06-26T12:56:27Z

Okay, I got it working, but the last piece of the puzzle is still unclear.

There were two changes that might be responsible:

I have added GITHUB_ORGANIZATION=MyOrgName to sentry.env when starting the container. Or in other words, I have added this environment variable to the Sentry web (worker, cron) nodes. I couldn't find any mention of this variable in the official sentry.conf.py, though.
I have added the "Organization members" and "Organization administration" permission to the GitHub App. A colleague has received an email from GitHub that mentioned the added permissions. He then did something to the App but couldn't exactly recall what is was. But somewhere along the way he added the App to our GitHub Organization. I strongly believe that this is what actually did the trick. In any case this should be far better documented. Maybe with some screenshot.

omgitsbillryan · 2019-07-02T15:07:14Z

The doc claims that github-app.webhook-secret is optional, but if you don't set one in your GH App, then Sentry will return a HTTP-400 w/ the message:

github.webhook.missing-signature

When no webhook secret is configured in GH, then the webhook requests will not include the X-Hub-Signature header, and Sentry considers this header to be required, not optional.

riker09 · 2019-07-03T07:11:00Z

So you're saying in reality it was the missing webhook and the documentation is (slightly) wrong? Is there an issue for that, yet?

inversion · 2019-11-27T12:18:07Z

For anyone else struggling, make sure you have both of:

SENTRY_OPTIONS['github.integration-private-key']
SENTRY_OPTIONS['github-app.private-key']

set to the correct private key. I found it easiest to pass an environment variable with the private key containing literal newlines (unescaped) base64 encoded, then use:

# sentry.conf.py
import base64
SENTRY_OPTIONS['github.integration-private-key'] =  base64.b64decode(env('SENTRY_GITHUB_APP_PRIVATE_KEY'))
SENTRY_OPTIONS['github-app.private-key'] =  SENTRY_OPTIONS['github.integration-private-key']

and ensure there is no reference to the private key in ENV_CONFIG_MAPPING.

ahmedspiir · 2019-11-28T13:30:11Z

@inversion It didn't work for me!
I tried with and without a newline and i was able to print the value in my configmap

    SENTRY_OPTIONS['github.integration-private-key'] = base64.b64decode(env('SENTRY_GITHUB_APP_PRIVATE_KEY'))
    SENTRY_OPTIONS['github-app.private-key'] = base64.b64decode(env('SENTRY_GITHUB_APP_PRIVATE_KEY'))
    print(SENTRY_OPTIONS['github.integration-private-key'])
    print('value of '+SENTRY_OPTIONS['github-app.private-key'])

But with this i kept getting the same exception that it Could not deserialize key data.

inversion · 2019-11-28T16:53:47Z

@ahmedspiir it should look exactly like this (randomly generated) key, without leading blank lines or trailing newlines:

bellini666 changed the title ~~Can't setu github integration on a sentry onpremise installation~~ Can't setup github integration on a sentry onpremise installation Apr 6, 2019

markstory closed this as completed Apr 23, 2019

markstory mentioned this issue Apr 23, 2019

add github integration options to onpremise configuration getsentry/sentry-docs#906

Merged

rics3n mentioned this issue Apr 26, 2019

ValueError on installation of Github Integration #12953

Closed

2 tasks

isaachui mentioned this issue Jun 6, 2019

Update github integration documentation with private key tip getsentry/sentry-docs#1045

Merged

DustinChaloupka mentioned this issue Oct 11, 2019

Update README with steps to configure Github SSO getsentry/sentry-auth-github#27

Merged

BYK mentioned this issue Nov 20, 2019

Unable to configure GitHub integration / associate identity getsentry/sentry-plugins#449

Closed

jakana-rbx mentioned this issue Apr 22, 2020

GitHub Integration: Unable to install GitHub Integration #18335

Closed

matthias-hoste mentioned this issue May 30, 2020

GitHub Integration: wont finish installation #19101

Closed

github-actions bot locked and limited conversation to collaborators Dec 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Can't setup github integration on a sentry onpremise installation #12670

Can't setup github integration on a sentry onpremise installation #12670

bellini666 commented Apr 6, 2019

markstory commented Apr 8, 2019

bellini666 commented Apr 8, 2019

dotconnor commented Apr 11, 2019 •

edited

Loading

markstory commented Apr 11, 2019

arizz96 commented Apr 17, 2019

markstory commented Apr 17, 2019

arizz96 commented Apr 17, 2019 •

edited

Loading

dotconnor commented Apr 17, 2019

markstory commented Apr 17, 2019

dotconnor commented Apr 17, 2019

markstory commented Apr 18, 2019

chinskiy commented Apr 19, 2019 •

edited

Loading

dotconnor commented Apr 19, 2019

bellini666 commented Apr 20, 2019

bellini666 commented Apr 20, 2019

dotconnor commented Apr 20, 2019 via email

bellini666 commented Apr 20, 2019

dotconnor commented Apr 20, 2019

bellini666 commented Apr 20, 2019

markstory commented Apr 23, 2019

riker09 commented Jun 26, 2019

riker09 commented Jun 26, 2019

riker09 commented Jun 26, 2019

omgitsbillryan commented Jul 2, 2019

riker09 commented Jul 3, 2019

inversion commented Nov 27, 2019

ahmedspiir commented Nov 28, 2019

inversion commented Nov 28, 2019

Can't setup github integration on a sentry onpremise installation #12670

Can't setup github integration on a sentry onpremise installation #12670

Comments

bellini666 commented Apr 6, 2019

Important Details

Description

Steps to Reproduce

What you expected to happen

Possible Solution

markstory commented Apr 8, 2019

bellini666 commented Apr 8, 2019

dotconnor commented Apr 11, 2019 • edited Loading

markstory commented Apr 11, 2019

arizz96 commented Apr 17, 2019

markstory commented Apr 17, 2019

arizz96 commented Apr 17, 2019 • edited Loading

dotconnor commented Apr 17, 2019

markstory commented Apr 17, 2019

dotconnor commented Apr 17, 2019

markstory commented Apr 18, 2019

chinskiy commented Apr 19, 2019 • edited Loading

dotconnor commented Apr 19, 2019

bellini666 commented Apr 20, 2019

bellini666 commented Apr 20, 2019

dotconnor commented Apr 20, 2019 via email

bellini666 commented Apr 20, 2019

dotconnor commented Apr 20, 2019

bellini666 commented Apr 20, 2019

markstory commented Apr 23, 2019

riker09 commented Jun 26, 2019

riker09 commented Jun 26, 2019

riker09 commented Jun 26, 2019

omgitsbillryan commented Jul 2, 2019

riker09 commented Jul 3, 2019

inversion commented Nov 27, 2019

ahmedspiir commented Nov 28, 2019

inversion commented Nov 28, 2019

dotconnor commented Apr 11, 2019 •

edited

Loading

arizz96 commented Apr 17, 2019 •

edited

Loading

chinskiy commented Apr 19, 2019 •

edited

Loading