mirror of
https://github.com/Significant-Gravitas/AutoGPT.git
synced 2026-01-09 15:17:59 -05:00
feat(agent/server): Make port configurable, add documentation for Agent Protocol DB and port config (#6569)
* docs: Add documentation on how to use Agent Protocol in the template - Added documentation on how to use Agent Protocol and its settings in the `.env.template` file. - An explanation is provided for the `AP_SERVER_PORT` and `AP_SERVER_DB_URL` settings. - This change aims to improve the understanding and usage of Agent Protocol in the project. * docs: Update usage.md with information about configuring the API port - Update the documentation for the `serve` mode in `usage.md` - Add information about configuring the port for the API server using the `AP_SERVER_PORT` environment variable. --------- Co-authored-by: Reinier van der Leer <pwuts@agpt.co>
This commit is contained in:
@@ -220,3 +220,12 @@ OPENAI_API_KEY=your-openai-api-key
|
||||
|
||||
## PLAIN_OUTPUT - Disables animated typing and the spinner in the console output. (Default: False)
|
||||
# PLAIN_OUTPUT=False
|
||||
|
||||
|
||||
################################################################################
|
||||
### Agent Protocol Server Settings
|
||||
################################################################################
|
||||
## AP_SERVER_PORT - Specifies what port the agent protocol server will listen on. (Default: 8000)
|
||||
# AP_SERVER_PORT=8000
|
||||
# # AP_SERVER_DB_URL - Specifies what connection url the agent protocol database will connect to (Default: Internal SQLite)
|
||||
# AP_SERVER_DB_URL=sqlite:///data/ap_server.db
|
||||
|
||||
@@ -365,10 +365,11 @@ async def run_auto_gpt_server(
|
||||
database_string=os.getenv("AP_SERVER_DB_URL", "sqlite:///data/ap_server.db"),
|
||||
debug_enabled=debug,
|
||||
)
|
||||
port: int = int(os.getenv("AP_SERVER_PORT", default=8000))
|
||||
server = AgentProtocolServer(
|
||||
app_config=config, database=database, llm_provider=llm_provider
|
||||
)
|
||||
await server.start()
|
||||
await server.start(port=port)
|
||||
|
||||
|
||||
def _configure_openai_provider(config: Config) -> OpenAIProvider:
|
||||
|
||||
@@ -115,7 +115,7 @@ To exit the program, press ++ctrl+c++
|
||||
### `serve` – Agent Protocol mode with UI
|
||||
|
||||
With `serve`, the application exposes an Agent Protocol compliant API and serves a
|
||||
frontend, by default on `http://localhost:8000`.
|
||||
frontend, by default on `http://localhost:8000`. You can configure the port it is served on with the `AP_SERVER_PORT` environment variable.
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
|
||||
Reference in New Issue
Block a user