File tree Expand file tree Collapse file tree 1 file changed +13
-1
lines changed Expand file tree Collapse file tree 1 file changed +13
-1
lines changed Original file line number Diff line number Diff line change @@ -4,7 +4,7 @@ Todo API is a simple RESTful service for managing a to-do list, allowing users t
4
4
5
5
## Prerequisites
6
6
7
- - [ Docker] ( https://www.docker.com/get-started )
7
+ - [ Docker] ( https://www.docker.com/get-started )
8
8
- [ Docker Compose] ( https://docs.docker.com/compose/ )
9
9
10
10
## Quick Start
@@ -73,3 +73,15 @@ python app/main.py
73
73
` ` `
74
74
75
75
The API will read the configuration from `auth_config.yml`. If the file doesn't exist, it will default to no authentication.
76
+
77
+ # # Sidecar Usage
78
+
79
+ The application is containerized and exposes port `8000`, making it suitable for use as a sidecar in various deployment scenarios.
80
+
81
+ The Docker container exposes port `8000`, allowing the API to be accessed from other containers or services in the same network.
82
+
83
+ - **For PR testing**: `ghcr.io/codesignal/learn_todo-api:<pr-number>`
84
+ - Example : ` ghcr.io/codesignal/learn_todo-api:pr-8`
85
+ - **For main branch**: `ghcr.io/codesignal/learn_todo-api:latest`
86
+
87
+ The sidecar can be used in base tasks and other containerized environments where you need a todo API service.
You can’t perform that action at this time.
0 commit comments