Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

suggestion: Add docs for self-hosting #329

Open
ajhalili2006 opened this issue Apr 22, 2021 · 4 comments · May be fixed by #330
Open

suggestion: Add docs for self-hosting #329

ajhalili2006 opened this issue Apr 22, 2021 · 4 comments · May be fixed by #330

Comments

@ajhalili2006
Copy link

Currently at the time of writing, the pull.git.ci server is down. So I forked the repo into my org, configured config vars as per .env.example, deployed to Divio, and test if it's work.
Config chaos may happen for first-timers who want to self-host stuff. Maybe add comments in the example dotenv file and also add some docs for deploying your own instance of the app?

@wei
Copy link
Owner

wei commented Apr 22, 2021

pull.git.ci is up and working just fine. You probably just didn't use https:// as provided in the README. You can see it's working by going to https://pull.git.ci/check/wei/pull or https://github.com/issues?q=author%3Aapp%2Fpull and look at all the pull requests being worked on every second.

I agree some docs may be helpful. The easiest way is to run using docker

  1. fill in .env, just APP_ID and WEBHOOK_SECRET is required
  2. download the private key for your GitHub app to pk.pem or include it as environment variable PRIVATE_KEY
  3. docker-compose up

See:

pull/Dockerfile

Lines 14 to 19 in f5e10f6

####################
### Required ###
####################
APP_ID= \
WEBHOOK_SECRET= \
PRIVATE_KEY= \

If you don't want to use docker, but rather run the node app directly, you can set the full PRIVATE_KEY environment variable in addition to APP_ID and WEBHOOK_SECRET. The command to run is npm start.

Some platforms have issues with env vars with new lines so probot also takes base64 encoding of your private key as environment variable.

PR welcome after trying out these steps~

@ajhalili2006
Copy link
Author

Also how about webhooks? Should I point GitHub to https://mypullghapphere.io/webhook as per WEBHOOK_PATH config?(I don't need smee.io since I deploying my instance on an non-Heroku service, e.g. Divio, but since Divio/Railway supports Dockerfiles, let's assume the Heroku deployment path minus the Heroku CLI.)

@wei
Copy link
Owner

wei commented Apr 22, 2021

Yes

@ajhalili2006 ajhalili2006 linked a pull request Apr 23, 2021 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants
@wei @ajhalili2006 and others