[{"_1":2,"_172":-5,"_173":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_151":152},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_83":84,"_106":107,"_144":-5,"_145":11,"_146":17,"_147":11,"_148":-5,"_149":150},"canonicalUrl","https://hub.docker.com/r/gridlastic/docker-gridc/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","gridlastic","reponame","docker-gridc","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_37":38,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":50,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":69,"_74":11,"_75":76,"_80":28,"_81":82},"categories",[],"content_types",[39],"image","date_registered","2020-06-28T14:10:57.173345Z","description","Gridlastic Connect Tunnel Client","is_private","last_updated","2021-03-03T23:53:39.292747Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[51],"application/vnd.docker.container.image.v1+json","name","pull_count",371,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Gridlastic Connect Tunnel Client (gridc)\nSecurely connect your private [Gridlastic][gridlastic] selenium grid to your test environment. Test web sites on localhost using http or https (no need to deploy a ssl certificate) and https sites via TCP. Access your selenium grid hub via localhost.\n\n\n## Features\n\n * **Small**: Built using [Alpine][alpine], about 20mb in size.\n * **Simple**: Use environment variables to start encrypted tunnels to your local/remote/docker test environment in seconds.\n * **Secure**: Tunnel endpoints accessible only by your private Gridlastic selenium grid nodes. Runs as non-root user with a random UID `6838` (to avoid mapping to an existing UID).\n\n## Quick demo start for Docker Desktop MAC/Windows\n\n $ docker run --rm -it -p 3030:3030 --name running-gridc -e GRIDC_ENDPOINT_SUBDOMAIN= -e GRIDC_USERNAME= -e GRIDC_ACCESS_KEY= -e GRIDC_PROTOCOL=https -e GRIDC_SUBDOMAIN=hostmachine-hello-world -e GRIDC_ADDR_DOMAIN=host.docker.internal -e GRIDC_ADDR_PORT=8001 -e GRIDC_API=3030 gridlastic/docker-gridc\n\nThe above docker command can be copied pre-filled with credentials from your Gridlastic dashboard after grid launch. The credentials `GRIDC_ENDPOINT_SUBDOMAIN`, `GRIDC_USERNAME` and `GRIDC_ACCESS_KEY` are all available after launch of your Gridlastic selenium grid. On the host machine, creates a tunnel to a Docker container site (existing or not) on `host.docker.internal:8001`. If you have a site active on `host.docker.internal:8001` you can run tests to it or start a site on port `8001` like\n\n $ docker run --rm -p 8001:80 --detach --name test-gridc-site gridlastic/docker-hello-world\n\nTo tunnel to the test site use this in your selenium test code:\n\n $ driver().get(\"https://hostmachine-hello-world..gridlastic.com:8091\");\n \n\nUse the client [Rest API][gridlastic-connect-api] to dynamically create more tunnels or get active tunnels like:\n\n```\nhttp://localhost:3030/api/tunnels\n```\nNOTE: this example is using Docker so if you have a local non Docker site you need to [download and install the native gridc client][gridlastic-connect] in order to reach it because the gridc client can only reach sites that the machine/container it was deployed on can reach.\n\n## Environment variables\n\nConfigure your tunnel via environment variables (via `-e`):\n\n * `GRIDC_ENDPOINT_SUBDOMAIN` - Gridlastic Connect subdomain (different from your selenium grid hub subdomain), see your Gridlastic dashboard after you launched your grid. \n * `GRIDC_USERNAME` - Gridlastic username, see your Gridlastic dashboard after you launched your grid. \n * `GRIDC_ACCESS_KEY` - Gridlastic access key, see your Gridlastic dashboard after you launched your grid. \n * `GRIDC_PROTOCOL` - Can be `https`, `http` or `tcp`. If set to `tcp`, Gridlastic Connect will allocate a port instead of a subdomain and proxy TCP requests directly to your application. Endpoint access for `https` is on port `8091` and for `http` port `8090`\n * `GRIDC_SUBDOMAIN` - Is used to create the endpoint for your selenium grid nodes. Must be unique (real time) per selenium grid and a valid single DNS string (no dots and 3-63 characters) to avoid tunnel name conflicts. Subdomains are associated with protocol `http` and `https`. If not specified a random value is assigned by the server. \n * `GRIDC_ADDR_DOMAIN` - host.docker.internal or container name.\n * `GRIDC_ADDR_PORT` - Port of service to tunnel to, like `80`\n * `GRIDC_HUB` - Port to tunnel to your Gridlastic selenium grid hub, like `4444`. Optional.\n * `GRIDC_API` - Activates client [Rest API][gridlastic-connect-api] on port, like `3030`. Optional.\n * `GRIDC_START_CONFIG_TUNNELS` - If set to `all` starts all defined tunnels in the configuration file. Specify individual tunnels for selective starts like `-e \"GRIDC_START_CONFIG_TUNNELS=tunnel-1 tunnel-2\"`. Note: special behavior with `GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX`\n * `GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX` - Use this variable to create unique subdomain endpoints. If empty defaults to `$HOSTNAME` (container ID) when used with `GRIDC_START_CONFIG_TUNNELS`. Tip: start the container(s) from your test runner with your own unique subdomain prefix that you can use in your selenium tests.\n\n\n## EXAMPLES\n\n## Start an additional gridc/tunnel container linking to the docker-hello-world container above, accessing the site on internal container port 80\n\n\nIf you have an web service running in a container named `test-gridc-site` listening on internal container port 80:\n\n $ docker run --rm -it --link test-gridc-site --name running-gridc-linked-to-test-site -e GRIDC_ENDPOINT_SUBDOMAIN= -e GRIDC_USERNAME= -e GRIDC_ACCESS_KEY= -e GRIDC_PROTOCOL=https -e GRIDC_SUBDOMAIN=container-hello-world -e GRIDC_ADDR_DOMAIN=test-gridc-site -e GRIDC_ADDR_PORT=80 gridlastic/docker-gridc\n\nIn your selenium code you access the tunnel like:\n\n\n $ driver().get(\"https://container-hello-world..gridlastic.com:8091\");\n\n\n## Use a custom gridc configuration file\n\nReplace the `config-template.cfg` file with your own. All environmental variables are substituted automatically upon container start using `envsubst` so you can also add your own variables.\n\n $ docker run --rm -it -v /local/path/to/custom-config-template.cfg:/home/gridc/config-template.cfg -e GRIDC_ENDPOINT_SUBDOMAIN= -e GRIDC_USERNAME= -e GRIDC_ACCESS_KEY= -e GRIDC_START_CONFIG_TUNNELS=all gridlastic/docker-gridc\n\n\n\nExample `custom-config-template.cfg`\n\n```\nserver_addr: ${GRIDC_ENDPOINT_SUBDOMAIN}.gridlastic.com:443\nhttp_proxy:\nusername:\npassword:\ntunnels:\n hostmachine_port_8001:\n subdomain: ${GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX}-hostmachine-8001\n proto:\n https: host.docker.internal:8001\n```\n\nNote that the line `server_addr: ${GRIDC_ENDPOINT_SUBDOMAIN}.gridlastic.com:443` must always be present in any custom config file and is the only line in the default `config-template.cfg`. The variable `GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX` has special behavior when used with `GRIDC_START_CONFIG_TUNNELS`, see environmental variables. Also, you can provide the credentials in the config file although we recommend you use environment variables. http_proxy can be used to reach Gridlastic via a corporate proxy. An alternative to creating tunnels using a configuration file is to use the [Rest API][gridlastic-connect-api]. \n\n\n\n## Start TCP tunnel to a local https site\n\n\n $ docker run --rm -it -e GRIDC_ENDPOINT_SUBDOMAIN= -e GRIDC_USERNAME= -e GRIDC_ACCESS_KEY= -e GRIDC_PROTOCOL=tcp -e GRIDC_ADDR_DOMAIN=host.docker.internal -e GRIDC_ADDR_PORT=443 gridlastic/docker-gridc\n\nTCP endpoints do not have subdomains but are issued a random port between `9000-9999` by the server. To tunnel to the test site use this in your selenium test code:\n\n $ driver().get(\"https://.gridlastic.com:9xxx\");\n\nwhere the port `9xxx` is randomly assigned or can be requested in the config file like:\n\n```\ntunnels:\n my_https_site:\n remote_port: 9xxx\n proto:\n tcp: host.docker.internal:443\n```\nAlso, when mapping to a https site serving valid or self signed ssl, the domain names do not match so the browser displays a certificate error message which can be resolved by adding flags to your selenium code like for \n\nChrome (options):\n\n $ options.addArguments(\"ignore-certificate-errors\");\n\n\nFirefox (profile):\n\n $ profile.setAcceptUntrustedCertificates(true);\n\n\nNote that this method is for internal direct IP https sites with no redirects etc. To test production/other remote sites see [Github repo docker-gridc-squid][docker-gridc-squid]. Keep in mind that unlike subdomains which have unlimited unique endpoint capability, tcp ports are limited and must also be coordinated to avoid tunnel conflicts if they are specifically requested in the config file. Leave `remote_port:` empty in the config file for randomly assigned. An alternative to creating tunnels using a configuration file is to use the [Rest API][gridlastic-connect-api]. Read more about [Gridlastic Connect TCP tunneling][gridlastic-connect-tcp].\n\n## Test a remote https site using a standard forwarding proxy like Squid\n\nSee [Github repo docker-gridc-squid][docker-gridc-squid]\n\n \n\n## Create multiple tunnels in docker compose (see [Github repo docker-gridc][docker-gridc] for docker-compose.yml and custom-config-template.cfg)\n\nExample docker-compose.yml\n\n```\nversion: '3.8'\nservices:\n test-web-site:\n image: \"gridlastic/docker-hello-world\"\n ports:\n - \"8001:80\"\n\n gridc-config-tunnels:\n image: gridlastic/docker-gridc\n volumes:\n - ./custom-config-template.cfg:/home/gridc/config-template.cfg\n environment:\n GRIDC_ENDPOINT_SUBDOMAIN: ${GRIDC_ENDPOINT_SUBDOMAIN}\n GRIDC_USERNAME: ${GRIDC_USERNAME}\n GRIDC_ACCESS_KEY: ${GRIDC_ACCESS_KEY}\n GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX: ${GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX}\n GRIDC_START_CONFIG_TUNNELS: all\n\n \n\n test-web-site-1:\n image: \"gridlastic/docker-hello-world\"\n\n test-web-site-2:\n image: \"gridlastic/docker-hello-world\"\n \n \n gridc-tunnel-to-web-site-1:\n image: gridlastic/docker-gridc\n environment:\n GRIDC_ENDPOINT_SUBDOMAIN: ${GRIDC_ENDPOINT_SUBDOMAIN}\n GRIDC_USERNAME: ${GRIDC_USERNAME}\n GRIDC_ACCESS_KEY: ${GRIDC_ACCESS_KEY}\n GRIDC_PROTOCOL: https\n GRIDC_SUBDOMAIN: ${GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX}-test-web-site-1\n GRIDC_ADDR_DOMAIN: test-web-site-1\n GRIDC_ADDR_PORT: 80\n \n gridc-tunnel-to-web-site-2:\n image: gridlastic/docker-gridc\n environment:\n GRIDC_ENDPOINT_SUBDOMAIN: ${GRIDC_ENDPOINT_SUBDOMAIN}\n GRIDC_USERNAME: ${GRIDC_USERNAME}\n GRIDC_ACCESS_KEY: ${GRIDC_ACCESS_KEY}\n GRIDC_PROTOCOL: https\n GRIDC_SUBDOMAIN: ${GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX}-test-web-site-2\n GRIDC_ADDR_DOMAIN: test-web-site-2\n GRIDC_ADDR_PORT: 80\n```\n\nStart:\n\n```\nLinux/Mac\nexport GRIDC_ENDPOINT_SUBDOMAIN=\nexport GRIDC_USERNAME=\nexport GRIDC_ACCESS_KEY=\nexport GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX=x-y-z\n\n\nWindows (CMD)\nset GRIDC_ENDPOINT_SUBDOMAIN=\nset GRIDC_USERNAME=\nset GRIDC_ACCESS_KEY=\nset GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX=x-y-z\n\n\nWindows (Powershell)\n$Env:GRIDC_ENDPOINT_SUBDOMAIN = \"\"\n$Env:GRIDC_USERNAME = \"\"\n$Env:GRIDC_ACCESS_KEY = \"\"\n$Env:GRIDC_CONFIG_SUBDOMAIN_UUID_PREFIX = \"x-y-z\"\n```\n\n\n $ docker-compose up\n\n\nWill create 3 web site containers and 3 gridc containers with 3 tunnel endpoints to the test web sites that you can access in your selenium code like:\n\n $ driver().get(\"https://x-y-z-hostmachine-8001..gridlastic.com:8091\");\n $ driver().get(\"https://x-y-z-test-web-site-1..gridlastic.com:8091\");\n $ driver().get(\"https://x-y-z-test-web-site-2..gridlastic.com:8091\");\n \n In this example you could also specify all 3 tunnels in the config file and use a single gridc container. You can also [programmatically][gridlastic-connect-api] create tunnels using just one client. \n \n\n\n\n\n\n## Use the Client Rest API to create tunnels on the fly \n\n $ docker run --rm -it -p 3030:3030 --name gridc-api-endpoint -e GRIDC_ENDPOINT_SUBDOMAIN= -e GRIDC_USERNAME= -e GRIDC_ACCESS_KEY= -e GRIDC_API=3030 -e GRIDC_START_CONFIG_TUNNELS=all gridlastic/docker-gridc\n\n \nNote: unless the `GRIDC_API` parameter is passed along with tunnel parameters or the `GRIDC_HUB` parameter, the parameter `GRIDC_START_CONFIG_TUNNELS` must be set to `all`. Read more about how to use the [Rest API][gridlastic-connect-api].\n\n\n## Start the selenium grid hub endpoint in its own container\n\n\n $ docker run --rm -it -p 4444:4444 --name gridc-hub-endpoint -e GRIDC_ENDPOINT_SUBDOMAIN= -e GRIDC_USERNAME= -e GRIDC_ACCESS_KEY= -e GRIDC_HUB=4444 gridlastic/docker-gridc\n\nHub API access endpoint in your selenium code becomes `http://@localhost:4444/wd/hub` or if you started your grid with the option \"Gridlastic Connect Hub Endpoint\" selected to \"hub credentials disabled\" you can drop the credentials and use `http://localhost:4444/wd/hub`. Access the grid console like `http://localhost:4444/grid/console`. \n\n\n\n## Feedback\n\nReport issues/questions/feature requests at `support@gridlastic.com`.\n\n\n\n[gridlastic]: \thttps://www.gridlastic.com/\n[gridlastic-connect]:\thttps://www.gridlastic.com/gridlastic-connect.html\n[gridlastic-connect-tcp]:\thttps://www.gridlastic.com/gridlastic-connect.html#tcp\n[gridlastic-connect-api]:\thttps://www.gridlastic.com/gridlastic-connect.html#dynamic_tunnel_creation\n[alpine]:\t\t\t\thttps://registry.hub.docker.com/_/alpine\n[docker-gridc]: \t\thttps://github.com/gridlastic/docker-gridc\n[docker-gridc-squid]: https://github.com/gridlastic/docker-gridc-squid","has_starred","hub_user","immutable_tags_settings",{"_70":11,"_71":72},"enabled","rules",[73],".*","is_automated","permissions",{"_77":17,"_78":11,"_79":11},"read","write","admin","user","storage_size",172027384,"orgData",{"_85":86,"_87":88,"_89":90,"_91":28,"_92":93,"_94":95,"_96":97,"_98":99,"_100":101,"_102":93,"_103":93,"_104":93,"_105":17},"id","0bc710b6082f40cbab0b2614ae32fbdd","uuid","0bc710b6-082f-40cb-ab0b-2614ae32fbdd","type","organization","orgname","full_name","","location","USA","company","Gridlastic","profile_url","https://www.gridlastic.com","date_joined","2019-11-15T05:54:54.938267Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[108],{"_109":39,"_110":111,"_112":113,"_85":114,"_115":116,"_45":133,"_134":111,"_135":28,"_136":51,"_52":137,"_138":139,"_140":124,"_141":133,"_142":61,"_143":17},"content_type","creator",8299211,"full_size",8875134,106596154,"images",[117],{"_118":119,"_120":121,"_122":93,"_123":124,"_125":126,"_127":128,"_129":93,"_130":-5,"_131":113,"_58":61,"_132":-5},"architecture","amd64","digest","sha256:ade7a067f53ec9a86d3a1a8cf8115848690e831eafebad6f859c05ec671e34ed","features","last_pulled","2026-09-13T23:33:34.631523754Z","last_pushed","2021-03-03T23:53:39Z","os","linux","os_features","os_version","size","variant","2021-03-03T23:53:38.890235Z","last_updater","last_updater_username","media_type","latest","repository",9347004,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_33":153,"_160":161,"_149":170,"_171":11},{"_35":154,"_37":155,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":156,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":57,"_64":65,"_66":11,"_67":28,"_68":157,"_74":11,"_75":159,"_80":28,"_81":82},[],[39],[51],{"_70":11,"_71":158},[73],{"_77":17,"_78":11,"_79":11},"tags",{"_162":59,"_163":-5,"_164":-5,"_165":166},"count","next","previous","results",[167],{"_109":39,"_110":111,"_112":113,"_85":114,"_115":168,"_45":133,"_134":111,"_135":28,"_136":51,"_52":137,"_138":139,"_140":124,"_141":133,"_142":61,"_143":17},[169],{"_118":119,"_120":121,"_122":93,"_123":124,"_125":126,"_127":128,"_129":93,"_130":-5,"_131":113,"_58":61,"_132":-5},[],"canDeleteTags","actionData","errors"]

gridlastic/docker-gridc

Tags for gridlastic/docker-gridc