Skip to content

Using the Docker Image

Marc Hanheide edited this page Dec 9, 2024 · 23 revisions

Using the Module's Docker Image

All software required is deployed as a Docker image, allowing anyone to run this on any computer that has Docker installed. The containerised development environment is made available as a "DevContainer", heavily customised for the work within the Lincoln Centre for Autonomous Systems (L-CAS) and to contain a ROS2 development environment.

You are provided with a GitHub Repository, that has the DevContainer preconfigured for you use and which you can use for your own development. Please see here: https://github.com/UoL-SoCS/cmp3103-ws

The documentation of how to use that DevContainer can be found in https://github.com/UoL-SoCS/cmp3103-ws/blob/main/README.md.

If you have any questions, please use the Module's MS Teams Channel

Note: Any changes you have been done in your home directory on this devContainer are deleted if your dev container is deleted. So please make sure you store all your work properly on a source revision system like GitHub. You are strongly adviced to use this repository as a template to create your own repository for your work.

Note: If you have installed docker with sudo on linux, you may receive the following error message when logging in Got permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Post "http://%2Fvar%2Frun%2Fdocker.sock/v1.24/auth": dial unix /var/run/docker.sock: connect: permission denied. If this is the case, make sure to add your local user to the docker group by running sudo adduser <YOURUSERNAME> docker.

Docker isn't installed?

You may have an error in VS Code saying that "docker is not installed" to resolve this, you should open a terminal and run the docker command. You should get a list of commands you can use. This means docker is installed on your machine.

If you're using Windows or macOS: make sure that Docker Desktop is running.

If you're on a Lab Ubuntu PC... you may need to reopen VS Code as a new window (right-click the icon on the dock, click new empty window), this is because it can't find the .devcontainer configuration file. You should be able to proceed as normal.

After your work, shut everything down

  1. stop all processes inside the terminals of your VSCode environment (e.g. with [ctrl-c] in the terminals)
  2. make sure you have saved all your work somewhere, e.g. on GitHub, or the likes
  3. If you are on a shared computer (e.g. the lab PCs), make sure you log out of everything, and you removed any files etc. (The Lab PCs are configured to delete files saved to delete files on restart. On Windows all files will be removed, but on Ubuntu only some folders such as, the Documents, Downloads, and Desktop. Please make sure you only work inside these folders.)

This is what it looks like

https://uol.cloud.panopto.eu/Panopto/Pages/Viewer.aspx?id=1bc88d3d-8529-479d-8750-b10500cef213