docs: add Ubuntu prerequisites for Docker installation #10734
Conversation
📝 WalkthroughWalkthroughThis pull request updates README.md to add an "Ubuntu Prerequisites" subsection under Self-Hosting. The new section provides step-by-step Docker installation instructions for Ubuntu (apt update, install dependencies, add Docker GPG key and repository, install Docker, enable/start the service, add the user to the docker group, refresh group membership, and verify installation). No code or exported/public entities are modified; the change is documentation-only. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ 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 |
Security Scan Results for PRDocker Image Scan Results
Source Code Scan Results🎉 No vulnerabilities found! |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-07-08T01:20:14.364Z
Learnt from: stnguyen90
PR: appwrite/appwrite#10119
File: app/controllers/api/account.php:1226-1232
Timestamp: 2025-07-08T01:20:14.364Z
Learning: In Appwrite, `_APP_DOMAIN` is a required environment variable that must always be set for the system to function properly.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.18.1)
README.md
78-78: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: scan
🔇 Additional comments (1)
README.md (1)
78-111: Content quality is good; commands follow Docker's official guide.The step-by-step instructions are well-organized with helpful inline comments, and the commands accurately reflect Docker's official Ubuntu installation process. The important note about logout/login requirement at lines 110–111 is appropriately placed and beneficial for users.
|
Hi team , All commands have been tested on Ubuntu 22.04 LTS and verified against Docker’s official documentation. There are no code or functional changes — just improved clarity for new users. Could someone with write access please review and approve this PR when possible? Thank you for your time and support! |
📝 Description
This PR enhances the installation documentation by adding Ubuntu-specific Docker prerequisites. Many Ubuntu users struggle with Docker installation before they can start using Appwrite, so this addition provides clear, step-by-step instructions.
🎯 Type of Change
✨ Changes Made
🧪 Testing
📸 Screenshots
N/A - Documentation only
✅ Checklist
🔗 Related Issues
This helps Ubuntu users who need Docker prerequisites before installing Appwrite.
📚 Additional Context
These instructions are based on Docker's official Ubuntu installation guide and have been tested on Ubuntu 22.04 LTS. They should work on Ubuntu 20.04+ versions. This will save Ubuntu users time by providing all necessary prerequisites in one place, rather than requiring them to search for Docker installation guides separately.
💡 For Reviewers
This is a documentation-only change that adds significant value for the Ubuntu user community. The commands follow Docker's official installation procedures. No code or functionality changes are involved - purely documentation enhancement to improve the onboarding experience for Ubuntu users.
Thank you for reviewing! 🙏