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

Feat/deploy doc #37

Merged
merged 5 commits into from
Feb 5, 2025
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
3 changes: 2 additions & 1 deletion en/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@
* [Story Teller](ten_agent/playground/run_story_telling.md)
* [Change Language](ten_agent/playground/change_language.md)
* [Customize TEN Agent](ten_agent/customize_your_agent.md)
* [Deploy TEN Agent Service](ten_agent/deploy_agent_service.md)
* Deployment
* [Deploy TEN Agent Service](ten_agent/deploy_agent_service.md)
* [Create a Hello World Extension](ten_agent/create_a_hello_world_extension.md)
* [How does interrupt work in TEN-Agent](ten_agent/how_does_interrupt_work.md)
* [Create an Extension with Predefined Type](ten_agent/create_an_extension_with_predefined_type/overview.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The agent service will be running on port 8083 now.

## Test the agent service

The service exposes a list of apis that you can use to interact with the agent. The api reference can be found [here](https://github.com/TEN-framework/TEN-Agent/tree/main/server).
The service exposes a list of apis that you can use to interact with the agent. The api reference can be found [https://github.com/TEN-framework/TEN-Agent/tree/main/server](https://github.com/TEN-framework/TEN-Agent/tree/main/server).

You can also test the agent service by running the following command in playground client:

Expand All @@ -44,3 +44,21 @@ NEXT_PUBLIC_EDIT_GRAPH_MODE=false AGENT_SERVER_URL=http://localhost:8083 pnpm de

> Note: The `AGENT_SERVER_URL` should be the url where your agent service is running. If you are running the agent service on your server, replace `localhost` with your server ip.
> Note: The `NEXT_PUBLIC_EDIT_GRAPH_MODE` should be set to `false` to use the agent service, as the released docker image has no dev server packaged.

## Test the agent service using playground docker image

Sometimes you may want to deploy the playground along with the agent service. You can do this by running the following command to build your own playground UI into docker image:

```shell
cd playground
docker build --build-arg EDIT_GRAPH_MODE=false -t ten-agent-playground .
```

Then you can run the playground docker image by running the following command:

```shell
docker run -itd -p 4000:3000 -e AGENT_SERVER_URL=http://host.docker.internal:8083 --name ten-agent-playground ten-agent-playground
```

> Note: The `AGENT_SERVER_URL` should be the url where your agent service is running. Since you are running the agent service in another docker container, you can use `host.docker.internal` to access the host machine. If you are running the agent service on your server, replace `host.docker.internal` with your server ip.
> Note: If you are connecting to a released version of agent service, you should set `EDIT_GRAPH_MODE` to `false` when building the playground docker image.
Loading