{"id":39845893,"url":"https://github.com/adrien-k/couloir","last_synced_at":"2026-01-18T13:36:07.124Z","repository":{"id":265220704,"uuid":"895224613","full_name":"adrien-k/couloir","owner":"adrien-k","description":"Temporarily expose a http local service to the Internet using your own server.","archived":false,"fork":false,"pushed_at":"2025-04-01T21:16:48.000Z","size":234,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-19T08:06:17.206Z","etag":null,"topics":["developer-tools","https-proxy","ngrok-alternative"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adrien-k.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-27T19:44:26.000Z","updated_at":"2025-04-01T21:16:49.000Z","dependencies_parsed_at":"2024-11-28T11:26:40.775Z","dependency_job_id":"a563f5e2-56ee-48a0-a6e5-f5befd278f2e","html_url":"https://github.com/adrien-k/couloir","commit_stats":null,"previous_names":["adrien-k/couloir"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/adrien-k/couloir","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrien-k%2Fcouloir","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrien-k%2Fcouloir/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrien-k%2Fcouloir/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrien-k%2Fcouloir/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adrien-k","download_url":"https://codeload.github.com/adrien-k/couloir/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adrien-k%2Fcouloir/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28536761,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-18T13:04:05.990Z","status":"ssl_error","status_checked_at":"2026-01-18T13:01:44.092Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["developer-tools","https-proxy","ngrok-alternative"],"created_at":"2026-01-18T13:36:06.867Z","updated_at":"2026-01-18T13:36:07.110Z","avatar_url":"https://github.com/adrien-k.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# couloir: simple http(s) tunneling\n\n```\n ______     ______     __  __     __         ______     __     ______\n/\\  ___\\   /\\  __ \\   /\\ \\/\\ \\   /\\ \\       /\\  __ \\   /\\ \\   /\\  == \\\n\\ \\ \\____  \\ \\ \\/\\ \\  \\ \\ \\_\\ \\  \\ \\ \\____  \\ \\ \\/\\ \\  \\ \\ \\  \\ \\  __\u003c\n \\ \\_____\\  \\ \\_____\\  \\ \\_____\\  \\ \\_____\\  \\ \\_____\\  \\ \\_\\  \\ \\_\\ \\_\\\n  \\/_____/   \\/_____/   \\/_____/   \\/_____/   \\/_____/   \\/_/   \\/_/ /_/\n```\n\nTemporarily expose a http local service to the Internet using your own server.\n\n- **Encrypted**: traffic in and out of the relay is encrypted with auto-generated TLS certificates.\n- **Self-contained**: does not require anything else to work (SSH, Nginx, Caddy, ...).\n- **No configuration**: works out-of-the-box. Can be adjusted through a few CLI options.\n- **Compatible with Websockets.**\n\n[Host it yourself](#self-host-your-relay) by running your own relay server or [use our public relay](#using-couloircloud).\n\nVisit https://couloir.cloud for more information!\n\n## Requirements\n\nNode 18.x or above.\n\n## Installation\n\nOn both the relay server and your local machine. Make sure both versions match.\n\n```\nnpm install -g couloir\n```\n\n## Using couloir.cloud\n\n1. Sign-in on https://couloir.cloud\n2. Copy your CLI token\n3. Configure your Couloir CLI\n\n```\ncouloir set relay-host couloir.cloud\ncouloir set cli-token \u003cyou CLI token\u003e\n```\n\n### On your **local** machine\n\n1. Start your local http server, for example on port 3000.\n2. Run the local Couloir proxy:\n\n```sh\ncouloir 3000\n```\n\n3. Open `https://\u003cyour subdomain\u003e.couloir.cloud`\n\n## Self-host your relay\n\n### On your **relay** machine (ex: a cheap VPS)\n\n1. Ensure **port 80**, for cert validation, and **port 443**, for relay traffic, are open and accessible from Internet.\n2. Configure your (sub)domain to point to your relay machine's IP. For example:\n\n```\n# VPS IP being 1.2.3.4:\n\nmydomain.com A 1.2.3.4\n*.mydomain.com A 1.2.3.4\n```\n\n3. Run the Couloir relay:\n\n```sh\ncouloir relay mydomain.com\n```\n\n### On your **local** machine\n\n1. Start your local http server, for example on port 3000.\n2. Run the local Couloir proxy:\n\n```sh\ncouloir 3000 --on mydomain.com\n```\n\n3. Open `https://couloir.mydomain.com`\n\n## Recipes\n\n### Custom Couloir subdomain\n\nYou may want to choose your own subdomain name instead of \"couloir\".\nThis will expose `bonjour.mydomain.com`:\n\n```sh\ncouloir 3000 --on mydomain.com --as bonjour\n```\n\n### Protect the Relay with a password\n\nYou may want to require a password to use your relay as a Couloir proxy.\n\n_Warning: using that option in combination with HTTP-only mode is not recommended as it results in the password\nbeing transmitted in clear over the TCP Socket._\n\n```sh\n# On the relay\ncouloir relay mydomain.com --password foobar\n\n# On your local machine\ncouloir 3000 --on mydomain.com --password foobar\n```\n\n### Persist your relay settings for shorter commands.\n\nOnce you have configured a Relay you can save its configuration to not repeat it on every new couloir.\n\n```sh\n# On your local machine\ncouloir set relay-host mydomain.com\ncouloir set password foobar\n```\n\nThen, you can simply open a couloir with:\n\n```sh\ncouloir 3000\n```\n\n### HTTP-only mode\n\nIn this mode, you only need the relay port to be accessible from Internet (80 by default in HTTP mode).\n\n```sh\n# On the relay\ncouloir relay mydomain.com --http\n\n# On your local machine\ncouloir 3000 --on mydomain.com --http\n```\n\n### Run the relay on a different port\n\nRun the relay service on a port different from 443. Note that unless you run in HTTP-only, the port 80 will\nstill be required for TLS cert validation.\n\nFor example, port 3000:\n\n```sh\n# On the relay\ncouloir relay mydomain.com --port 3000\n\n# On your local machine\ncouloir 3000 --on mydomain.com --relay-port 3000\n```\n\n### Override the host header passed to your local server\n\nThis is useful if your local server is expecting a Host like 127.0.0.1:3000. For example:\n\n```sh\n# On your local machine\ncouloir 3000 --on mydomain.com --override-host 127.0.0.1:3000\n```\n\n### Run the relay as a daemon with pm2\n\nInstall pm2 with `npm install -g pm2`.\n\nThen:\n\n```sh\npm2 start \"couloir relay mydomain.com\" --name couloir\npm2 save\n# To have the daemon run on boot. Follow instructions.\npm2 startup\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrien-k%2Fcouloir","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadrien-k%2Fcouloir","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadrien-k%2Fcouloir/lists"}