From a9fd5f3dbc3df191abf3c952ca2c06fd8b5c0b6e Mon Sep 17 00:00:00 2001 From: nwekealex65 <163132802+nwekealex65@users.noreply.github.com> Date: Fri, 15 Mar 2024 10:10:16 +0100 Subject: [PATCH 1/2] Update Docker-installation.md --- What does this PR do ? Fixed Typo in https://github.com/hotosm/fAIr/blob/master/docs/Docker-installation.md and enhanced the section for creating .env files This fixes issue #235 --- docs/Docker-installation.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/Docker-installation.md b/docs/Docker-installation.md index 529793ec..b6f25eaf 100644 --- a/docs/Docker-installation.md +++ b/docs/Docker-installation.md @@ -26,7 +26,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron nvidia-smi ``` -4. Clonse Base Model and Create RAMP_HOME +4. Clone Base Model and Create RAMP_HOME - Create a new folder called RAMP , outside fAIr @@ -72,7 +72,8 @@ Docker Compose is created with redis , worker , postgis database , api and fron - Check permissions for ```Read user preferences``` and Redirect URI to be ```http://127.0.0.1:3000/authenticate/``` , Give it name as ```fAIr Dev Local``` - You will get ```OSM_CLIENT_ID``` , ```OSM_CLIENT_SECRET``` Copy them -6. Create Env variables +6. Create Env variables + Backend - Create a file ```.env``` in backend with [docker_sample_env](../backend/docker_sample_env) content ``` cd backend @@ -82,14 +83,15 @@ Docker Compose is created with redis , worker , postgis database , api and fron Leave rest of the items as it is unless you know what you are doing - - Create ```.env``` in /frontend + Frontend + - Create ```.env``` file in /frontend ``` cd frontend cp .env_sample .env ``` You can leave it as it is for dev setup -7. Build & Run containers +8. Build & Run containers ``` docker compose build @@ -99,7 +101,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron docker compose up ``` -8. Run Migrations +9. Run Migrations Run directly bash script : @@ -121,7 +123,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron python manage.py makemigrations core python manage.py migrate -9. Play and Develop +10. Play and Develop Restart containers @@ -133,7 +135,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron Please open the frontend using URL `127.0.0.1:3000` instead of `localhost:3000` to ensure login functionality. -10. Want to run your local tiles ? +11. Want to run your local tiles ? You can use [titler](https://github.com/developmentseed/titiler) , [gdals2tiles](https://gdal.org/programs/gdal2tiles.html) or nginx to run your own TMS server and add following to docker compose in order to access your localhost through docker containers . Add those to API and Worker . Make sure you update the .env variable accordingly @@ -185,4 +187,4 @@ Docker Compose is created with redis , worker , postgis database , api and fron DATABASE_URL=postgis://postgres:admin@localhost:5434/ai CELERY_BROKER_URL="redis://localhost:6379/0" CELERY_RESULT_BACKEND="redis://localhost:6379/0" - ``` \ No newline at end of file + ``` From d5702c8c7abd86eea302dc6aeea5fb0614fcbe3c Mon Sep 17 00:00:00 2001 From: nwekealex65 <163132802+nwekealex65@users.noreply.github.com> Date: Fri, 15 Mar 2024 16:04:14 +0100 Subject: [PATCH 2/2] Update Docker-installation.md Fix numbering typo --- docs/Docker-installation.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/Docker-installation.md b/docs/Docker-installation.md index b6f25eaf..df8ea4b3 100644 --- a/docs/Docker-installation.md +++ b/docs/Docker-installation.md @@ -91,7 +91,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron ``` You can leave it as it is for dev setup -8. Build & Run containers +7. Build & Run containers ``` docker compose build @@ -101,7 +101,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron docker compose up ``` -9. Run Migrations +8. Run Migrations Run directly bash script : @@ -123,7 +123,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron python manage.py makemigrations core python manage.py migrate -10. Play and Develop +9. Play and Develop Restart containers @@ -135,7 +135,7 @@ Docker Compose is created with redis , worker , postgis database , api and fron Please open the frontend using URL `127.0.0.1:3000` instead of `localhost:3000` to ensure login functionality. -11. Want to run your local tiles ? +10. Want to run your local tiles ? You can use [titler](https://github.com/developmentseed/titiler) , [gdals2tiles](https://gdal.org/programs/gdal2tiles.html) or nginx to run your own TMS server and add following to docker compose in order to access your localhost through docker containers . Add those to API and Worker . Make sure you update the .env variable accordingly