Skip to content
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.

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

docs: deployment with nginx #2244

Closed
wants to merge 5 commits into from
Closed

Conversation

NikhilKalloli
Copy link

Closes #1232

📑 Description

Added documentation for deploying Keep with Nginx as a reverse proxy. The documentation includes:

  • Basic Nginx configuration
  • Step-by-step installation guide
  • SSL certificate setup
  • Troubleshooting tips

Changes made:

  • Added new file: deployment/nginx.mdx
  • Added comprehensive Nginx configuration examples
  • Included SSL/TLS setup instructions
  • Added troubleshooting section

This documentation follows the same structure as the existing Kubernetes deployment guide for consistency. It provides users with a clear path to deploy Keep behind an Nginx reverse proxy with proper security configurations.

Copy link

vercel bot commented Oct 19, 2024

@NikhilKalloli is attempting to deploy a commit to the KeepHQ Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLAassistant commented Oct 19, 2024

CLA assistant check
All committers have signed the CLA.

@shahargl
Copy link
Member

Hey @NikhilKalloli, thanks! Looks cool! In order for me to check the tutorial, can you add a docker compose deploying Keep with nginx? You’ve plenty of docker compose examples in the repo.

@NikhilKalloli
Copy link
Author

Hey @shahargl, Thanks for responding! May I know in which folder shall I add docker compose deploying Keep with nginx?
I see that most of docker compose are in root folder but according to my knowledge they aren't meant for docs.

@shahargl shahargl added Documentation Improvements or additions to documentation API API related issues Architecture Requires an architecture change/review labels Oct 20, 2024
@shahargl shahargl self-requested a review October 20, 2024 07:09
@NikhilKalloli
Copy link
Author

Hey @shahargl I've created a docker-compose to deploy with ngnix. May I know in folder can I add that file so that it's easier for you to review it?

@Matvey-Kuk Matvey-Kuk self-requested a review October 21, 2024 07:14
@talboren talboren changed the title Add ngnix doc docs: deployment with nginx Oct 22, 2024
@talboren
Copy link
Member

Hey @shahargl I've created a docker-compose to deploy with ngnix. May I know in folder can I add that file so that it's easier for you to review it?

all docker-compose files are at the root level directory (see https://github.com/keephq/keep/blob/main/docker-compose.common.yml for example). You can put it there too, with an indicative name :)

Copy link

vercel bot commented Oct 22, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
keep ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 22, 2024 7:19pm

@NikhilKalloli
Copy link
Author

Hey @talboren @shahargl @Matvey-Kuk , I've created a docker-compose-ngnix.yml in root folder with ngnix-tut.md for reference.
Can you please review it and let me know the follow-ups.

Copy link
Member

@talboren talboren left a comment

Choose a reason for hiding this comment

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

see comments 🙏🏼

@deployment/docker-compose-nginx.yml Outdated Show resolved Hide resolved
@@ -0,0 +1,8 @@
1. Make sure you have a docker-compose.common.yml file with the common service configurations.
Copy link
Member

Choose a reason for hiding this comment

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

not sure what is this file for

Copy link
Author

Choose a reason for hiding this comment

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

Hey @talboren
To avoid duplication services like keep-frontend and keep-backend are extended from docker-compose.common.yml. They inherit all the configurations defined in docker-compose.common.yml.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Oct 24, 2024
sudo apt-get update
```
```
sud apt-get install certbot python3-certbot-nginx
Copy link
Member

Choose a reason for hiding this comment

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

sudo

@Matvey-Kuk
Copy link
Contributor

Thank you for the contribution! Closing for now since it's not working. Please open a new PR once it's ready!

@Matvey-Kuk Matvey-Kuk closed this Oct 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API API related issues Architecture Requires an architecture change/review Documentation Improvements or additions to documentation size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[📃 Docs]: add docs how to deploy Keep with nginx
5 participants