{"id":15043976,"url":"https://github.com/testingbot/testingbot-tunnel-launcher","last_synced_at":"2025-12-12T00:49:27.439Z","repository":{"id":37933392,"uuid":"44693671","full_name":"testingbot/testingbot-tunnel-launcher","owner":"testingbot","description":"NodeJS module to launch and configure the TestingBot.com tunnel","archived":false,"fork":false,"pushed_at":"2024-12-18T13:51:34.000Z","size":191,"stargazers_count":7,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-26T05:32:53.811Z","etag":null,"topics":["selenium","selenium-webdriver","testingbot","webdriverio"],"latest_commit_sha":null,"homepage":"https://testingbot.com/support/tunnel","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/testingbot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2015-10-21T17:44:09.000Z","updated_at":"2024-12-18T13:49:54.000Z","dependencies_parsed_at":"2024-06-18T21:28:12.209Z","dependency_job_id":"d7327b83-cdde-4b55-93a5-85e4f7a89965","html_url":"https://github.com/testingbot/testingbot-tunnel-launcher","commit_stats":{"total_commits":82,"total_committers":8,"mean_commits":10.25,"dds":0.5975609756097561,"last_synced_commit":"3e5e42a2f34232d4fff6ec36bfddafc83897d3a2"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Ftestingbot-tunnel-launcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Ftestingbot-tunnel-launcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Ftestingbot-tunnel-launcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/testingbot%2Ftestingbot-tunnel-launcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/testingbot","download_url":"https://codeload.github.com/testingbot/testingbot-tunnel-launcher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237843857,"owners_count":19375217,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["selenium","selenium-webdriver","testingbot","webdriverio"],"created_at":"2024-09-24T20:49:54.218Z","updated_at":"2025-12-12T00:49:27.431Z","avatar_url":"https://github.com/testingbot.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# testingbot-tunnel-launcher\n\n[![npm](https://img.shields.io/npm/v/testingbot-tunnel-launcher.svg?maxAge=2592000)](https://www.npmjs.com/package/testingbot-tunnel-launcher)\n[![Tests](https://github.com/testingbot/testingbot-tunnel-launcher/actions/workflows/test.yml/badge.svg)](https://github.com/testingbot/testingbot-tunnel-launcher/actions/workflows/test.yml)\n\nA library to download and launch [TestingBot Tunnel](https://testingbot.com/support/tunnel).\n\n## Installation\n\n```sh\nnpm install testingbot-tunnel-launcher\n```\n\n## Usage\n\n\n### Simple Usage\n\n```javascript\nconst testingbotTunnel = require('testingbot-tunnel-launcher');\n\ntestingbotTunnel({\n  apiKey: process.env.TB_KEY,\n  apiSecret: process.env.TB_SECRET,\n  verbose: true\n}, function (err, tunnel) {\n  if (err) {\n    console.error(err.message);\n    return;\n  }\n  console.log(\"Tunnel ready\");\n\n  tunnel.close(function () {\n    console.log(\"Tunnel closed completely\");\n  })\n});\n```\n\n### Advanced Usage\n\n```javascript\n\nconst testingbotTunnel = require('testingbot-tunnel-launcher')\nconst options = {\n  // The TestingBot API key which you can get for free, listed in the TestingBot member area\n  apiKey: 'key',\n\n  // The TestingBot API secret which you can get for free, listed in the TestingBot member area\n  apiSecret: 'secret',\n\n  // More verbose output from the tunnel\n  verbose: true,\n\n  // Port on which the tunnel Selenium relay will listen for\n  // requests. Default 4445. (optional)\n  se-port: null,\n\n  // Proxy host and port the tunnel can use to connect to an upstream proxy\n  // e.g. \"localhost:1234\" (optional)\n  proxy: null,\n\n  // a comma-separated list of domains that\n  // will not go through the tunnel. (optional)\n  fast-fail-regexps: null,\n\n  // Write logging output to this logfile (optional)\n  logfile: null,\n\n  // Change the tunnel version - see versions on https://testingbot.com/support/other/tunnel/changelog.html\n  tunnelVersion: \"4.0\",\n\n  // Gives this tunnel a unique identifier\n  tunnelIdentifier: \"myIdentifier\"\n};\n\ntestingbotTunnel(options, function(err, tunnel) {\n  console.log(\"Started Tunnel\");\n  tunnel.close(function () {\n    console.log(\"Closed tunnel\");\n  });\n});\n\n```\n\n### Credentials\n\nYou can pass the [TestingBot credentials](https://testingbot.com/members) as `apiKey` and `apiSecret` in the options.\n\nYou can also create a `~/.testingbot` file in your `$HOME` directory, with `apiKey:apiSecret` as contents.\n\n\n## Testing\n\n```\nnpm test\n```\n\n## MIT license\n\nCopyright (c) TestingBot \u0026lt;info@testingbot.com\u0026gt;","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestingbot%2Ftestingbot-tunnel-launcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftestingbot%2Ftestingbot-tunnel-launcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftestingbot%2Ftestingbot-tunnel-launcher/lists"}