Initialization

After installing Kinesis API, you need to initialize the system before you can start using it. This one-time process creates the necessary database structures, default user, and configuration settings.

Initialization Methods

You can initialize Kinesis API using one of two methods:

Method 1: Using the Web Interface (Recommended)

1. Open your web browser and navigate to your Kinesis API installation:

   http://your-domain-or-ip:8080/web
   

2. You'll be presented with an initialization screen if the system hasn't been set up yet.

3. Click the "Initialize" button to begin the process.

4. The system will create the necessary database structures and a default root user.

5. Once initialization is complete, you'll be redirected to the login page.

Method 2: Using a REST API Request

If you prefer to initialize the system programmatically or via command line, you can use a REST API request:

curl "http://your-domain-or-ip:8080/init?code=code"

Or using any HTTP client like wget:

wget -qO - "http://your-domain-or-ip:8080/init?code=code"

A successful initialization will return a JSON response indicating that the system has been set up.

Default Root User

After initialization, a default root user is created with the following credentials:

• Username: root
• Password: Test123*

⚠️ IMPORTANT SECURITY NOTICE: You should change the default password immediately after your first login to prevent unauthorized access to your system.

What Gets Initialized

During initialization, Kinesis API sets up:

• Database tables and their structures
• Encryption key for securing sensitive data
• System constraints for data validation
• Default root user account
• Core configuration settings
• Initial projects structure
• Collection templates
• Media storage system

These components form the foundation of your Kinesis API installation, creating the necessary structure for you to start building your APIs.

Verifying Initialization

To verify that your system has been properly initialized:

1. Try logging in with the default credentials.
2. Check that you can access the dashboard.
3. Navigate to the Users section to confirm the root user exists.
4. Ensure the API documentation is accessible at /scalar.

Reinitializing the System

In most cases, you should never need to reinitialize your system after the initial setup. Reinitializing will erase all data and reset the system to its default state.

If you absolutely must reinitialize (for example, during development or testing):

1. Stop the Kinesis API service:

   docker stop kinesis-api
   

2. Remove the data directory:

   rm -rf data/
   

3. Create a fresh data directory:

   mkdir -p data/
   

4. Restart the service:

   docker start kinesis-api
   

5. Follow the initialization steps again.

Next Steps

After successfully initializing your Kinesis API instance:

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