|
| 1 | +--- |
| 2 | +description:Installation Guide |
| 3 | +--- |
| 4 | + |
| 5 | +#Installing Enterprise Edition |
| 6 | + |
| 7 | +To enable the full suite of Enterprise features for the self-hosted Lowcoder instance(s), you’ll need to prepare your infrastructure and apply the provided plugin and licenses. The process is straightforward and allows seamless upgrade of your Lowcoder environment. |
| 8 | + |
| 9 | +*** |
| 10 | + |
| 11 | +###Prerequisites |
| 12 | + |
| 13 | +Before installation, make sure the following are**ready and accessible**: |
| 14 | + |
| 15 | +***PostgreSQL Database**\ |
| 16 | + A separate PostgreSQL database is required for storing Enterprise feature metadata. |
| 17 | +***Redis Server**\ |
| 18 | + A separate (suggested) Redis Database is needed for caching and enhanced performance. |
| 19 | +***MaxMind Account (for GeoIP Logging)**\ |
| 20 | + Optional. It is used to enrich audit logs and app usage with geographic data. |
| 21 | + |
| 22 | +*** |
| 23 | + |
| 24 | +###Files You Will Receive |
| 25 | + |
| 26 | +Once you're licensed, we will provide: |
| 27 | + |
| 28 | +***Enterprise Plugin JAR**  |
| 29 | +***License File** |
| 30 | + |
| 31 | +*** |
| 32 | + |
| 33 | +###File Placement |
| 34 | + |
| 35 | +Ensure the following directories exist in your deployment stack and place the files accordingly for each deployment (stage / instance) |
| 36 | + |
| 37 | +| File Type| Path| |
| 38 | +| --------------| ---------------------------| |
| 39 | +| Plugin`.jar`|`/lowcoder-stacks/plugins`| |
| 40 | +| License`.lic`|`/lowcoder-stacks/licenses`| |
| 41 | + |
| 42 | +You can mount these volumes into your Docker container or place them directly if running natively. |
| 43 | + |
| 44 | +*** |
| 45 | + |
| 46 | +###Required Environment Variables |
| 47 | + |
| 48 | +Add the following variables to your Lowcoder`.env` file or Docker Compose environment: |
| 49 | + |
| 50 | +```env |
| 51 | +LOWCODER_PLUGINS_DIR=./lowcoder-stacks/plugins |
| 52 | +PLUGIN_ENTERPRISE_ENV_TYPE=DEV # or TEST, PREPROD, PROD |
| 53 | +
|
| 54 | +# PostgreSQL (Enterprise DB) |
| 55 | +PLUGIN_ENTERPRISE_DATABASE_URL=postgresql://yourhost:5432/lowcoder_enterprise |
| 56 | +PLUGIN_ENTERPRISE_DATABASE_USER=lowcoder |
| 57 | +PLUGIN_ENTERPRISE_DATABASE_PASSWORD=yourSecurePassword |
| 58 | +
|
| 59 | +# License File Path |
| 60 | +PLUGIN_ENTERPRISE_LICENSE_LOCATION=./lowcoder-stacks/license |
| 61 | +
|
| 62 | +# Redis |
| 63 | +PLUGIN_ENTERPRISE_REDIS_URL=redis://yourhost:6379 |
| 64 | +
|
| 65 | +# MaxMind GeoIP Service |
| 66 | +PLUGIN_ENTERPRISE_MAXMIND_ACCOUNT_ID=124 |
| 67 | +PLUGIN_ENTERPRISE_MAXMIND_LICENSE=abc |
| 68 | +``` |
| 69 | + |
| 70 | +{% hint style="warning" %} |
| 71 | +Replace the placeholder values with your actual credentials and database settings. |
| 72 | +{% endhint %} |
| 73 | + |
| 74 | +*** |
| 75 | + |
| 76 | +###MaxMind GeoIP |
| 77 | + |
| 78 | +[**MaxMind**](https://www.maxmind.com/) provides GeoIP data services that convert IP addresses into**geographic locations** (e.g., country, city, latitude/longitude). In Lowcoder Enterprise, this data powers enriched**Audit Logs** and**App Usage Logs**, allowing you to track**where** users interact with your apps from. |
| 79 | + |
| 80 | +**How to Get a License:** |
| 81 | + |
| 82 | +1. Visit:[https://www.maxmind.com](https://www.maxmind.com) |
| 83 | +2. Create a free or paid account |
| 84 | +3. Navigate to**My License Keys** under your account settings |
| 85 | +4. Copy the**Account ID** and**License Key** |
| 86 | +5. Insert both into the respective environment variables |
| 87 | + |
| 88 | +*** |
| 89 | + |
| 90 | +###Final Steps |
| 91 | + |
| 92 | +After placing the files and configuring your environment: |
| 93 | + |
| 94 | +1.**Restart your Lowcoder services** (Docker or systemd, depending on setup) |
| 95 | +2. Navigate to your instance |
| 96 | +3. You should now see the Enterprise features (e.g., Environments, Branding, Audit Logs) available in the UI |