Kloudless API Guide

# Kloudless Enterprise Configuration Guide: Introduction

This guide provides an overview to configuring Kloudless Enterprise, the self-hosted version of Kloudless.

# The Kloudless Unified APIs

Kloudless provides a single set of APIs to integrate several applications by writing code just once. The Kloudless Unified APIs provide an abstraction layer with a common set of data models and API endpoints to accomplish all the tasks you would expect with a specific kind of API. For example, Kloudless provides Unified APIs for Cloud Storage, Calendar, and CRM, among others.

# Kloudless Enterprise

Kloudless Enterprise allows you to take advantage of the benefits of Kloudless on your own terms by hosting it yourself wherever you need, receiving the same up-to-date experience as you would with our cloud version at kloudless.com. You can host a virtual machine or container in your existing cloud or on-premises environment and maintain regulatory compliance more easily by keeping data under your control. You can host the service anywhere in the world and even have your applications use Kloudless in on-premises deployments for your customers. Kloudless offers a consistent developer experience between our cloud and self-hosted ("Enterprise") offering. We actively support new features and take over the maintenance of connectors, including version updates, as you can see from our Release Notes.

Kloudless Enterprise supports Advanced White-labeling to provide consistent branding to your customers, configurable Metrics and Monitoring to help you ensure consistent and predictable performance, and a horizontally and vertically scalable clustering mode to support large customer demand or effective resource sharing with services you deploy to customers.

# Getting Started

Deploying Kloudless Enterprise clustered only requires a shared Postgres database and Redis server, as detailed in the sections below:

# Pointers for Common Questions

Here are some steps that may help get started with launching a Kloudless Enterprise server for the first time, or understanding how to administer one:

  1. To quickly deploy a simple configuration for demonstration and validation, see the quickstart guides for containers.

  2. For common issues with first setup, verify the kloudless.yml configuration file is correctly deployed, along with a license, in the form of a license key file or license code in kloudless.yml. Refer to the config section and reach out to us at support@kloudless.com if you have any questions.

  3. Clustering of instances will occur automatically when they share access to the same Postgres database and Redis service. See clustering. All that is required then is to direct traffic to all instances via a load balancer.

# Support Contact

Please contact us at support@kloudless.com with any questions.

Also, feel free to send feedback about your use of these guides, whether positive, improvements, or questions.

# Release Notes

Full release notes are available at https://developers.kloudless.com/releases.

Architecture Overview →