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

updating readme with free memory requirement [revised] #2370

Closed
wants to merge 4 commits into from

Conversation

rorosaurus
Copy link

There is a non-obvious requirement for memory to be available for the crypto libraries on the client. The readme's System Requirements section didn't reflect this. On low-memory systems this crashes the client with an extremely verbose but not terribly useful error.
See #1883 (comment)

There is a non-obvious requirement for memory to be available for the crypto libraries on the client.  The readme's System Requirements section didn't reflect this.  On low-memory systems this crashes the client with an extremely verbose but not terribly useful error. 
See certbot#1883 (comment)
@pde
Copy link
Member

pde commented Feb 4, 2016

I agree we should mention that in the readme, but the RAM isn't a requirement of the client; it's a requirement of the installation approach taken by letsencrypt-auto.

If there are client packages available for your OS, those will work on low-memory systems. And if your OS packages a recent copy of python-cryptography but not the letsencrypt client, you may be able to do pip install letsencrypt letsencrypt-apache and have that work.

Can you update the PR to reflect those nuances in some way?

@pde pde changed the title adding RAM requirement to readme adding RAM requirement to readme [needs revision] Feb 4, 2016
There is a non-obvious requirement for free memory to be available for crypto to compile when running letsencrypt-auto. The readme's System Requirements section didn't reflect this. On low-memory systems this crashes the client with an extremely verbose but not terribly useful error. 
See certbot#1883 (comment) 
Revision 2 per certbot#2370 (comment)
@rorosaurus rorosaurus changed the title adding RAM requirement to readme [needs revision] updating readme with free memory requirement [revised] Feb 4, 2016
@rorosaurus
Copy link
Author

Excellent points. How does this new wording sound? Does that capture the details adequately?

Can you confirm I correctly stated this last bit?

if your OS packages a recent copy of python-cryptography, you
may be able to run letsencrypt without the letsencrypt-auto wrapper,
avoiding the compilation.

@pde
Copy link
Member

pde commented Feb 5, 2016

Hi @rorosaurus, I've made a PR to get that wording to be clearer; however it starts to seem like too much detail on this specific issue for the main README. Should we perhaps describe these workarounds in docs/using.rst and just link to that section from the top level README?

@rorosaurus
Copy link
Author

Yeah, I was thinking the same. It now seems too specific for the main README.
My original reason for wanting to mention the memory complications here was just to spread awareness. Maybe a brief message, then a link to that section in docs/using.rst would be perfect?

@seanthewebber
Copy link

@pde @rorosaurus Can we consider using letsencrypt instead of letsencrypt-auto an official solution or is this a temporary workaround?

@pde
Copy link
Member

pde commented Mar 10, 2016

@seanthewebber yes that's definitely the plan; in the long run we aspire to retiring letsencrypt-auto in favour of native packages.

@jsha
Copy link
Contributor

jsha commented Mar 7, 2017

Thanks for the PR! I've wrapped the advice into #4305, which also updates some more of the documentation.

@jsha jsha closed this Mar 7, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants