Run the following command to get a tunnel with a random name, using the github
provider:
docker compose upWatch the logs, and authorize the device as per the instructions. Once your tunnel has been authorized, the logs will print out a URL to access the tunnel from your browser.
You can set the environment variable TUNNEL_NAME to choose the name of your
tunnel.
The standalone helper aims at quickly creating containerized development
environments based on the images created by this project. It uses sensible
defaults. Start by making sure devenv.sh is accessible from your
$PATH. Run the following to create a development environment with the
all-inclusive official image.
devenv.sh devenv -vThis will create a (privileged) container, running in the background with the following features:
- A volume named after the first argument,
devenvwill be created, if necessary and mounted into the development environment as the home directory for the usercoder. - The local container will also be named
devenv. If there was an existing container running under that name, it will be removed. - The vscode tunnel will be called after
<hostname>-devenv, where<hostname>will be the actual name of the host that the command is run on. - The
-voption will be passed to the entrypoint of the container, providing for more information in the logs of the container. You can pass any option recognized by the entrypoint.
Even more in a hurry? Run the following one liner to run devenv.sh directly
from GitHub. This example will only print the help through the -h option.
curl -sSL https://raw.githubusercontent.com/efrecon/devenv-code-tunnel/refs/heads/main/devenv.sh | sh -s - -hBuild using the following command, this will create an image called
code_tunnel.
docker build -t code_tunnel .Create a volume for your home
docker volume create homeCreate a container, giving the tunnel the name a-name-of-your-choice
docker run \
-it \
--rm \
--privileged \
--hostname "a-name-of-your-choice" \
-v home:/home/coder:Z \
code_tunnel \
-vvDo as above, i.e. watch the logs for how to authorize at github, and then how
to access your container from your browser.
Notes:
--privilegedis necessary so the environment will be able to easily run Docker in Docker.--hostnameis necessary in order to avoid to have to re-authorize the device tunnel each time the container starts -- as long as you use the same hostname. By default, the name of the tunnel will then be the same as the hostname.
Inside the container, tunnel.sh is used to create the tunnel. The script takes
the following options.
-v(repeat thevs) to increase verbosity-n xxto give a name to the tunnel, this will automatically attempt to set the hostname inside the container to the same name. Changing the hostname requires--privileged, a warning will be printed out elsewise. Setting the hostname is to avoid that the tunnel will think that it is running on a different device each time it is run.-fto force authorization of the device at the provider-pto change the provider away from thegithubdefault.-kto specify a hook that will automatically be downloaded and executed before the tunnel is started. You can use this to run a gist that would setup your environment and dotfiles, for example. To run this gist, give its raw URL as a value, i.e.https://gist.githubusercontent.com/efrecon/a9addf9f5812212366ede103bfc211f6/raw-gis the name of a GitHub user (you?!) to allow for connecting into the cloudflare tunnel via SSH.-Gis the URL to a GIST that will be updated with details about the created tunnels. Under the root of that GIST, a file named after the name of the tunnel, with the.txtextension will be maintained with access content. For additional security, you should make that GIST private. This requires thegitfeature to be installed.-Tselects the tunnels that are to be started, provided they have been installed in the image. The default is to start all tunnels.-Lselects the logs to reprint inside the main container logs. Specify a-to not reprint anything.
Official images are published to the GitHub container registry. There are two images:
ghcr.io/efrecon/devenv-code-tunnel-alpine-minimal:mainprovides a user calledcoder. The user is able tosudowithout password. Only the vscode CLI is installed.ghcr.io/efrecon/devenv-code-tunnel-alpine:mainadds a number of (opinionated) software onto the image. The entire list is as per the content of the features directory.