feat: allow eliza client to configure eliza server base URL via env var

[bguiz]

Relates to

• Fixes: feat: make eliza server URL configurable via env var when starting eliza client #3585
• Possibly a solution to: Repeated issue connecting front end and back end #3578

Risks

• Low: Can be ignored, and behaviour defaults to current behaviour

Background

What does this PR do?

• Currently:
  • Eliza client can configure the port number of the Eliza server
  • Eliza client cannot configure the base URL of the Eliza server
• With this change:
  • Eliza client can continue to configure the port number of the Eliza server
  • Eliza client can alternatively configure the base URL of the Eliza server
  • Note that base URL overrides the port number, if it is specified, so no point in specifying both (common sense, but doesn't hurt to be explicit)

What kind of change is this?

• Improvements (misc. changes to existing features)

Why are we doing this? Any context or related work?

• Couldn't get Eliza client to run in certain deployment environments
  • Specifically, when client and server are hosted separately, and/or have different (sub)domains

Documentation changes needed?

• My changes require an optional change to the project documentation.
• The docs are included in this PR, which document not only the new thing (SERVER_BASE_URL) but also an existing thing (SERVER_PORT) which wasn't yet documented

Testing

Straight forward, manual testing

Test case (1)

On own machine:

SERVER_PORT="4567" pnpm start --character="characters/dobby.character.json"

On own machine as well:

SERVER_BASE_URL="http://localhost:4567" pnpm start:client

Test case (2)

On hosted machine, served at foobar.my.custom.domain:

SERVER_PORT="80" pnpm start --character="characters/dobby.character.json"

On hosted machine, served at barfoo.my.custom.domain:

SERVER_BASE_URL="https://foobar.my.custom.domain:80" pnpm start:client

Where should a reviewer start?

• Perform the manual test as described above.
• Look at the files in the diff (they're very minimal)
  .

Detailed testing steps

• Perform the manual test as described above.
• There are zero UI changes

Discord username

bguiz

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[graphite-app]

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

• merge-queue - adds this PR to the back of the merge queue
• merge-queue-hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

[github-actions]

Hi @bguiz! Welcome to the elizaOS community. Thanks for submitting your first pull request; your efforts are helping us accelerate towards AGI. We'll review it shortly. You are now an elizaOS contributor!

[bguiz]

Great, thanks @odilitime !