[MRG] Make the URL used to generate launch badges configurable #859
Conversation
betatim
changed the title
| @@ -15,6 +15,7 @@ class MainHandler(BaseHandler): | |||
| def get(self): | |||
| self.render_template( | |||
| "index.html", | |||
| badge_base_url=self.settings['badge_base_url'], | |||
There was a problem hiding this comment.
| badge_base_url=self.settings['badge_base_url'], | |
| badge_base_url=self.settings['badge_base_url'] or | |
| f"{self.request.protocol}://{self.request.host}{self.settings['base_url']}", |
maybe this is better. so you can remove if elses in js code and it becomes cleaner.
There was a problem hiding this comment.
I am not sure which one I prefer. I agree the JS has a few extra if statements, but I think I prefer it that way because it leaves the choice to the JS code. I dunno, it is just a feeling :-/
|
This looks great to me - the one thing that's missing is any documentation about this feature 📚 . I guess it would show up here: https://binderhub.readthedocs.io/en/latest/reference/app.html maybe that's enough? |
|
Nods that is where you'd find an entry. We could write a short how to section on setting up a federation? I think that is the only context in which you'd want to use this feature. |
|
@betatim just to double check are you planning on putting off the docs for this for another PR? (in which case I can open an issue about it so we don't forget) |
|
It should appear automatically in the reference section of the docs (preview). Not sure any other documentation needs writing. I'd make writing "howto setup a federation" a new issue as that will require a bit of thinking (for example what redirector should people use). |
|
then thanks for the contribution @betatim ! |
This lets you set the base URL used for generating badges. This is useful when you have a group of hubs at different hostnames but want badges generated on all of them to point to a common hostname. I think we should use this for operating the GKE and OVH cluster as a federation so that all clusters generate https://mybinder.org/ badges and launch URLs.