Documentation + tutorial blog for self-hosted MongoDB release#2823
Documentation + tutorial blog for self-hosted MongoDB release#2823atharvadeosthale wants to merge 23 commits intomainfrom
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThis PR adds MongoDB support for self-hosted Appwrite and introduces a web-based setup wizard served on port 20080. It adds new documentation and blog pages (MongoDB integration, self-hosting tutorial, announcement, changelog), a Databases configuration doc and nav item, updates installation, backups, scaling, updates, and environment-variable docs (adds Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Greptile SummaryThis PR adds comprehensive documentation and tutorial content for the Appwrite 1.9.0 MongoDB self-hosting release. It introduces two new blog posts (a partnership announcement and a step-by-step tutorial), a new integration page, a new databases configuration doc, and updates to the installation, backups, scaling, environment variables, and upgrade guides — all backed by newly added wizard screenshots and cover images. Key changes:
Confidence Score: 5/5Safe to merge — all findings are P2 style/documentation gaps with no runtime or data-integrity impact. The only finding is a P2 documentation inconsistency in the upgrade guide (missing browser navigation instructions to accompany the newly added --publish 20080:20080 flag). All content is internally consistent, images are present, author references are valid, and the new docs pages are well-structured. No code logic is changed. src/routes/docs/advanced/self-hosting/production/updates/+page.markdoc — needs either a browser navigation instruction or removal of the --publish flag Important Files Changed
Reviews (4): Last reviewed commit: "Apply suggestion from @adityaoberai" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
src/routes/blog/post/self-hosting-appwrite-with-mongodb/+page.markdoc (1)
56-84: Prefer theme-aware screenshots in the blog body.Right now the tutorial uses dark screenshots only. In light mode, these can feel low-contrast and out of place. Consider pairing dark/light variants as done in docs pages.
♻️ Suggested pattern
- +{% only_dark %} + +{% /only_dark %} +{% only_light %} + +{% /only_light %}Apply the same pattern to the secure/account/review images.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/routes/blog/post/self-hosting-appwrite-with-mongodb/`+page.markdoc around lines 56 - 84, The dark-only screenshots in +page.markdoc make the blog look low-contrast in light theme; update the image blocks for wizard-setup.png, wizard-secure.png, wizard-account.png, and wizard-review.png to use theme-aware pairs (dark + light variants) following the docs pattern: replace each single img line with the theme-aware include used elsewhere in the docs so the template selects the correct /images/.../dark/... and /images/.../light/... files at render time and add the matching light variants to the assets if they don't exist.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@src/routes/docs/advanced/self-hosting/configuration/environment-variables/`+page.markdoc:
- Line 63: The current line implies the database backend is chosen only during
installation; update the wording to explicitly state the backend can be set via
the _APP_DB_ADAPTER environment variable at runtime (not just at install time)
and point readers to the environment variable section where _APP_DB_ADAPTER is
documented; reference the existing sentence in the file and replace or append
text clarifying runtime configurability and linking to the Databases and
Environment Variables sections.
In `@src/routes/docs/advanced/self-hosting/installation/`+page.markdoc:
- Around line 68-69: The line containing the URL literal
"http://localhost:20080" should be expanded to clarify remote-host access:
update the text so it tells users that for remote or non-local installs they
must use the server's IP address or domain (e.g., http://SERVER_IP:20080 or
http://your-domain:20080) instead of localhost so the setup wizard is reachable
from other machines; edit the sentence around that URL in +page.markdoc to
include both localhost (for local installs) and the server IP/domain option for
remote installs.
---
Nitpick comments:
In `@src/routes/blog/post/self-hosting-appwrite-with-mongodb/`+page.markdoc:
- Around line 56-84: The dark-only screenshots in +page.markdoc make the blog
look low-contrast in light theme; update the image blocks for wizard-setup.png,
wizard-secure.png, wizard-account.png, and wizard-review.png to use theme-aware
pairs (dark + light variants) following the docs pattern: replace each single
img line with the theme-aware include used elsewhere in the docs so the template
selects the correct /images/.../dark/... and /images/.../light/... files at
render time and add the matching light variants to the assets if they don't
exist.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2e277128-298d-4d9c-919b-348aae7d2a38
⛔ Files ignored due to path filters (8)
static/images/docs/advanced/self-hosting/installation/dark/wizard-account.pngis excluded by!**/*.pngstatic/images/docs/advanced/self-hosting/installation/dark/wizard-review.pngis excluded by!**/*.pngstatic/images/docs/advanced/self-hosting/installation/dark/wizard-secure.pngis excluded by!**/*.pngstatic/images/docs/advanced/self-hosting/installation/dark/wizard-setup.pngis excluded by!**/*.pngstatic/images/docs/advanced/self-hosting/installation/wizard-account.pngis excluded by!**/*.pngstatic/images/docs/advanced/self-hosting/installation/wizard-review.pngis excluded by!**/*.pngstatic/images/docs/advanced/self-hosting/installation/wizard-secure.pngis excluded by!**/*.pngstatic/images/docs/advanced/self-hosting/installation/wizard-setup.pngis excluded by!**/*.png
📒 Files selected for processing (9)
.optimize-cache.jsonsrc/routes/blog/post/self-hosting-appwrite-with-mongodb/+page.markdocsrc/routes/docs/advanced/self-hosting/+layout.sveltesrc/routes/docs/advanced/self-hosting/configuration/databases/+page.markdocsrc/routes/docs/advanced/self-hosting/configuration/environment-variables/+page.markdocsrc/routes/docs/advanced/self-hosting/installation/+page.markdocsrc/routes/docs/advanced/self-hosting/production/backups/+page.markdocsrc/routes/docs/advanced/self-hosting/production/scaling/+page.markdocsrc/routes/docs/advanced/self-hosting/production/updates/+page.markdoc
src/routes/docs/advanced/self-hosting/configuration/environment-variables/+page.markdoc
Show resolved
Hide resolved
| Once the command is running, open your browser and navigate to `http://localhost:20080` to access the setup wizard. | ||
|
|
There was a problem hiding this comment.
Clarify remote-host access URL in setup instructions.
Line 68 currently points only to localhost. For remote installs, users should be told to use the server IP/domain on port 20080 to avoid failed access attempts.
🛠️ Suggested wording
-Once the command is running, open your browser and navigate to `http://localhost:20080` to access the setup wizard.
+Once the command is running, open your browser and navigate to `http://localhost:20080` (or `http://<your-server-ip>:20080` for remote installs) to access the setup wizard.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Once the command is running, open your browser and navigate to `http://localhost:20080` to access the setup wizard. | |
| Once the command is running, open your browser and navigate to `http://localhost:20080` (or `http://<your-server-ip>:20080` for remote installs) to access the setup wizard. | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@src/routes/docs/advanced/self-hosting/installation/`+page.markdoc around
lines 68 - 69, The line containing the URL literal "http://localhost:20080"
should be expanded to clarify remote-host access: update the text so it tells
users that for remote or non-local installs they must use the server's IP
address or domain (e.g., http://SERVER_IP:20080 or http://your-domain:20080)
instead of localhost so the setup wizard is reachable from other machines; edit
the sentence around that URL in +page.markdoc to include both localhost (for
local installs) and the server IP/domain option for remote installs.
src/routes/blog/post/self-hosting-appwrite-with-mongodb/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/blog/post/self-hosting-appwrite-with-mongodb/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/blog/post/self-hosting-appwrite-with-mongodb/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/blog/post/self-hosting-appwrite-with-mongodb/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/blog/post/self-hosting-appwrite-with-mongodb/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/docs/advanced/self-hosting/configuration/databases/+page.markdoc
Show resolved
Hide resolved
src/routes/blog/post/self-hosting-appwrite-with-mongodb/+page.markdoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Aditya Oberai <adityaoberai1@gmail.com>
| ## CMD | ||
| ```cmd | ||
| docker run -it --rm ^ | ||
| --publish 20080:20080 ^ | ||
| --volume //var/run/docker.sock:/var/run/docker.sock ^ | ||
| --volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^ | ||
| --entrypoint="install" ^ | ||
| appwrite/appwrite:1.9.0 | ||
| ``` | ||
|
|
||
| ## PowerShell | ||
| ```powershell | ||
| docker run -it --rm ` | ||
| --publish 20080:20080 ` | ||
| --volume /var/run/docker.sock:/var/run/docker.sock ` | ||
| --volume ${pwd}/appwrite:/usr/src/code/appwrite:rw ` | ||
| --entrypoint="install" ` | ||
| appwrite/appwrite:1.9.0 | ||
| ``` |
There was a problem hiding this comment.
Instead of using headings, you can just write a sentence or even maybe have two tabs: Windows (CMD) and Windows (Powershell)
Right now this looks weird @atharvadeosthale
src/routes/blog/post/appwrite-mongodb-partnership-self-hosted/+page.markdoc
Outdated
Show resolved
Hide resolved
|
|
||
| Here's what's on the roadmap: | ||
|
|
||
| - **MongoDB on Appwrite Cloud.** MongoDB will be available in a fully managed environment. The console will adapt dynamically when running on MongoDB, and the experience will feel first-class from day one. |
There was a problem hiding this comment.
maybe mention the self-hosted solution as something that is already available as the first step of this.
There was a problem hiding this comment.
sorry I see this mentioned later, maybe I would switch the two section for chronological sense
src/routes/blog/post/appwrite-mongodb-partnership-self-hosted/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/blog/post/appwrite-mongodb-partnership-self-hosted/+page.markdoc
Outdated
Show resolved
Hide resolved
src/routes/blog/post/appwrite-mongodb-partnership-self-hosted/+page.markdoc
Outdated
Show resolved
Hide resolved
5 participants
Summary by CodeRabbit