History

Bartlomiej Mika f4a49ad4b9 Typofix		2025-12-02 14:53:07 -05:00
..
development	Typofix	2025-12-02 14:53:07 -05:00
production	Initial commit: Open sourcing all of the Maple Open Technologies code.	2025-12-02 14:33:08 -05:00
README.md	Initial commit: Open sourcing all of the Maple Open Technologies code.	2025-12-02 14:33:08 -05:00

README.md

🏗️ Infrastructure

Infrastructure setup for running and deploying MapleFile software (MaplePress backend, MapleFile, etc.), organized for both development and production environments.

📂 Directory Structure

infrastructure/
├── development/          # Local development infrastructure
│   ├── docker-compose.dev.yml
│   ├── Taskfile.yml
│   └── README.md        # Development setup instructions
│
└── production/          # Production deployment infrastructure
    ├── docker-compose.yml
    ├── .env.sample
    ├── README.md        # Production deployment guide
    ├── nginx/           # Reverse proxy configuration
    ├── monitoring/      # Prometheus + Grafana
    ├── backup/          # Backup automation
    └── scripts/         # Deployment automation

🚀 Quick Start

For Local Development

If you're a contributor or want to run the project locally:

👉 Go to development/README.md

This gives you:

Local Cassandra cluster (3 nodes)
Redis cache
Meilisearch for search
SeaweedFS for object storage
WordPress for plugin testing
All pre-configured for local development

Quick start:

cd development
task dev:start

For Production Deployment

If you're self-hosting or deploying to production:

👉 Go to production/README.md

This provides:

Production-ready Docker Compose setup
SSL/TLS configuration with Let's Encrypt
Nginx reverse proxy
Monitoring with Prometheus + Grafana
Automated backups
Security hardening
Deployment automation

⚠️ Note: Production setup requires:

A server (VPS, cloud instance, or dedicated server)
A domain name with DNS configured
Basic Linux administration knowledge

🎯 Which One Should I Use?

Scenario	Use This	Location
Contributing to the project	Development	`development/`
Running locally for testing	Development	`development/`
Learning the architecture	Development	`development/`
Self-hosting for personal use	Production	`production/`
Deploying for others to use	Production	`production/`
Running a SaaS business	Production	`production/`

📚 Documentation

Development Setup: development/README.md
Production Deployment: production/README.md
Architecture Overview: ../../CLAUDE.md

🤝 Contributing

Found a bug? Want to improve the infrastructure? Please create an issue.

📝 License

This infrastructure is licensed under the GNU Affero General Public License v3.0. See LICENSE for more information.