Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 3.83 KB

README.md

File metadata and controls

103 lines (72 loc) · 3.83 KB
Raw

Requirements

Operating system

At least 15GB of RAM available for docker under following systems (we recommend a decent machine with at least 32GB of physical memory)

  • Linux
  • MacOS
  • Windows

Software installed

  • docker
  • docker-compose
  • docker-desktop (optional)

Prepare environment

Make sure the host.docker.internal is added to the /etc/hosts file with either of these options:

  • Linux/MacOS: add 127.0.0.1 host.docker.internal to the /etc/hosts file.
  • Windows: Enable in Docker Desktop under Settings -> General -> Use WSL 2 based engine the settings: Add the *.docker.internal names to the host's etc/hosts file (Requires password)
    • Make sure Docker-Desktop entered it correctly in C:\Windows\System32\drivers\etc\hosts. There were some cases where its wrong OR the IP is an old one. This will cause an error to communicate between the containers. It should look something like this with your currrent IP placed:
# Added by Docker Desktop
<YOUR-IP-HERE> host.docker.internal
<YOUR-IP-HERE> gateway.docker.internal
# Add this line yourself - needed to work with keycloak 23 on Google Chrome browser
127.0.0.1 keycloak.localhost 
# To allow the same kube context to work on the host and the container:
127.0.0.1 kubernetes.docker.internal
# End of section

Also be sure there is no Postgres running on port 5432 as these will conflict with the upspinning Postgres of HelloDATA.

If you are on Mac, Windows or general FAQ, please check the enhanced instructions on the bottom.

Quick Start

First pull and build all required images.

Please don't forget to run it again after some time in order to fetch the latest changes, or use command below to always fetch/build before start (takes longer).

docker-compose pull

To start everything in a single command, run:

docker-compose up -d

To start everything in a single command and always build/fetch latest images, run:

docker-compose pull;  docker-compose up -d --build

To prune the environment, run:

docker-compose down --volumes --remove-orphans

The start might take some time.

After all started, go to localhost:8080 in your browser and log in with user: admin / admin

FAQ

  • Filebrowser login: admin/admin. After successful login, the user should see the dbt-docs shared storage. Also, files can be opened in local file explorer from ./docker-compose/shared path.

Mac

  • Mac: And for images unlike intel (e.g. Apple Sillicon), ensure that you are on latest Docker Desktop, and that you enable Use Rosetta for x86/amd64 emulation on Apple Silicon under Settings -> General. This setting substantially boosts the speed of non-native containers. Find more on Docker Desktop Settings and Multi-platform images.

  • Mac: Also enable this setting under Settings -> Resources -> Network: Use kernel networking for UDP Use a more efficient kernel networking path for UDP. This may not be compatible with your VPN software.

  • Platform architecture: If you are on a Mac or another arm64 architecture, you mostly likely get the message requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested. It should still work, but much slower.

Windows

  • If you use Windows native (not WSL or WSL2), ensure the LF (line feeds) are defined in Linux style. Use a tools like dos2linux to convert, or make sure in your IDE (e.g., IntelliJ has the option to set).