Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main'
Browse files Browse the repository at this point in the history
  • Loading branch information
nschmid committed Jan 12, 2024
2 parents 506356d + 88b66bf commit 455d9eb
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,25 @@ HelloDATA BE integrates the prowess of open-source tools into a unified, enterpr

Agile and transparent data platforms are vital in a rapidly evolving digital landscape. HelloDATA BE tries to help by offering an open-source solution tailored to enterprise needs. Our mission is to democratize data and provide end-to-end- innovation-driven data handling. [Learn More](docs/docs/vision/vision-and-goal.md).


## Quick Start

Change directory to `hello-data-deployment/docker-compose` and run the following command:
**Essential Setup**
1. **Docker Desktop Settings**: For Mac users, adjust Docker Desktop settings for multi-platform support (especially for arm64-chip users). [Details](hello-data-deployment/docker-compose/README.md#mac).
2. **Hosts File Entry**: Ensure `127.0.0.1 host.docker.internal` is added to `/etc/hosts`. For Windows enable in Docker Desktop WSL settings [How to](hello-data-deployment/docker-compose/README.md#prepare-environment).

**Start-Up Instructions**

Change directory to `hello-data-deployment/docker-compose` and run:
```sh
docker-compose up -d
```

This will take a while to pull all images and wramp up the containers. Check the webportal at [localhost:8080](http://localhost:8080) when everything is up and running. Default user/password is admin/admin for the admin user.
Pulling all images and starting up the containers will take a while. Once completed, access the web portal at [localhost:8080](http://localhost:8080) (default: admin/admin).

> **Note:** Refer to our [docker-compose README](hello-data-deployment/docker-compose/README.md) for additional commands and troubleshooting. <br>
> **Hint:** Windows users need to change line to `LF`, see more details in [Windows section](hello-data-deployment/docker-compose/README.md)
> **Note:**
> - Detailed start-up instructions, troubleshooting, and FAQs are in the [docker-compose README](hello-data-deployment/docker-compose/README.md).
> - Specific setup information for [Windows users](hello-data-deployment/docker-compose/README.md#windows).
## Key Features

Expand Down
9 changes: 8 additions & 1 deletion hello-data-deployment/docker-compose/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Make sure the `host.docker.internal` is added to the /etc/hosts file with either
- **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)`

If you are on [Mac](#mac), [Windows](#windows) or general [FAQ](#faq), please check the enhanced instructions on the bottom.

## Quick Start

First **pull and build** all required images.
Expand Down Expand Up @@ -55,9 +57,14 @@ After all started, go to [localhost:8080](http://localhost:8080/) in your browse

## FAQ

- **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. Ensure you use the latest Docker Desktop and 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](https://docs.docker.com/desktop/settings/mac/?uuid=740D92D0-4D7C-4DD7-9DFD-8AF8D62F42F7) and [Multi-platform images](https://docs.docker.com/build/building/multi-platform/).
- **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](https://docs.docker.com/desktop/settings/mac/?uuid=740D92D0-4D7C-4DD7-9DFD-8AF8D62F42F7) and [Multi-platform images](https://docs.docker.com/build/building/multi-platform/).
- **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](https://linux.die.net/man/1/dos2unix) to
Expand Down

0 comments on commit 455d9eb

Please sign in to comment.