Differences

This shows you the differences between two versions of the page.

--- summer2024:dockersetup [2024/06/29 10:17] – [Standard image setup] rajit
+++ summer2024:dockersetup [2025/08/27 10:03] (current) – [Creating a container] rajit
@@ Line 1: / Line 1: @@
 ====== Docker image and container setup ======
-We have provided a [[https://www.docker.com/|Docker]] image that has all the tools we will be using pre-installed. If you are unfamilar with Docker/containers, there are many online tutorials available (e.g. [[https://www.geeksforgeeks.org/introduction-to-docker/|here]]). Essentially Docker provides a lightweight "virtual" environment, permitting you to run different architectures/operating systems and libraries/platform environments on a machine. You will need to install Docker on your system.
+We have provided a [[https://www.docker.com/|Docker]] image that has all the tools we will be using pre-installed. If you are unfamilar with Docker/containers, there are many online tutorials available (e.g. [[https://www.geeksforgeeks.org/introduction-to-docker/|here]]). Essentially Docker provides a lightweight "virtual" environment, permitting you to run different architectures/operating systems and libraries/platform environments on a machine. You will need to [[https://www.docker.com/get-started/|install Docker]] on your system.
 ===== Standard image setup =====
@@ Line 20: / Line 20: @@
 </code>
-This starts with the pre-built Docker image ''rajitmanohar/act_sky130:latest'' and extends it by installing a number of packages. The base operating system is Linux (Ubuntu). It also sets the password for the ''user'' account user to ''userpass'', and the ''root'' password to ''rootpass''. Finally, it starts the ssh service so you can use ssh to connect to your docker container. Feel free to customize this to install any software/tools/etc. you might want.
+This configuration does the following:
+   * It starts with the pre-built Docker image ''rajitmanohar/act_sky130:latest''. Note that the base operating system is Linux (Ubuntu). It is a multi-platform build with binaries for both arm64 and amd64 architectures.
+   * It extends it by installing a number of packages (text editors, a window manager, VNC server, etc.)
+   * It sets the password for the ''user'' account user to ''userpass'', and the ''root'' password to ''rootpass''. You can use these later to login and install other packages if needed.
+   * It starts the ssh service so you can use ssh to connect to your docker container. It then waits in an infinite loop so that the container keeps running so you can connect to it via ssh.
+Feel free to customize this to install any software/tools/etc. you might want.
 To build an image using the Dockerfile above (saved as Dockerfile in your working directory), run:
 <code>
-$ docker build -t async - < Dockerfile
+$ docker build -t cadtools - < Dockerfile
 </code>
-This will use the ''Dockerfile'' to build an image named ''async''.
+This will use the ''Dockerfile'' to build an image named ''cadtools''.
@@ Line 34: / Line 40: @@
 There are many ways to start docker containers. A simple setup that we use is to have a shared directory between the container and the host machine where you are running docker, and forward port 7500 from the host machine to the ssh port (22) in the container. The following command will accomplish this.
 <code>
-$ docker run -d -p 7500:22 -v /path/to/directory:/share async
+$ docker run -d -p 7500:22 -v /path/to/directory:/share cadtools
 </code>
 The ''/share'' directory in the container will correspond to the specified path on the host.
@@ Line 55: / Line 61: @@
 </code>
-Now the local port 8500 on the host will correspond to the VNC port. You can now connect to port 8500 on your local machine using a VNC client to get a graphical desktop that is running on the container.
+Now the local port 8500 on the host will correspond to the VNC port 5901 in the container. You can now connect to port 8500 on your local machine using a VNC client to get a graphical desktop that is running on the container. If the vnc server in the container has a different display number (e.g. :3 instead of :1), then 8500 should be forwarded to a different port number (e.g. 5903 for display :3, rather than 5901 for display :1).
 Note that once the container is setup, you don't need to re-do those steps. You can simply pause the container to stop it, and resume it when you want to re-connect to it via ssh.
+===== Updating the container with the latest tools =====
+The container is not updated as frequently as the git repositories. To update the tools from within the container, use the following steps, running as ''root'':
+<code>
+$ cd /home/cad/actflow
+$ git pull
+$ git submodule update --init --recursive
+$ export ACT_HOME=/usr/local/cad
+$ ./build
+</code>
+The git repository for the [[:install_actflow|actflow]] repository is checked out in ''/home/cad/actflow''. The steps outlined above pull the latest code and build and install the tools into ''/usr/local/cad'' (the default location in the container).