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

💡 [REQUEST] - Add Documentation for Enabling SSL with Nginx #344

Open
marrouchi opened this issue Nov 18, 2024 · 0 comments
Open

💡 [REQUEST] - Add Documentation for Enabling SSL with Nginx #344

marrouchi opened this issue Nov 18, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation important

Comments

@marrouchi
Copy link
Contributor

Start Date

No response

Implementation PR

No response

Reference Issues

No response

Summary

The Hexabot project should include documentation on how to enable SSL using Nginx in two different ways:

  1. Nginx as a Docker Container
  2. Nginx as a Standalone Service

This documentation should be added to the GitBook under a relevant section (e.g., "Deployment" or "Security").

Details to Include:

1. Nginx as a Docker Container

  • Required files:
    • docker-compose.nginx.dev.yml
    • docker-compose.nginx.prod.yml
    • docker-compose.nginx.yml
    • nginx/
    • init-letsencrypt.sh
  • Link to files: Hexabot Docker Files
  • Steps to generate initial SSL certificates:
    cd docker/
    chmod a+x init-letsencrypt.sh
    ./init-letsencrypt.sh
  • Command to start/stop services:
    hexabot start/stop --services nginx

2. Nginx as a Standalone Service

Basic Example

Drawbacks

Unresolved questions

No response

@marrouchi marrouchi added question Further information is requested documentation Improvements or additions to documentation and removed question Further information is requested labels Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation important
Projects
None yet
Development

No branches or pull requests

2 participants