Installation
Inkweld offers flexible deployment options to suit different needs, from quick local testing to production-ready cloud infrastructure.
Choose Your Deployment Method
🐳 Docker
RecommendedThe easiest and most reliable way to deploy Inkweld. Single container with everything included.
- One command to start
- Upgrade by pulling a new image
- Works anywhere Docker runs
☁️ Cloudflare Workers
Deploy to Cloudflare's global edge network for low-latency access worldwide.
- Global edge deployment
- Generous free tier
- Managed infrastructure
⚡ Native Binary
Build the standalone Bun binary from source and run it directly on your server without containerization.
- Minimal overhead
- Direct system access
- Custom integrations
Quick Comparison
| Feature | Docker | Cloudflare | Native |
|---|---|---|---|
| Ease of Setup | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐ | ⭐⭐⭐ |
| Scalability | ⭐⭐⭐ | ⭐⭐⭐⭐⭐ | ⭐⭐⭐ |
| Cost | Your hosting | Free tier available | Your hosting |
| Offline Support | ✅ Full | ⚠️ Limited | ✅ Full |
| Real-time Collab | ✅ WebSocket | ✅ Durable Objects | ✅ WebSocket |
| Best For | Most users | Global teams | Custom setups |
Client Apps
The server hosts the web client, which also installs as a Progressive Web App on phones, tablets and desktops. The app offers to install itself, or you can install it from Settings → General.
System Requirements
Minimum Requirements
- CPU: 1 core
- RAM: 512MB
- Storage: 1GB (plus space for your data)
- Network: Stable internet connection for collaboration features
Recommended for Production
- CPU: 2+ cores
- RAM: 2GB+
- Storage: SSD with 10GB+ free space
- Network: Low-latency connection for real-time collaboration
What's Next?
After installation, you'll want to:
- Configure your instance - Set up authentication, storage, and optional features
- Create your first project - Start writing!
- Set up user management - Manage access and permissions
Need Help?
Check the Troubleshooting guide if you run into issues, or open an issue on GitHub.