Skip to content

docs: working with http-proxy #970

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions frontend/docs/toc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ export default [
id: "why",
group: "Guide",
},
{
title: "Working behind a proxy",
id: "working-with-http-proxy",
group: "Guide",
},
{
"title": "FAQ",
"id": "faq",
Expand Down
42 changes: 42 additions & 0 deletions frontend/docs/working-with-http-proxy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
description: This guide explains how to use JSR behind an HTTP(s) proxy.
---

In some case you may need to use JSR behind an HTTP(s) proxy. This guide will
help you to configure your environment to use JSR behind a proxy.

## With `npm`, `yarn` or `pnpm`

Theses tools understand the `.npmrc` file, which is used to configure the proxy
settings.

> So we recommand to read the official documentation of npm Available
> [here](https://docs.npmjs.com/cli/v11/using-npm/config#https-proxy)

Example of `.npmrc` file:

```ini
proxy=http://proxy.example.com:8080
```

## With `deno`

It's use `HTTP_PROXY` and `HTTPS_PROXY` environment variables. For more
infromation we invite you to read the
[deno docs](https://docs.deno.com/runtime/reference/env_variables/#special-environment-variables)

```sh
export HTTP_PROXY=http://proxy.example.com:8080
export HTTPS_PROXY=http://proxy.example.com:8080
```

and then

```
deno install jsr:@luca/flag
```

## With `bun`

Sadly, bun doesn't support proxy settings yet. _Or it's not obvious how to do
it._
Loading