Installation

Installation

Ready to take control of your n8n fleet? This guide will walk you through setting up Kizuna on your local machine or server.

Prerequisites

Before you begin, ensure you have the following installed:

1. Node.js: Version 18.17.0 or higher.
2. Git: For cloning the repository.
3. Supabase Account: You’ll need a Supabase project (free tier is sufficient) for the database and authentication.
4. n8n Instances: At least one n8n instance to manage.

Step-by-Step Setup

1. Clone the Repository

Clone the Kizuna repository to your local machine.

git clone https://github.com/octadira/kizuna.git
cd kizuna

2. Install Dependencies

Install the necessary dependencies using npm.

npm install

3. Configure Supabase

Kizuna uses Supabase for authentication and state management.

1. Create a new project on Supabase.
2. Go to Project Settings -> API.
3. Copy your Project URL and anon public key.

4. Environment Variables

Create a .env.local file in the root of your project:

.env.local

NEXT_PUBLIC_SUPABASE_URL=your_project_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_anon_key

# Optional: For encryption
N8N_ENCRYPTION_KEY=generate_a_secure_random_string_32_chars

Tip

You can generate a strong encryption key using openssl: openssl rand -hex 32

5. Database Setup

Run the initialization script to set up your database schema. You can find the SQL script in setup.sql in the root of the repo.

1. Open the SQL Editor in your Supabase Dashboard.
2. Copy the contents of setup.sql.
3. Run the query.

6. Start the Server

Launch the development server.

npm run dev

Open http://localhost:3000 in your browser. You should see the Kizuna login page.

Troubleshooting

Database Erors

If you see Row Level Security (RLS) policies errors, ensure you ran the complete setup.sql script which includes the policy definitions.

Images not loading?

Ensure your NEXT_PUBLIC_SUPABASE_URL is correct and that you have enabled Storage if required (though Kizuna primarily uses the DB).