Document running on macOS

[victorb]

Seems that running Cube on macOS with Docker is a bit more complicated as Docker runs within a virtual machine, so IPs are not directly available. Logs from Slack:

i think on my mac, the docker instances are coming up on a different ip address than it’s expecting

i’m guessing it’s due to docker on mac https://docs.docker.com/docker-for-mac/networking/

if it uses bridge networking, you can’t actually connect to the instances …

this might be a workaround but i don’t want to try it https://github.com/AlmirKadric-Published/docker-tuntap-osx

i needed to mess with iptables and routing to access it from my mac

yay, it’s working! i can pin things from my mac

Logs above is from @jimpick. You think you could write down some instructions in a md file inside /docs? Would be very helpful!

Suggestions for how to make this work automatically (if possible) would be greatly appreciated as well.

[jimpick]

I'm not sure what the correct solution is ... I ended up installing on my Linux machine instead.

One thing that might work is if all the containers could be run with non-overlapping ports they could all use the default networking instead of bridge networking.

[victorb]

@jimpick ah, I see, your message about "I can pin things from my mac" means pinning from the mac to the linux box!

So, the docker provider is essentially just a development tool to develop the provisioning side of things. In reality, you would only run one go-ipfs node + one ipfs-cluster node per instance, so there is no risk of port collision really.

But in the case of running locally with docker, avoiding binding any ports on the host is a easy way of having the docker provisioner, and it works (on linux, which the developer of Cube is currently using :) ) so might just leave it like this for now.

Maybe in the future (or if someone feels like making a PR), we can change it to allocate incremental ports for the containers, to avoid the bridge networking.