6/8 - Public Beta (Discord)|See Changelog
Skip to main content

Installation Methods Overview

🚧 Under Heavy Development​

OpenLift is currently under heavy development and we have not released any versions yet.

All installation documents are placeholders for future releases. These pages document the planned installation methods but are not yet functional.

OpenLift service installation methods and deployment options. Choose the method that best fits your infrastructure requirements.

🚧 Docker Installation​

Currently Under Development

Docker installation is planned for future releases. A pre-built Docker image is not yet available.

Current Status​

  • Docker images are not published to any registry
  • Docker Compose configuration is in development
  • Manual installation is currently recommended

Future Docker Features (Planned)​

  • Pre-built images with optimized layers
  • Multi-architecture support (x64, ARM64)
  • Production-ready Docker Compose templates
  • Health checks and monitoring integration

For now, manual installation is the recommended approach for both development and production deployments.

Prerequisites​

  • Node.js 18+ with npm
  • MongoDB database
  • Object storage (Cloudflare R2 or MinIO)

Quick Setup Steps​

  1. Clone the repository
  2. Copy default.env to .env and configure environment variables
  3. Generate JWT RSA key pair
  4. Install dependencies: npm install
  5. Run database setup: npm run db:push:mongo
  6. Start the service: npm run dev (development) or npm run build && npm start (production)

👉 See the Environment Variables Guide for complete configuration details.

✅ Next Steps​

  1. Review Environment Variables: Understand all required configuration options
  2. Set Up Dependencies: Configure MongoDB and object storage
  3. Generate Security Keys: Create JWT RSA key pairs
  4. Run Manual Installation: Follow the manual setup process
  5. Monitor for Docker Updates: Docker installation will be available in future releases