Persistent cabal store in Haskell devcontainers
Posted on 2023-01-14
This is going to be a short one. I recently added a development container definition to the repository that hosts this very website. The definition I’m using is taken from Microsoft’s devcontainer repository via the option integrated in Visual Studio Code1.
For the most part, this development container works flawelessly. Except for this: the user’s cabal folder (located at
~/.cabal by default) is not persisted across container runs. This means I need to rebuild from scratch most of the dependencies that cabal saves in its user-wide package store (
~/.cabal/store) every time I reopen the project (notably annoying with Hakyll’s dependency of big-chungus
There are a couple of ways to solve this:
By configuring cabal to use a package store located inside the repository’s folder (which is bind-mounted to the host’s file system).
Problem: this would duplicate the work for any dependency shared across Haskell projects.
~/.cabalfolder in my host computer and share it among devcontainers.
Problem: this folder would be continuously modified by
root, a permission hell waiting to happen.
Mounting the package store to a Docker named volume.
This is what I ended up doing, as it takes the least work and doesn’t clutter my host’s
The only changes needed are adding the following properties to
"mounts": [ "source=cabal_store,target=/home/vscode/.cabal/store,type=volume" ], "postCreateCommand": "sudo chown vscode /home/vscode/.cabal/store"
cabal_storeis the name of the Docker volume to be created and
vscodeis the Linux user of this devcontainer. The
postCreateCommandis there to make sure our container can access and modify the package store (only needed in case your devcontainer logs in to a user other than
root). Repeat this for every Haskell devcontainer you want to share the cabal store with.
That’s it! Signing off.
Sadly, I found today this repo is getting deprecated in favor of containers.dev, and the latter doesn’t yet host any devcontainer definition for Haskell.↩︎