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

Add documentation on how to use Agent Protocol in .env.template #6569

Merged
merged 3 commits into from
Jan 12, 2024

Conversation

ntindle
Copy link
Member

@ntindle ntindle commented Dec 14, 2023

Background

AutoGPT's serve currently hardcodes the port 8000 for serving the services for the agent protocol. I modified that to be the default and allow it to be configured with environment variables.

Changes 🏗️

I made changes to allow the agent protocol server for autogpt to start on a different port due to local testing requirements. I also documented it.

PR Quality Scorecard ✨

  • Have you used the PR description template?   +2 pts
  • Is your pull request atomic, focusing on a single change?   +5 pts
  • Have you linked the GitHub issue(s) that this PR addresses?   +5 pts
  • Have you documented your changes clearly and comprehensively?   +5 pts
  • Have you changed or added a feature?   -4 pts
    • Have you added/updated corresponding documentation?   +4 pts
    • Have you added/updated corresponding integration tests?   +5 pts
  • Have you changed the behavior of AutoGPT?   -5 pts
    • Have you also run agbenchmark to verify that these changes do not regress performance?   +10 pts

- 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.
- 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.
@ntindle ntindle requested a review from Pwuts as a code owner December 14, 2023 18:00
Copy link

netlify bot commented Dec 14, 2023

Deploy Preview for auto-gpt-docs ready!

Name Link
🔨 Latest commit 28e3618
🔍 Latest deploy log https://app.netlify.com/sites/auto-gpt-docs/deploys/65a13f97bbb478000853c8df
😎 Deploy Preview https://deploy-preview-6569--auto-gpt-docs.netlify.app/autogpt/usage
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@Wladastic Wladastic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Port should be configurable, correct.
Seems good to me.

Copy link
Member

@Pwuts Pwuts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Pwuts Pwuts merged commit 97023b9 into master Jan 12, 2024
16 checks passed
@Pwuts Pwuts deleted the agent-protocol/docs branch January 12, 2024 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants