Skip to content

fix: remove unnecessary configuration + add documentation for HTTPS #89

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
kevbang merged 1 commit into from
Feb 10, 2026
Merged

fix: remove unnecessary configuration + add documentation for HTTPS #89

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion CulinaryCommandApp/appsettings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"ConnectionStrings": {
"DefaultConnection": ""
},
"https_port": 443,
"Logging": {
"LogLevel": {
"Default": "Information",
Expand Down
29 changes: 23 additions & 6 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,12 @@ All related information to documentation is located under the `docs/` directory.

## Table of Contents

- [Terraform](#terraform)
- [Analytics Reporting Dashboard](#dashboard)

- [Introduction](#introduction)
- [How To Contribute](#how-to-contribute)
- [Table of Contents](#table-of-contents)
- [Terraform {#terraform}](#terraform-terraform)
- [Analytics Reporting Dashboard {#dashboard}](#analytics-reporting-dashboard-dashboard)
- [HTTPS Configuration {#HTTPS-configuration}](#https-configuration-https-configuration)
## Terraform {#terraform}

[Terraform](https://developer.hashicorp.com/terraform) is an Infrastructure as Code (IaC) tool that deploys all AWS related infrastructure. This is automatically done through the CI/CD pipeline.
Expand All @@ -51,7 +54,7 @@ All related information to documentation is located under the `docs/` directory.
</style>

<!-- Files -->
<details>
<details markdown="1">
<summary>Files</summary>

The Terraform configuration for this project lives in the repository's `terraform/` folder. Key files you will find here:
Expand All @@ -66,15 +69,15 @@ The Terraform configuration for this project lives in the repository's `terrafor
</details>

<!-- Purpose -->
<details>
<details markdown="1">
<summary>Purpose</summary>

This directory provisions the project's cloud environment. As of now, it is responsible for deploying the lightsail instance that we use to host Culinary Command.

</details>

<!-- How to use -->
<details>
<details markdown="1">
<summary>Getting started</summary>

The `terraform/` directory will only be changed when there needs to be infrastructure changes. For Culinary Command, it has been configured to automatically deploy infrastructure changes (via CI/CD). To get started, refer to [the official Terraform documentation](https://developer.hashicorp.com/terraform/intro). If you have any questions, reach out to Kevin.
Expand All @@ -92,4 +95,18 @@ In `AIDashboard/Services/Reporting/AIReportingService.cs`, there is a function `

**Note that this is temporary as the information is not reliable.**

## HTTPS Configuration {#HTTPS-configuration}

The lightsail instance leverages a [reverse proxy](https://www.cloudflare.com/learning/cdn/glossary/reverse-proxy/) via Nginx to intercept HTTP traffic and points it the Blazor web app. The configuration for this can be found in the lightsail instance directory: `/etc/nginx/sites-available/culinarycommand`.

SSL certificates are provided by `Let's Encrypt/Certbot` and will have to be rotated every 3 months. Once the team decides to migrate to different infrastructure, `Caddy` will most likely be used since it handles configuration and SSL certificate rotation.

Useful resources/documentation:
- [Nginx configuration on Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-nginx-on-ubuntu-20-04#step-5-%E2%80%93-setting-up-server-blocks-(recommended))
- [Initial server setup](https://www.digitalocean.com/community/tutorials/initial-server-setup-with-ubuntu-20-04) (only referenced Step 4)
- [Using Nginx with Let's Encrypt & Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-20-04)
- [Certbot getting started](https://certbot.eff.org/instructions?ws=nginx&os=snap)
- [Let's Encrypt getting started](https://letsencrypt.org/getting-started/)

**Reach out to Kevin if you have any questions!**

Loading