diff --git a/README.md b/README.md index 0abd1b4ec9..ba8d72fc0e 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,9 @@ if you have problems): docker compose --profile ci up --build --attach-dependencies ``` +> **Note:** when running on MacOS with an M1 chip you have to use: +> `DB_PLATFORM=linux/x86_64 docker compose ...` + Then, navigate to `http://localhost:3000` (It may take some time to boot up) and interact with the website. diff --git a/backend/README.md b/backend/README.md index ec06b3768a..b40b6058ca 100644 --- a/backend/README.md +++ b/backend/README.md @@ -11,6 +11,9 @@ database at `localhost:5432`. (See [FAQ](https://projects.laion.ai/Open-Assistant/docs/faq#enable-dockers-buildkit-backend) if you face any docker problems). +> **Note:** when running on MacOS with an M1 chip you have to use: +> `DB_PLATFORM=linux/x86_64 docker compose ...` + Python 3.10 is required. It is recommended to use `pyenv` which will recognise the `.python-version` in the project root directory. diff --git a/docker-compose.yaml b/docker-compose.yaml index cb75a2cfed..27a733142f 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -9,6 +9,7 @@ services: # This DB is for the FastAPI Backend. db: + platform: "${DB_PLATFORM:-}" image: ghcr.io/laion-ai/open-assistant/oasst-postgres pull_policy: always restart: always diff --git a/scripts/backend-development/README.md b/scripts/backend-development/README.md index 0c7a8fce5b..b4c7b1c132 100644 --- a/scripts/backend-development/README.md +++ b/scripts/backend-development/README.md @@ -5,6 +5,9 @@ In root directory, run a database. The default settings are already configured to connect to the database at `localhost:5432`. +> **Note:** when running on MacOS with an M1 chip you have to use: +> `DB_PLATFORM=linux/x86_64 docker compose ...` + Make sure you have all requirements installed. You can do this by running `pip install -r requirements.txt` inside the `backend` folder, `pip install -e .` inside the `oasst-shared` folder and `pip install -e .` diff --git a/website/README.md b/website/README.md index 9b34b65f95..fe9ee9b5a4 100644 --- a/website/README.md +++ b/website/README.md @@ -54,6 +54,7 @@ If you're doing active development we suggest the following workflow: 1. Run `npm run dev`. Now the website is up and running locally at `http://localhost:3000`. 1. To create an account, login via the user using email authentication and navigate to `http://localhost:1080`. Check the email listed and click the log in link. You're now logged in and authenticated. + > **Note:** when running on MacOS with an M1 chip you have to use: `DB_PLATFORM=linux/x86_64 docker compose ...` ### Using debug user credentials