Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: adding ten agent faqs #331

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
* [Create an Extension with Predefined Type](ten_agent/create_an_extension_with_predefined_type/overview.md)
* [LLM Extension](ten_agent/create_an_extension_with_predefined_type/type_llm_extension.md)
* [LLM Tool Extension](ten_agent/create_an_extension_with_predefined_type/type_llm_tool_extension.md)
* [FAQs](ten_agent/faqs.md)

## TEN framework

Expand Down
67 changes: 67 additions & 0 deletions docs/ten_agent/faqs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# FAQs

## Where do I get the Agora APP ID and Agora APP Certificate?

For people who are in the **Greater China region**:
* Sign up an account on [shengwang.cn](https://console.shengwang.cn/), and create a project, then the ID and Certificate will be generated automatically.

For people who are in the **Global region**:
* Sign up an account on [agora.io](https://console.agora.io/), and create a project, then the ID and Certificate will be generated automatically.


## How to check my internet connection?

Please make sure that both of you your **HTTPS** and **SSH** are connected to the internet.

Test **HTTPS** connection:

{% code title=">_ Terminal" %}
```bash
ping www.google.com

# You should see the following output:
PING google.com (198.18.1.94): 56 data bytes
64 bytes from 198.18.1.94: icmp_seq=0 ttl=64 time=0.099 ms
64 bytes from 198.18.1.94: icmp_seq=1 ttl=64 time=0.121 ms
```
{% endcode %}

Test **SSH** connection:

{% code title=">_ Terminal" %}
```
curl www.google.com

# You should see the following output:
<html>
<head><title>301 Moved Permanently</title></head>
<body>
<h1>301 Moved Permanently</h1>
</body>
</html>
```
{% endcode %}

## How to refresh env file?

To see updated changes during development, follow these steps:
1. Stop the server
2. Save changes to the `.env` file
3. Run `source .env` to refresh the environment variables

## Line-ending Issues on Windows

Windows users occasionally encounter line-ending issues, which may result in errors like "agent/bin/start is not a valid directory".

To fix this:
1. Configure Git to automatically convert line endings to LF on Windows:

{% code title=">_ Terminal" %}
```bash
git config --global core.autocrlf true
```
{% endcode %}

2. Re-clone the repository

Alternatively, you can download and extract the ZIP file directly from GitHub.