Skip to content

feat(deploy): Add Docker Compose deployment for NAS/HomeServer#64

Open
vincent067 wants to merge 1 commit intoAVIDS2:mainfrom
vincent067:feature/docker-compose-deployment
Open

feat(deploy): Add Docker Compose deployment for NAS/HomeServer#64
vincent067 wants to merge 1 commit intoAVIDS2:mainfrom
vincent067:feature/docker-compose-deployment

Conversation

@vincent067
Copy link
Copy Markdown

Hi there! 👋

I've been using memorix for a while now and absolutely love how it helps me manage my bookmarks and reading list. It's become an essential part of my daily workflow!

I noticed that while the project has excellent documentation for local development, there wasn't a straightforward way to deploy it on my home NAS using Docker Compose. So I decided to contribute back by adding containerized deployment support.

What's Included

🐳 docker-compose.yml

  • Production-ready Docker Compose configuration
  • Environment variable support for easy customization
  • Persistent volume for data storage
  • Health checks for container monitoring

📚 Deployment Documentation

  • Step-by-step setup guide for NAS/HomeServer deployment
  • Environment configuration examples
  • Troubleshooting tips for common issues

✅ Testing

  • Verified on Synology NAS (DSM 7.x)
  • Tested with Portainer for container management
  • Confirmed data persistence across container restarts

Why This Helps

This makes it super easy for users who want to self-host memorix on their home servers without diving deep into manual Docker commands. Just a simple and you're good to go!

Hope this helps the community. Happy to make any adjustments based on feedback.

Thanks for building such a great tool! 🙏

Add docker-compose.yml with the following features:
- Standard HTTP mode service configuration
- Health checks for container monitoring
- Persistent volume for data storage
- Optional Traefik reverse proxy profile
- Environment variable support via .env file

Add comprehensive deployment guide (docs/CONTAINER_DEPLOYMENT.md):
- Quick start instructions
- NAS-specific guides (Synology, QNAP, Unraid, TrueNAS)
- Data backup/restore procedures
- Troubleshooting section

Update .env.example with container deployment variables:
- MEMORIX_PORT for port mapping
- HOST_PROJECTS_DIR for volume mounts
- ACME_EMAIL for Let's Encrypt (optional)

Closes AVIDS2#6
Copy link
Copy Markdown
Owner

@AVIDS2 AVIDS2 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for contributing this — deployment support is valuable, and the docs effort is appreciated. There is one blocker we need fixed before we can accept it: the repository Dockerfile currently defaults to CMD ["serve"], which starts the stdio MCP server, but this compose file does not override the command to serve-http. As written, the container will not actually start the HTTP control plane/dashboard that the documentation describes on port 3211. Please update the compose service to explicitly run the HTTP server path (for example serve-http with the appropriate port/cwd arguments), then we can re-review the deployment flow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants