Installation

Installation Guide for RestBI

This guide provides comprehensive instructions for deploying and configuring RestBI using Docker. RestBI is designed to be easy to set up, with the flexibility to customize it according to your needs. Follow the steps below to get RestBI up and running quickly.

Quick Start

Deploy RestBI with Docker

To deploy the RestBI server using Docker, follow these steps:

Pull the Docker Image

The RestBI Docker image is available on Docker Hub, making it simple to deploy. Pull the latest image by running:

docker pull restbi/restbi-server:latest

Run the Docker Container

Once the image is pulled, you can start the RestBI server with the following command:

docker run -d -p 3000:3000 restbi/restbi-server:latest

This command pulls the latest RestBI server image and starts it on port 3000.

Docker Compose and Kubernetes

The commands above are great for testing. In production, RestBI is typically deployed alongside the rest of your application in an orchestration service. For more advanced deployments, check out the docs for Docker Compose and Kubernetes.

Install the RestBI SDK

To interact with the RestBI server, you need to install the RestBI SDK. This can be done easily using npm.

npm install restbi-sdk

Run this command in your project directory to install the SDK, which will allow you to start making requests to your RestBI server.

Advanced Configuration

Customizing the Docker Container

The Docker image is designed to be a simple service that you can use as a starting point. You can pass dynamic configurations when initializing the container to customize its behavior according to your specific needs.

Example of running the Docker container with dynamic configurations:

docker run -d \
  -p 3000:3000 \
  -e DB_NAME=MyDB \
  -e DB_HOST=db.example.com \
  -e DB_PORT=5432 \
  -e DB_USER=youruser \
  -e DB_PASSWORD=yourpassword \
  -e CORS_WHITELIST=http://example.com,http://anotherdomain.com \
  restbi/restbi-server:latest

In this command:

• DB_HOST, DB_PORT, DB_USER, DB_PASSWORD: We define a default connection to use. In some cases you may only have one connection and want to provide those details on container initialization.

• CORS_WHITELIST: Define the domains allowed to interact with your RestBI server.

You can also mount a directory with custom functions into the container:

docker run -d \
  -p 3000:3000 \
  -e DB_HOST=db.example.com \
  -e DB_PORT=5432 \
  -e DB_USER=youruser \
  -e DB_PASSWORD=yourpassword \
  -e CORS_WHITELIST=http://example.com,http://anotherdomain.com \
  -v /path/to/custom/functions:/app/custom-functions \
  restbi/restbi-server:latest

Best Practices for Hosting

• Deployment Environment: It’s recommended to host RestBI within your existing architecture as a service, whether on cloud platforms like AWS, GCP, or Azure, or on-premises.

• Security: Use secure protocols (HTTPS) and secret management tools to protect sensitive information such as database credentials and API keys.

• Scaling: Consider using orchestration tools like Kubernetes or Docker Compose for managing multiple instances and scaling the service as needed.

• Logging and Monitoring: Implement logging and monitoring to track the performance and health of your RestBI deployment.