GenieFramework/Genie.jl

Add "base_url" option, to "up()" to lop off referrer route path sent in from proxy servers (e.g. nginx)?

Open

#663 opened on Aug 2, 2023

View on GitHub
 (7 comments) (0 reactions) (1 assignee)Julia (2,408 stars) (186 forks)batch import
feature requestgood-first-issuehelp wantednon-breaking

Description

Thanks for creating Genie!!! It is very nicely designed and full-featured.

I apologize in advance if this is already (better) handled another way, which I may have missed (maybe there are already parameters which can be passed through to HTTP.jl, or something?)

We have a setup whereby certain routes (handled by an nginx proxy server) can lead to ad-hoc services on cluster node routes (/node//). Users can, for example, get a slurm allocation to run a Jupyter Lab session. But the proxy server seems to pass the entire ref url path to the listener service. Jupyter Lab has a "base_url" config parameter to deal with this (Jupyter server not knowing anything about the added route path). The Pluto.jl folks were nice enough to add that to the "Pluto.run()" command. https://github.com/fonsp/Pluto.jl/issues/2225 https://github.com/fonsp/Pluto.jl/pull/2227/commits/22be5d042cd29c2259fe666504025db82f203b4d

Is this something which might makes sense to add?

I am considering using Genie to spin up on-demand interactive presentation pages, maybe from some base/stock/template web app. Thanks!

Contributor guide

Tech stack
None
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Knowledge of Genie.jlJulia basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue requests a `base url` option for the `up()` function to handle proxy server prefixes, similar to Pluto.jl (see https://github.com/fonsp/Pluto.jl/issues/2225 and PR 2227). The contributor should first understand the Pluto implementation by examining the referenced commit. Then, locate the `up()` function in the Genie.jl source code (likely in `src/Server.jl` or similar) and determine how to add a `base url` parameter that can strip the prefix from the referrer route path. Additionally, consider how this interacts with Genie's router and existing configuration options. The issue comments may contain further guidance.