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

Non-docker friendly README.md #553

Closed
wants to merge 1 commit into from

Conversation

anonhostpi
Copy link

Docker has a high RAM overhead and isn't ideal for lightweight webservers or servers running with limited or cost-based resources like AWS EC2

Added more details catered to non-docker environments

  • Added note about pyenv
  • Added missing git clone statement
  • Added options for controlling port and listening address from the command line in place of a reverse-proxy or DNAT

Docker has a high RAM overhead and isn't ideal for lightweight webservers or servers running with limited or cost-based resources like AWS EC2

Added more details catered to non-docker environments
- Added note about pyenv
- Added missing git clone statement
- Added options for controlling port and listening address
@anonhostpi
Copy link
Author

This PR is doc-only and makes no changes to the codebase

@alexta69
Copy link
Owner

I'm not sure this is necessary. There's no specific need for pyenv (I don't use it), and the HOST and PORT values are the default anyway so this is redundant.

@alexta69 alexta69 closed this Dec 26, 2024
@anonhostpi
Copy link
Author

anonhostpi commented Dec 26, 2024

...

Doesn't work out of the box with Ubuntu 22's system python packages, hence pyenv.

Also you don't have any docs on HOST and PORT, so they weren't redundant, you just never mentioned them. I had to scour your source code for those 2 environment variables.

I added these docs so that no other Ubuntu users have to go through 3 hours in frustration troubleshooting a 6 line installation script...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants