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: add client env vars to README #221

Merged
merged 3 commits into from
May 24, 2023
Merged

docs: add client env vars to README #221

merged 3 commits into from
May 24, 2023

Conversation

bashbunni
Copy link
Member

Changes

  • add client environment variables to README
  • move install instructions

Related Issues:

closes #209

Notes:

I think this should be mentioned in the Skate docs that you can customize the skate client with these env variables and link back to this section of the Charm docs. Also, not sure how we feel about moving the install instructions, but it felt strange having it so deep into the weeds of Charm cloud.

@bashbunni bashbunni added the documentation Improvements or additions to documentation label May 24, 2023
@bashbunni bashbunni requested a review from aymanbagabas May 24, 2023 15:51
Copy link
Member

@aymanbagabas aymanbagabas left a comment

Choose a reason for hiding this comment

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

LGTM thanks!

README.md Outdated Show resolved Hide resolved
Co-authored-by: Ayman Bagabas <ayman.bagabas@gmail.com>
@bashbunni
Copy link
Member Author

@azoller1 @richard-kramer does this help clarify the issue you encountered with self-hosting charm + configuring client side options? Let me know if there's anything you think might improve the experience here :)

@bashbunni bashbunni merged commit a5f4109 into main May 24, 2023
@bashbunni bashbunni deleted the docs/client branch May 24, 2023 16:43
@richard-kramer
Copy link

@azoller1 @richard-kramer does this help clarify the issue you encountered with self-hosting charm + configuring client side options? Let me know if there's anything you think might improve the experience here :)

Generally yes, this neatly documents all the possible variables. Maybe it is a good idea, to also provide an example for how to configure the client when running the server behind a default https proxy? E.g. set CHARM_HOST to the hostname and CHARM_HTTP_PORT to 443? I think, that would be a pretty common case.

@bashbunni bashbunni mentioned this pull request May 24, 2023
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Self-Hosting: CHARM_HOST Env uses port 35353 instead of 443?
3 participants