Skip to content

Add Sidecar details into the README file #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 7, 2025
Merged

Add Sidecar details into the README file #9

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b5f0bb
Add Sidecar details into the README file
nanehambardzumyan Aug 5, 2025
31c199d
update
nanehambardzumyan Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Todo API is a simple RESTful service for managing a to-do list, allowing users t

## Prerequisites

- [Docker](https://www.docker.com/get-started)
- [Docker](https://www.docker.com/get-started)
- [Docker Compose](https://docs.docker.com/compose/)

## Quick Start
Expand Down Expand Up @@ -73,3 +73,15 @@ python app/main.py
```

The API will read the configuration from `auth_config.yml`. If the file doesn't exist, it will default to no authentication.

## Sidecar Usage

The application is containerized and exposes port `8000`, making it suitable for use as a sidecar in various deployment scenarios.

The Docker container exposes port `8000`, allowing the API to be accessed from other containers or services in the same network. In order to enable it in the task, you need to add the following to the task configuration:
Copy link

Copilot AI Aug 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation lacks specific instructions on how to add the Docker image to the task configuration. Consider providing an example configuration snippet or referencing the specific configuration file/section where this should be added.

Copilot uses AI. Check for mistakes.


- **For PR testing**: `ghcr.io/codesignal/learn_todo-api:<pr-number>`
- Example: `ghcr.io/codesignal/learn_todo-api:pr-8`
- **For main branch**: `ghcr.io/codesignal/learn_todo-api:latest`

The sidecar can be used in base tasks and other containerized environments where you need a todo API service.