docs: add Let's Encrypt email configuration note#3118
Open
hamzainayat20 wants to merge 1 commit into
Open
Conversation
Contributor
Greptile SummaryThis PR adds Let's Encrypt guidance to the manual self-hosting installation page. The main change is:
Confidence Score: 4/5The certificate configuration note names an unused variable and needs correction before merging.
src/routes/docs/advanced/self-hosting/installation/+page.markdoc Important Files Changed
Prompt To Fix All With AIFix the following 1 code review issue. Work through them one at a time, proposing concise fixes.
---
### Issue 1 of 1
src/routes/docs/advanced/self-hosting/installation/+page.markdoc:142
**Certificate Email Variable Is Ignored**
The manual installation configuration does not recognize the singular `_APP_EMAIL_CERTIFICATE` name. An installer following this note will set an unused variable while the certificate email remains unchanged, so the note does not prevent the certificate issue it describes.
```suggestion
If you plan to use Let's Encrypt for SSL certificates, make sure the `_APP_SYSTEM_SECURITY_EMAIL_ADDRESS` environment variable in your `appwrite/.env` file is set to a valid email address before starting Appwrite.
```
Reviews (1): Last reviewed commit: "docs: add Let's Encrypt email configurat..." | Re-trigger Greptile |
| 2. Edit the `.env` file to customize your installation. At minimum, update `_APP_OPENSSL_KEY_V1` and `_APP_EXECUTOR_SECRET` with unique secret values | ||
|
|
||
| {% info title="Let's Encrypt" %} | ||
| If you plan to use Let's Encrypt for SSL certificates, make sure the `_APP_EMAIL_CERTIFICATE` environment variable in your `appwrite/.env` file is set to a valid email address before starting Appwrite. Without this value, Let's Encrypt certificates cannot be issued. |
Contributor
There was a problem hiding this comment.
Certificate Email Variable Is Ignored
The manual installation configuration does not recognize the singular _APP_EMAIL_CERTIFICATE name. An installer following this note will set an unused variable while the certificate email remains unchanged, so the note does not prevent the certificate issue it describes.
Suggested change
| If you plan to use Let's Encrypt for SSL certificates, make sure the `_APP_EMAIL_CERTIFICATE` environment variable in your `appwrite/.env` file is set to a valid email address before starting Appwrite. Without this value, Let's Encrypt certificates cannot be issued. | |
| If you plan to use Let's Encrypt for SSL certificates, make sure the `_APP_SYSTEM_SECURITY_EMAIL_ADDRESS` environment variable in your `appwrite/.env` file is set to a valid email address before starting Appwrite. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: src/routes/docs/advanced/self-hosting/installation/+page.markdoc
Line: 142
Comment:
**Certificate Email Variable Is Ignored**
The manual installation configuration does not recognize the singular `_APP_EMAIL_CERTIFICATE` name. An installer following this note will set an unused variable while the certificate email remains unchanged, so the note does not prevent the certificate issue it describes.
```suggestion
If you plan to use Let's Encrypt for SSL certificates, make sure the `_APP_SYSTEM_SECURITY_EMAIL_ADDRESS` environment variable in your `appwrite/.env` file is set to a valid email address before starting Appwrite.
```
How can I resolve this? If you propose a fix, please make it concise.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Adds a note to the manual installation documentation explaining that the
_APP_EMAIL_CERTIFICATEenvironment variable should be set before starting Appwrite when using Let's Encrypt.Why?
Without this value, Let's Encrypt cannot issue SSL certificates. This note helps users avoid a common configuration issue during self-hosted installations.
Closes #2698