feat: add Docker support for Folksonomy API #254

ekas-7 · 2025-03-12T19:58:49Z

add Docker support for Folksonomy API

What

Add Docker support to simplify development and deployment of Folksonomy API
Create multi-stage Dockerfile to optimize container size and build efficiency
Configure docker-compose.yml with properly networked services for API and PostgreSQL
Include non-root user configuration and security best practices
Add comprehensive .dockerignore to prevent unnecessary files in image builds

Screenshot

Fixes bug(s)

Resolves environment inconsistency issues between developers
Fixes setup problems on modern Linux distributions like Debian 12

Part of

Also addresses one of issue and many future issue that can be caused by different environments in future
Current instructions to build dev environement are nearly all wrong on Debian 12 #224 Current instructions to build dev environment are nearly all wrong on Debian 12

- Create multi-stage Dockerfile for efficient image building - Configure docker-compose.yml with PostgreSQL service - Set up PostgreSQL on alternative port (5433) to avoid conflicts - Add .dockerignore to optimize Docker builds

areebahmeddd · 2025-03-13T09:22:33Z

Hey @ekas-7,

It's best to create an issue first for this pull request and then reference it. Also noticed you're pushing from the main branch, please create your own branch and push from there instead.

codecov-commenter · 2025-03-13T10:07:53Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.57%. Comparing base (b9cda65) to head (f7639a6).
Report is 82 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #254      +/-   ##
==========================================
- Coverage   95.06%   94.57%   -0.49%     
==========================================
  Files           5        5              
  Lines         324      387      +63     
==========================================
+ Hits          308      366      +58     
- Misses         16       21       +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Dockerfile

alexgarel

@ekas-7 that's a great PR.

I have some comments though, I let you fix them.

alexgarel · 2025-03-13T11:38:34Z

Dockerfile

+# Copy the local_settings example to local_settings.py (if not exists)
+RUN if [ ! -f local_settings.py ]; then cp local_settings_example.py local_settings.py; fi


I don't think it's a good idea to do this.

