Installation & Deployment

🎯 Prerequisites

Resource	Minimum
CPU	2 cores
RAM	6 GiB
Architecture	x86_64 / ARM64
Software	Docker & Docker Compose installed

🚀 Quick Start

1. Download and Setup

git clone https://github.com/ModelEngine-Group/nexent.git
cd nexent/docker
cp .env.example .env # Configure environment variables

💡 Tip: If there are no special requirements, you can directly use .env.example for deployment without making any changes. If you need to configure voice models (STT/TTS), you will need to set the relevant parameters in .env. We will work on making this configuration available through the frontend soon—stay tuned.

2. Deployment Options

Run the following command to start deployment:

bash deploy.sh

After executing this command, the system will provide two different versions for you to choose from:

Version Selection:

• Speed version (Lightweight & Fast Deployment, Default): Quick startup of core features, suitable for individual users and small teams
• Full version (Complete Feature Edition): Provides enterprise-level tenant management and resource isolation features, but takes longer to install, suitable for enterprise users

Deployment Modes:

• Development mode (default): Exposes all service ports for debugging
• Infrastructure mode: Only starts infrastructure services
• Production mode: Only exposes port 3000 for security

Optional Components:

• Terminal Tool: Enables openssh-server for AI agent shell command execution
• Regional optimization: Mainland China users can use optimized image sources

⚠️ Important Notes

1️⃣ When deploying v1.8.0 or later for the first time, please pay special attention to the suadmin super administrator account information output in the Docker logs. This account has the highest system privileges, and the password is only displayed upon first generation. It cannot be viewed again later, so please be sure to save it securely.

2️⃣ Forgot to note the suadmin account password? Follow these steps:

# Step1: Delete su account record in supabase container
docker exec -it supabase-db-mini bash
psql -U postgres
select id, email from auth.users;
# Get the user_id of suadmin@nexent.com account
delete from auth.users where id = 'your_user_id';
delete from auth.identities where user_id = 'your_user_id';

# Step2: Delete su account record in nexent database
docker exec -it nexent-postgresql bash
psql -U root -d nexent
delete from nexent.user_tenant_t where user_id = 'your_user_id';

# Step3: Redeploy and record the su account password

3. Access Your Installation

When deployment completes successfully:

1. Open http://localhost:3000 in your browser
2. Log in with the super administrator account
3. Access tenant resources → Create tenant and tenant administrator
4. Log in with the tenant administrator account
5. Refer to the User Guide to develop agents

🏗️ Service Architecture

Nexent uses a microservices architecture with the following core services:

Core Services:

• nexent: Backend service (port 5010)
• nexent-web: Frontend interface (port 3000)
• nexent-data-process: Data processing service (port 5012)

Infrastructure Services:

• nexent-postgresql: Database (port 5434)
• nexent-elasticsearch: Search engine (port 9210)
• nexent-minio: Object storage (port 9010, console 9011)
• redis: Cache service (port 6379)

Optional Services:

• nexent-openssh-server: SSH server for Terminal tool (port 2222)

🔌 Port Mapping

Service	Internal Port	External Port	Description
Web Interface	3000	3000	Main application access
Backend API	5010	5010	Backend service
Data Processing	5012	5012	Data processing API
PostgreSQL	5432	5434	Database connection
Elasticsearch	9200	9210	Search engine API
MinIO API	9000	9010	Object storage API
MinIO Console	9001	9011	Storage management UI
Redis	6379	6379	Cache service
SSH Server	22	2222	Terminal tool access

For complete port mapping details, see our Dev Container Guide.

💡 Need Help

• Browse the FAQ for common install issues
• Drop questions in our Discord community
• File bugs or feature ideas in GitHub Issues

🔧 Build from Source

Want to build from source or add new features? Check the Docker Build Guide for step-by-step instructions.

For detailed setup instructions and customization options, see our Developer Guide.