library icon indicating copy to clipboard operation
library copied to clipboard

Docs should make clear an HTTPS clone URL required for customization repo config variable

Open palewire opened this issue 6 years ago • 2 comments

If I set CUSTOMIZATION_GIT_REPO to [email protected]:datadesk/library-customization.git and reboot my dyno I get:

2019-11-11T14:54:45.360804+00:00 heroku[web.1]: Starting process with command `./bin/install_customizations && npm run build && npm start`
2019-11-11T14:54:47.912752+00:00 app[web.1]: Checking for CUSTOMIZATION_GIT_REPO environment variable...
2019-11-11T14:54:47.912854+00:00 app[web.1]: Cloning custom repo...
2019-11-11T14:54:47.915816+00:00 app[web.1]: Cloning into 'custom'...
2019-11-11T14:54:47.991172+00:00 app[web.1]: Host key verification failed.
2019-11-11T14:54:47.991908+00:00 app[web.1]: fatal: Could not read from remote repository.
2019-11-11T14:54:47.991911+00:00 app[web.1]: 
2019-11-11T14:54:47.991913+00:00 app[web.1]: Please make sure you have the correct access rights
2019-11-11T14:54:47.991916+00:00 app[web.1]: and the repository exists.

If I switch it to the HTTPS version of https://github.com/datadesk/library-customization.git, it works fine.

The screenshot in the docs uses the HTTP version, but I would propose updating the text to make clear you must use HTTPS. The SSH link is the default on GitHub and, like me, I could imagine others thoughtlessly pasting it in.

palewire avatar Nov 11 '19 15:11 palewire

Thanks @palewire ! Just updated that information in the Library demo site instructions for deploying to Heroku and Google App Engine. Feel free to submit a PR to contribute documentation with anything else you find and you're welcome to add your name to the document contributors section for filing this issue 👍

maxine avatar Nov 11 '19 16:11 maxine

I also didn't see it mentioned anywhere that the customization git repo needs to be public, which in retrospect makes sense, but did confuse me early.

michaelpelletier avatar Mar 24 '20 15:03 michaelpelletier