If someone wants to use a local_settings it's better to mount it in the container. It's a bad idea to have it in container image IMO. (and it's not a mandatory file)

alexgarel · 2025-03-13T11:39:56Z

Dockerfile

+CMD python db-migration.py && \
+    uvicorn folksonomy.api:app --host 0.0.0.0 --port 8000 --proxy-headers


I prefer not to automatically run migrations. My long experience tells me it's better that migration are run by the user manually as needed (eg., in production, after a release).

docker compose exec api python db-migration.py
creted a command for mannual migration

README.md

alexgarel · 2025-03-13T11:41:24Z

README.md

+## Requirements
+- Docker
+- Docker Compose


Give a minimal version number, as we sometimes have problem with that.

Version Updated in Readme.md

alexgarel · 2025-03-13T11:43:50Z

README.md

+2. Start the services
+   ```bash
+   docker-compose up -d
+   ```


Use docker compose instead of docker-compose (deprecated)

consistently which my comment above, add the migration run (docker compose run --rm folksonomy_api python db-migration.py, if we set postgres as a dependency of folksonomy_api)

alexgarel · 2025-03-13T11:48:15Z

README.md

 ```bash
-./generate_openapi_json.py
+psql -h localhost -p 5433 -U folksonomy -d folksonomy


why rely on having psql localy instead of using the container ?

docker compose exec -u postgres folksonomy_db psql

corrected with :
docker compose exec db psql -U folksonomy -d folksonomy

alexgarel · 2025-03-13T11:49:01Z

docker-compose.yml

+    environment:
+      - POSTGRES_USER=folksonomy
+      - POSTGRES_PASSWORD=folksonomy
+      - POSTGRES_DATABASE=folksonomy
+      - POSTGRES_HOST=db


Would be better to put variable in a .env and reuse them here.

volumes:
# Mount .env file for environment variables
- ./.env:/app/.env
# Mount a volume for logs
- api_logs:/app/logs
env_file:
- .env
depends_on:

alexgarel · 2025-03-13T11:50:37Z

docker-compose.yml

+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - "8000:8000"


Please don't publish on all ports, this can be a security risk in public wifi.

So by default, publish to 127.0.0.1:8000

the best would be to use a variable and set it in .env (I would call it API_EXPOSE):

- "${API_EXPOSE}:8000"

ports:
- "${API_EXPOSE:-8000}:8000"

alexgarel · 2025-03-13T11:51:24Z

docker-compose.yml

+      - POSTGRES_PASSWORD=folksonomy
+      - POSTGRES_DB=folksonomy
+    ports:
+      - "5433:5432"


I wouldn't expose the database and surely not on all address (see above)

changed to
ports:
- "${DB_EXPOSE:-5433}:5432"

docker-compose.yml

ekas-7 · 2025-03-13T11:56:25Z

@alexgarel sir right onto improvements that u have mentioned in your comments

Co-authored-by: Alex Garel <[email protected]>

feat: Add message for existing property in product tag API (openfoodfacts#248)

ekas-7 · 2025-03-13T16:33:38Z

@alexgarel i have taken all the comments into account and created a new version of codebase.
Kindly let me know if any more changes are required .
Thank u for ur guidance got a lot of exposure from ur comments how to dockerise a codebase for prod level.

alexgarel · 2025-03-18T08:47:36Z

@ekas-7 #247 is finally merged ! You can adapt your PR according to it.

@ekas-7 also look at the documentation bearing in mind that docker is an option, but not the only option for developers.

Thanks.

ekas-7 · 2025-03-18T08:52:12Z

@alexgarel I will make changes by EOD. Thank u for ur insights on docker .

Orignal

ekas-7 · 2025-03-18T14:23:42Z

Screen.Recording.2025-03-18.at.7.1.mp4

@alexgarel i think we are good to go
Thank u for ur insights on docker

Add Docker support for Folksonomy API

756671a

- Create multi-stage Dockerfile for efficient image building - Configure docker-compose.yml with PostgreSQL service - Set up PostgreSQL on alternative port (5433) to avoid conflicts - Add .dockerignore to optimize Docker builds

ekas-7 requested a review from a team as a code owner March 12, 2025 19:58

github-actions bot assigned ekas-7 Mar 12, 2025

ekas-7 changed the title ~~Add Docker support for Folksonomy API~~ feat: add Docker support for Folksonomy API Mar 12, 2025

docs: update README with Docker setup instructions

c10689a

Merge branch 'main' into main

6fcc988

areebahmeddd reviewed Mar 13, 2025

View reviewed changes

Dockerfile Outdated Show resolved Hide resolved

areebahmeddd reviewed Mar 13, 2025

View reviewed changes

Dockerfile Show resolved Hide resolved

alexgarel reviewed Mar 13, 2025

View reviewed changes

ekas-7 and others added 18 commits March 13, 2025 17:47

Update README.md

f9116d7

Co-authored-by: Alex Garel <[email protected]>

Added Min version of docker and docker compose

b93261f

Updated Docker Compose Commands in README file

be555e1

Merge branch 'main' of https://github.com/ekas-7/folksonomy_api

9366891

Merge pull request #1 from openfoodfacts/main

4641583

feat: Add message for existing property in product tag API (openfoodfacts#248)

Updated to phython:3.9-slim for better compatibility

11ebab9

Merge branch 'main' of https://github.com/ekas-7/folksonomy_api

5ea405a

Changed from pip to poetry

f257d82

Stayed with pip till poetry PR is merged

4e5a2ce

Removed loacal Settings line from Dockerfile

f72d323

Mounted local_settings.py at runtime in docker compose

e8b2a12

Mounted local_settings.py at runtime in docker compose

654a43e

Automatic Migration removed Manual Migrations added

7459227

Updated README for ease of use

957aa88

Merge branch 'main' of https://github.com/ekas-7/folksonomy_api

0488be8

added db-connect.sh Connect to the PostgreSQL database

c02a1d2

Updated README.md

9812b5e

Updated README.md

bd266d2

ekas-7 and others added 10 commits March 13, 2025 20:53

Update README.md

411b921

Update README.md

d51cf95

Updated README.md

d2e100d

Update README.md

c93091e

Update README.md

6d87dcd

Added .env config for docker

818a606

Added default ports and exposed port from .env

9bba6a9

Merge branch 'main' of https://github.com/ekas-7/folksonomy_api

2667207

Update README.md

0dbeef9

Update README.md

b9c931c

ekas-7 requested review from alexgarel and areebahmeddd March 13, 2025 16:43

ekas-7 and others added 2 commits March 15, 2025 18:57

Merge branch 'openfoodfacts:main' into main

ba25243

Corrected naming mistake

5f244e2

ekas-7 and others added 3 commits March 18, 2025 19:28

Merge branch 'main' into orignal

c8525ba

Merge pull request #2 from ekas-7/orignal

ecaa0f6

Orignal

Shifted from pip to poetry

f7639a6

teolemon added the 🐋 Docker label Mar 18, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add Docker support for Folksonomy API #254

feat: add Docker support for Folksonomy API #254

ekas-7 commented Mar 12, 2025 •

edited

Loading

areebahmeddd commented Mar 13, 2025 •

edited

Loading

codecov-commenter commented Mar 13, 2025 •

edited

Loading

alexgarel left a comment

alexgarel Mar 13, 2025

ekas-7 Mar 13, 2025

alexgarel Mar 13, 2025

ekas-7 Mar 13, 2025

alexgarel Mar 13, 2025

ekas-7 Mar 13, 2025

alexgarel Mar 13, 2025

alexgarel Mar 13, 2025

ekas-7 Mar 13, 2025

alexgarel Mar 13, 2025

ekas-7 Mar 13, 2025

alexgarel Mar 13, 2025

ekas-7 Mar 13, 2025

alexgarel Mar 13, 2025

ekas-7 Mar 13, 2025

ekas-7 commented Mar 13, 2025

ekas-7 commented Mar 13, 2025

alexgarel commented Mar 18, 2025

ekas-7 commented Mar 18, 2025

ekas-7 commented Mar 18, 2025 •

edited

Loading

		# Copy the local_settings example to local_settings.py (if not exists)
		RUN if [ ! -f local_settings.py ]; then cp local_settings_example.py local_settings.py; fi

		CMD python db-migration.py && \
		uvicorn folksonomy.api:app --host 0.0.0.0 --port 8000 --proxy-headers

feat: add Docker support for Folksonomy API #254

Are you sure you want to change the base?

feat: add Docker support for Folksonomy API #254

Conversation

ekas-7 commented Mar 12, 2025 • edited Loading

What

Screenshot

Fixes bug(s)

Part of

areebahmeddd commented Mar 13, 2025 • edited Loading

codecov-commenter commented Mar 13, 2025 • edited Loading

Codecov Report

alexgarel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ekas-7 commented Mar 13, 2025

ekas-7 commented Mar 13, 2025

alexgarel commented Mar 18, 2025

ekas-7 commented Mar 18, 2025

ekas-7 commented Mar 18, 2025 • edited Loading

ekas-7 commented Mar 12, 2025 •

edited

Loading

areebahmeddd commented Mar 13, 2025 •

edited

Loading

codecov-commenter commented Mar 13, 2025 •

edited

Loading

ekas-7 commented Mar 18, 2025 •

edited

Loading