You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/docs/en/getting-started/faq.md
+3-16Lines changed: 3 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,6 @@
1
1
# Nexent FAQ
2
2
3
-
This FAQ addresses common questions and issues you might encounter while installing and deploying Nexent. For the basic installation steps, please refer to the [Quick Start Guide](./overview#quick-start) in our documentation.
4
-
5
-
## 🚀 Installation & Setup
6
-
7
-
For model provider setup and API key acquisition, see our detailed **[Model Providers Guide](./model-providers)**.
3
+
This FAQ addresses common questions and issues you might encounter while installing and using Nexent. For the basic installation steps, please refer to the [Installation & Development](./installation). For basic using instructions, please refer to the [User Guide](../user-guide/).
8
4
9
5
## 🚫 Common Errors & Operations
10
6
@@ -49,19 +45,10 @@ For model provider setup and API key acquisition, see our detailed **[Model Prov
49
45
3. **Model name**: Confirm the model identifier is correct
50
46
4. **Network access**: Ensure your deployment can reach the provider's servers
51
47
52
-
For specific provider setup, see our [Model Providers Guide](./model-providers).
53
-
54
-
### 📧 Email Tools Configuration
55
-
- **Q: How can I enable and configure email tools?**
56
-
- A: Our team has pre-implemented email tools based on IMAP and SMTP. To enable them:
57
-
1. Configure email parameters in`.env` file
58
-
2. Uncomment the email tool imports and registrations in`agent_utils.py`
59
-
3. Switch to the email-enabled system prompt by using `code_agent_with_email.yaml`
60
-
4. Restart the MCP service to apply changes
48
+
For model setup instruction, see [Model Configuration](../user-guide/model-configuration) in User Guide.
61
49
62
50
## 💡 Need Help
63
51
64
52
If your question isn't answered here:
65
53
- Join our [Discord community](https://discord.gg/tb5H3S3wyv) for real-time support
66
-
- Check our [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues) for similar problems
67
-
- Refer to our [Contribution Guide](../contributing) for more detailed information
54
+
- Check our [GitHub Issues](https://github.com/ModelEngine-Group/nexent/issues) for similar problems
> **💡 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.
23
+
22
24
### 2. Deployment Options
23
25
24
-
The deployment script offers multiple modes:
26
+
Run the following command to start deployment:
25
27
26
28
```bash
27
29
bash deploy.sh
28
30
```
29
31
30
-
**Available deployment modes:**
32
+
After executing this command, the system will provide two different versions for you to choose from:
33
+
34
+
**Version Selection:**
35
+
-**Speed version (Lightweight & Fast Deployment, Default)**: Quick startup of core features, suitable for individual users and small teams
36
+
-**Full version (Complete Feature Edition)**: Provides enterprise-level tenant management and resource isolation features, but takes longer to install, suitable for enterprise users
37
+
38
+
**Deployment Modes:**
31
39
-**Development mode (default)**: Exposes all service ports for debugging
32
40
-**Infrastructure mode**: Only starts infrastructure services
33
41
-**Production mode**: Only exposes port 3000 for security
34
-
-**Beta mode**: Uses development branch images
35
42
36
-
**Optional components:**
43
+
**Optional Components:**
37
44
-**Terminal Tool**: Enables openssh-server for AI agent shell command execution
38
45
-**Regional optimization**: Mainland China users can use optimized image sources
39
46
40
47
### 3. Access Your Installation
41
48
42
49
When deployment completes successfully:
43
50
1. Open **http://localhost:3000** in your browser
44
-
2. Follow the setup wizard for initial configuration
45
-
3. Configure your model providers (see [Model Providers Guide](./model-providers))
46
-
47
-
## 🤖 Model Configuration
48
-
49
-
Nexent supports all **OpenAI-compatible models**, including:
50
-
-**Large Language Models (LLM)**: Any OpenAI-compatible API provider
51
-
-**Multimodal Vision Models**: Text + image processing capabilities
52
-
-**Embedding Models**: All OpenAI-compatible embedding services
53
-
-**Text-to-Speech & Speech-to-Text**: Multiple provider support
54
-
-**Search Integration**: Web search and semantic retrieval
55
-
56
-
### Quick Provider Setup
51
+
2. Refer to the [User Guide](../user-guide/) to develop agents
57
52
58
-
For detailed setup instructions and API key acquisition, see our **[Model Providers Guide](./model-providers)**.
0 commit comments