Getting Started with Kinesis API

Welcome to the Getting Started guide for Kinesis API. This section will walk you through the process of installing, initializing, and setting up your first Kinesis API instance.

Prefer video tutorials? You can follow along with our YouTube walkthrough of this same project.

What You'll Learn

In this section, you'll learn how to:

• Install Kinesis API using Docker or Rust
• Initialize your installation with default settings
• Secure your instance with proper credentials
• Understand the key components created during initialization
• Configure your system for production use

Quick Start Overview

Getting Kinesis API up and running involves two main steps:

1. Installation: Set up the Kinesis API software on your system
2. Initialization: Configure the system with initial data and settings

If you're eager to start right away, follow these quick steps:

# Create necessary directories
mkdir -p data/ public/

# Create configuration file
echo "TMP_PASSWORD=yourSecurePassword" > .env
echo "API_URL=http://your-domain-or-ip:8080" >> .env

# Run the Docker container
docker run --name kinesis-api \
  -v $(pwd)/.env:/app/.env \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/public:/app/public \
  -p 8080:8080 -d \
  --restart unless-stopped \
  edgeking8100/kinesis-api:latest

# Initialize the system
curl "http://your-domain-or-ip:8080/init?code=code"

Then access the web interface at http://your-domain-or-ip:8080/web and log in with:

• Username: root
• Password: Test123*

Remember to change the default password immediately!

Detailed Guides

For more detailed instructions, refer to these guides:

• Installation Guide - Comprehensive instructions for setting up Kinesis API
• Initialization Guide - Detailed steps for initializing your installation

System Requirements

Before you begin, ensure your system meets these minimum requirements:

• Memory: 128MB RAM minimum (512MB+ recommended for production)
• CPU: 1 core minimum (2+ cores recommended)
• Storage: 100MB for installation + additional space for your data
• Operating System: Any OS that can run Docker or Rust
• Network: Outbound internet access for installation

Next Steps After Installation

Once you've completed the installation and initialization process, you'll want to:

1. Change the default password
2. Configure your system settings
3. Build a Simple Counter App

Let's get started with the Installation Guide.