Skip to content

Commit d870b3b

Browse files
committed
Add open source and self-hosting section to CLOUD.md documentation
1 parent 92f03ea commit d870b3b

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

docs/CLOUD.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,68 @@ LRM Cloud is a web-based platform for team localization management with real-tim
66

77
![LRM Cloud Dashboard](../assets/cloud-dashboard.png)
88

9+
## Open Source & Deployment Options
10+
11+
LRM is a fully **open source project** under the MIT license. You have two options for using LRM Cloud:
12+
13+
### Option 1: Hosted Platform (Recommended)
14+
15+
Use our managed cloud platform at **[lrm-cloud.com](https://lrm-cloud.com)** — no setup required.
16+
17+
| Plan | Price | Best For |
18+
|------|-------|----------|
19+
| **Free** | $0/month | Personal projects, evaluation |
20+
| **Team** | $9/month | Small teams, startups |
21+
| **Enterprise** | $29/month | Large teams, high volume |
22+
23+
All plans include the full feature set. [See pricing details](#plans--pricing) for limits.
24+
25+
### Option 2: Self-Hosted
26+
27+
Deploy LRM Cloud on your own infrastructure using Docker Compose.
28+
29+
**Requirements:**
30+
- Docker & Docker Compose
31+
- Linux server (Ubuntu 20.04+ recommended)
32+
- Domain with SSL certificate (optional but recommended)
33+
34+
**Quick Start:**
35+
36+
```bash
37+
# Clone the repository
38+
git clone https://github.com/nickprotop/LocalizationManager.git
39+
cd LocalizationManager/cloud/deploy
40+
41+
# Run interactive setup (first time only)
42+
./setup.sh
43+
44+
# Build and deploy
45+
./deploy.sh
46+
```
47+
48+
The `setup.sh` script interactively configures:
49+
- Database credentials and connection
50+
- Domain name and SSL settings
51+
- API keys for translation providers
52+
- nginx configuration from templates
53+
54+
The `deploy.sh` script handles building and deploying.
55+
56+
**Self-Hosted Components:**
57+
58+
| Service | Purpose |
59+
|---------|---------|
60+
| nginx | Reverse proxy, SSL termination |
61+
| api | REST API server |
62+
| web | Blazor WASM frontend |
63+
| postgres | PostgreSQL 16 database |
64+
| redis | Session cache |
65+
| minio | S3-compatible storage (optional) |
66+
67+
For detailed deployment instructions, see [`cloud/deploy/README.md`](../cloud/deploy/README.md).
68+
69+
---
70+
971
## Features
1072

1173
- **Web-based Translation Editor** - Edit translations in a spreadsheet-like interface

0 commit comments

Comments
 (0)