mirror of
https://github.com/certbot/certbot.git
synced 2026-07-27 00:00:44 +02:00
9cacd51003
Item 1 of https://github.com/certbot/certbot/issues/10600 Once this is merged, the [release instructions](https://github.com/EFForg/certbot-misc/wiki/The-Mystical-Release-Process) should be updated to no longer say "Make sure Certbot's virtual environment isn't activated." Why in `release.sh` instead of `_release.sh`? This seemed to be the "check the environment status" file. `venv/bin/activate` does several things. 1. create `deactivate` shell function 2. create `_OLD_VIRTUAL_PATH` and modify `PATH` to prepend `venv/bin` location. `_OLD_VIRTUAL_PATH` isn't exported. 3. unset `PYTHONHOME` and store the old `PYTHONHOME` in `_OLD_VIRTUAL_PYTHONHOME`, again not exported. 4. export `VIRTUAL_ENV_PROMPT` 5. call `hash -r 2> /dev/null` for some sort of edge case 6. set `VIRTUAL_ENV` 7. change the prompt appearance (PS1) 1, 4, and 7 don't need to be undone. 2, 4, and 6 are managed here manually. 3 is the hard one, since we don't have access to `_OLD_VIRTUAL_PYTHONHOME`, and there's not a great way of grabbing it from the shell. One thought I had was to modify `venv/bin/activate` in `venv.py` so that it is exported. That's possible, but at least for me, `PYTHONHOME` isn't set in the first place and so it doesn't seem worth doing that. Given that this script only needs to run on a few people's machines, I would say we can hold off on doing that if and until it becomes necessary. Added some prints and an `exit 0` after the relevant code in the script to test: ```bash $ RELEASE_GPG_KEY=dontmatter tools/release.sh 1.2.3 4.5.6 $ source venv/bin/activate (venv) $ RELEASE_GPG_KEY=dontmatter tools/release.sh 1.2.3 4.5.6 Deactivating venv... previous path: /Users/erica/certbot/venv/bin:/opt/homebrew/opt/coreutils/libexec/gnubin:[rest of path omitted] new path: /opt/homebrew/opt/coreutils/libexec/gnubin:[rest of path omitted] (venv) $ printenv PATH /Users/erica/certbot/venv/bin:/opt/homebrew/opt/coreutils/libexec/gnubin:[rest of path omitted] ``` --------- Co-authored-by: Brad Warren <bmw@users.noreply.github.com>
.. This file contains a series of comments that are used to include sections of this README in other files. Do not modify these comments unless you know what you are doing. tag:intro-begin |build-status| .. |build-status| image:: https://img.shields.io/github/actions/workflow/status/certbot/certbot/nightly.yml :target: https://github.com/certbot/certbot/actions/workflows/nightly.yml :alt: GitHub Actions nightly CI status .. image:: https://raw.githubusercontent.com/EFForg/design/master/logos/certbot/eff-certbot-lockup.png :width: 200 :alt: EFF Certbot Logo Certbot is part of EFF’s effort to encrypt the entire Internet. Secure communication over the Web relies on HTTPS, which requires the use of a digital certificate that lets browsers verify the identity of web servers (e.g., is that really google.com?). Web servers obtain their certificates from trusted third parties called certificate authorities (CAs). Certbot is an easy-to-use client that fetches a certificate from Let’s Encrypt—an open certificate authority launched by the EFF, Mozilla, and others—and deploys it to a web server. Anyone who has gone through the trouble of setting up a secure website knows what a hassle getting and maintaining a certificate is. Certbot and Let’s Encrypt can automate away the pain and let you turn on and manage HTTPS with simple commands. Using Certbot and Let's Encrypt is free. .. _installation: Getting Started --------------- The best way to get started is to use our `interactive guide <https://certbot.eff.org>`_. It generates instructions based on your configuration settings. In most cases, you’ll need `root or administrator access <https://certbot.eff.org/faq/#does-certbot-require-root-administrator-privileges>`_ to your web server to run Certbot. Certbot is meant to be run directly on your web server on the command line, not on your personal computer. If you’re using a hosted service and don’t have direct access to your web server, you might not be able to use Certbot. Check with your hosting provider for documentation about uploading certificates or using certificates issued by Let’s Encrypt. Contributing ------------ If you'd like to contribute to this project please read `Developer Guide <https://certbot.eff.org/docs/contributing.html>`_. This project is governed by `EFF's Public Projects Code of Conduct <https://www.eff.org/pages/eppcode>`_. Links ===== .. Do not modify this comment unless you know what you're doing. tag:links-begin Documentation: https://certbot.eff.org/docs Software project: https://github.com/certbot/certbot Changelog: https://github.com/certbot/certbot/blob/main/certbot/CHANGELOG.md For Contributors: https://certbot.eff.org/docs/contributing.html For Users: https://certbot.eff.org/docs/using.html Main Website: https://certbot.eff.org Let's Encrypt Website: https://letsencrypt.org Community: https://community.letsencrypt.org ACME spec: `RFC 8555 <https://tools.ietf.org/html/rfc8555>`_ ACME working area in github (archived): https://github.com/ietf-wg-acme/acme .. Do not modify this comment unless you know what you're doing. tag:links-end .. Do not modify this comment unless you know what you're doing. tag:intro-end .. Do not modify this comment unless you know what you're doing. tag:features-begin Current Features ===================== * Supports multiple web servers: - Apache 2.4+ - nginx/0.8.48+ - webroot (adds files to webroot directories in order to prove control of domains and obtain certificates) - standalone (runs its own simple webserver to prove you control a domain) - other server software via `third party plugins <https://certbot.eff.org/docs/using.html#third-party-plugins>`_ * The private key is generated locally on your system. * Can talk to the Let's Encrypt CA or optionally to other ACME compliant services. * Can get domain-validated (DV) certificates. * Can revoke certificates. * Supports ECDSA (default) and RSA certificate private keys. * Can optionally install a http -> https redirect, so your site effectively runs https only. * Fully automated. * Configuration changes are logged and can be reverted. .. Do not modify this comment unless you know what you're doing. tag:features-end Thanks ------ We appreciate the donation of credits to help us test and develop Certbot from: .. image:: https://opensource.nyc3.cdn.digitaloceanspaces.com/attribution/assets/SVG/DO_Logo_horizontal_blue.svg :width: 201 :alt: DigitalOcean Logo :target: https://www.digitalocean.com/