Skip to content

ezproxy.md

Latest commit

 

History

History
60 lines (43 loc) · 2.31 KB

ezproxy.md

File metadata and controls

60 lines (43 loc) · 2.31 KB
Raw

EZproxy PDF Access

EZproxy support is opt-in and only affects paper attach-pdfs.

  1. Configure your institution's EZproxy. Two modes — pick one:

    Mode A — hostname rewriting (recommended). Most modern institutions rewrite the publisher host (e.g. Lehigh: www.nature.com → www-nature-com.ezproxy.lib.lehigh.edu). Set the EZproxy host suffix:

    research-hub config set ezproxy_host_suffix "ezproxy.lib.lehigh.edu"

    This is preferred: PDFs are fetched directly from the rewritten host with no /login?qurl= EZproxyCheckBack JavaScript interstitial (which a non-browser HTTP client cannot follow, so PDF downloads would otherwise fail). To find your suffix, click a publisher link from your library portal and read it off the rewritten address bar (everything after the first host label). With the ezproxy login popup you can skip this step — it auto-detects the suffix from your captured cookies after you sign in. (The --from-browser path below imports cookies using the suffix, so set it explicitly if you use that.)

    Mode B — login template (legacy fallback). Only if your institution does not support hostname rewriting. The template must contain {encoded_url}:

    research-hub config set ezproxy_url_template "https://login.example.edu/login?qurl={encoded_url}"

    If both are set, hostname rewriting takes priority.

  2. Capture your institutional session once. Either:

    research-hub ezproxy login                 # opens a browser — sign in, then close it

    Cookies save automatically every second while the window is open, so even an abrupt close keeps them. Or skip the popup and reuse a browser you are already signed into:

    research-hub ezproxy login --from-browser chrome   # imports cookies via rookiepy

    --from-browser needs the browser-auth extra (pip install 'research-hub-pipeline[browser-auth]'); rookiepy has no Python 3.14 wheel yet, so on 3.14 use the plain ezproxy login.

  3. Verify state:

    research-hub ezproxy status

  4. Re-run paper attach-pdfs. Paywalled publisher PDF URLs now try the proxy first and fall back to the direct URL on any proxy failure.

Cookies usually last 1-4 weeks before your institution requires re-login.