Merge pull request #677 from oss-aspen/JamesKunstle-patch-1

Update README.md w/ Podman stuff

.wordlist-md

@@ -72,3 +72,11 @@ Docker's
 data-center
 OAuth
 postgres
+Podman
+filesystem
+credsStore
+credStore
+filesystem
+Podman
+credsStore
+credStore

README.md

@@ -1,4 +1,4 @@
-# 8Knot (Explorer)
+# 8Knot
 
 ![Pre-Commit](https://github.com/JamesKunstle/explorer/actions/workflows/pre-commit.yml/badge.svg)
 ![Build-Push](https://github.com/JamesKunstle/explorer/actions/workflows/build-push-quay.yml/badge.svg)
@@ -219,9 +219,18 @@ docker && docker compose || docker-compose
 
 (above just runs docker and docker-compose and checks if both work)
 
-NOTE: `podman-compose` has been generally verified to work as well, but our preference is `docker compose`
-`podman-compose` doesn't support the `--scale` flag as we would expect so we don't use it for our own
-development applications, but the application is built to work with the minimum number of containers. "your mileage my vary".
+NOTE: As of 3/29/24 we recommend using `Podman` and `Podman Desktop` instead of `Docker` and `Docker Desktop`. It will be our default development environment going forward.
+There are many guides to transitioning from `Docker` (Desktop) to `Podman` (Desktop), but here's a rough outline of our "golden path."
+
+1. Uninstall `Docker Desktop`. This will require a GUI uninstall and looking through your apps + filesystem for remnants.
+2. Install `Podman` and `Podman Desktop`. You'll also explicitly have to provision a `Podman Machine` if you're on a Mac.
+3. Enable the "Docker compatibility add-on" available in `Podman Desktop`. This will route traffic headed for a Docker machine to the running Podman machine. (Under the hood, this points Podman at the Docker socket."
+4. Install `docker-compose`. This is a standalone, open source tool that `Podman Compose` delegates compose responsibilities to.
+
+At this point, the `Podman` docs claim that one should have moved over to `Podman` as a drop-in replacement for `Docker`. However, here are two steps that we noticed were necessary in some cases.
+
+1. In `$HOME/.docker/config.json` replace "credsStore" with "credStore" (minus an 's') to solve registry credentialing problems.
+2. Set `export DOCKER_HOST=<your_podman_machine_socket_path>` to the `Podman machine`'s socket on your system, which you can find in the `Resources` tab of `Podman Desktop`. The path starts with `unix://`.
 
 ### Build and Run