docs: Added docker support documentation

[YuvalBubnovsky]

User description

Description

Added docker-support.md to facilitate a designated space for docker documentation

Fixes #279

Dependencies

None.

Future Improvements

Expand when new docker features are implemented for the project.

Mentions

@rajdip-b

Screenshots of relevant screens

N/A

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

PR Type

Documentation

---

Description

• Added a new documentation file docker-support.md to provide detailed instructions on building and running applications using Docker.
• Included prerequisites for Docker installation and usage.
• Provided specific commands for building and running the Web Application, API, and Platform using Docker.
• Detailed port usage and environment variable requirements.
• Instructions for starting and stopping services using Docker Compose.

---

Changes walkthrough 📝

	Relevant files
Documentation	docker-support.md Add Docker support documentation with usage instructions  docs/contributing-to-keyshade/running-things-locally/docker-support.md Added a new document for Docker support. Included instructions for building and running applications using Docker. Listed prerequisites and port usage details. Provided commands for starting and stopping services. +93/-0

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	Add instructions for viewing Docker container logs to aid in troubleshooting Add information about viewing logs for the Docker containers, which can be helpful for troubleshooting. docs/contributing-to-keyshade/running-things-locally/docker-support.md [89-93] docker compose down +``` + +## Viewing Logs + +To view logs for a specific service: + +```bash +docker compose logs [service_name] +``` + +For example, to view logs for the API service: + +```bash +docker compose logs api For more detailed information about Docker usage, refer to the official Docker documentation. - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=0 --> <details><summary>Suggestion importance[1-10]: 8</summary> Why: Including log viewing instructions is a valuable addition for troubleshooting, making it easier for users to diagnose issues with their Docker containers. </details></details></td><td align=center>8 </td></tr><tr><td> <details><summary>Explain data persistence in Docker to clarify how data is stored and managed across container restarts</summary> ___ **Add a section about data persistence and volumes, explaining how data is stored and <br>persisted across container restarts.** [docs/contributing-to-keyshade/running-things-locally/docker-support.md [75-77]](https://github.com/keyshade-xyz/keyshade/pull/465/files#diff-ed4f7653f96a273f643129eb762cc422377a89d31c3a6fe0327f355f926c8ccaR75-R77) ```diff ## Environment Variables All applications use environment variables from a `.env` file. Ensure this file is present in your project root directory with the necessary configurations. +## Data Persistence + +Docker containers are ephemeral by nature. To persist data across container restarts, we use Docker volumes. The `docker-compose.yml` file defines volumes for each service that requires data persistence. These volumes are automatically created and managed by Docker. + +To list all volumes: + +```bash +docker volume ls +``` + +To inspect a specific volume: + +```bash +docker volume inspect [volume_name] +``` + Apply this suggestion Suggestion importance[1-10]: 8 Why: Adding a section on data persistence is important for users to understand how to manage data across container restarts, making the document more comprehensive and practical.	8
	Introduce Docker Compose earlier in the document to provide context for running all services together Consider adding a section about Docker Compose for running all services together, as it's mentioned in the "Starting and Stopping Services" section but not explained earlier. docs/contributing-to-keyshade/running-things-locally/docker-support.md [13-21] ## Available Applications We have Docker support for the following applications: 1. Web Application 2. API 3. Platform +These applications can be run individually or together using Docker Compose. + ## Building and Running Applications +### Individual Applications + Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion improves the document by providing context for Docker Compose usage earlier, enhancing clarity for users who may want to run all services together.	7
	Explain Docker networking to clarify how the services interact within the Docker environment Include information about Docker network creation and how the services communicate with each other within the Docker environment. docs/contributing-to-keyshade/running-things-locally/docker-support.md [65-73] -## Port Usage +## Port Usage and Networking The applications use the following ports by default: - Web Application: 3000 - API: 4200 - Platform: 3025 Ensure these ports are available on your system. If you need to use different ports, you can modify the port mappings in the `package.json` file locally. +When running with Docker Compose, these services are connected to a common network, allowing them to communicate with each other using their service names as hostnames. + Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion provides useful information about Docker networking, which helps users understand how services communicate, enhancing the document's completeness.	7

💡 Need additional feedback ? start a PR chat

[YuvalBubnovsky]

PR Code Suggestions ✨

Category Suggestion Score
Enhancement
Add instructions for viewing Docker container logs to aid in troubleshooting

8
Introduce Docker Compose earlier in the document to provide context for running all services together

7
Explain Docker networking to clarify how the services interact within the Docker environment

7

💡 Need additional feedback ? start a PR chat

I agree with introducing docker compose earlier in the document.

but I'm not sure about the other comments, for example: adding an instruction on how to view docker logs is something you would likely see in a general docker documentation, not in a project specific one (especially if we don't even have a command for it in package.json)
Same goes for explaining docker networking, I do not think this is something that should be added in this documentation.

But of course, if you believe these will be good additions I'll get to it.

Waiting on feedback for this.

[rajdip-b]

I agree with introducing docker compose earlier in the document.

I, too, believe that this would be a useful addition. So you can go ahead and add it.

[rajdip-b]

🎉 This PR is included in version 2.6.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