Skip to content

Commit 637eb5e

Browse files
authored
docs: Update readme.md
1 parent f38647d commit 637eb5e

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ sudo apt install python3-pip python-is-python3
2525

2626

2727
## Installation and usage without a Python virtual environment
28-
It is highly recommanded to use Python Virtual Environmnets instead of the installation and usage steps in this section. See [Installation with Python virtual envs and bash script for quick re-runs](#installation-with-python-virtual-envs-and-bash-script-for-quick-re-runs) for more information.
28+
It is highly recommended to use Python Virtual Environments instead of the installation and usage steps in this section. See [Installation with Python virtual envs and bash script for quick re-runs](#installation-with-python-virtual-envs-and-bash-script-for-quick-re-runs) for more information.
2929

3030
Clone the code repo:
3131
```
@@ -38,7 +38,7 @@ $ git clone https://github.com/SeattleDevs/letsencrypt-cloudflare-hook hooks/clo
3838

3939
Install required python packages:
4040
```
41-
$ pip3 install -r hooks/cloudflare/requirements.txt
41+
$ pip install -r hooks/cloudflare/requirements.txt
4242
```
4343

4444

@@ -53,7 +53,7 @@ An API token from your Cloudflare account is required. If you are currently usin
5353
- It is highly recommended to limit the API access to your IP address or subnet using the Client IP Address Filtering
5454
- Once you have completed the above steps, press the "Continue to summary" button and then "Create Token."
5555

56-
Your account's CloudFlare email and API key are expected to be in the environment, you can set the enviornment variable if you need to in bash using:
56+
Your account's CloudFlare email and API key are expected to be in the environment, you can set the environment variable if you need to in bash using:
5757

5858
```
5959
$ export CF_API_TOKEN='zzle8imobfxpg50sdb3c'
@@ -141,7 +141,7 @@ Activate the virtual env and install dependencies:
141141

142142
```
143143
source dehydrated_env/bin/activate
144-
$ (dehydrated_env) pip3 install -r hooks/cloudflare/requirements.txt
144+
$ (dehydrated_env) pip install -r hooks/cloudflare/requirements.txt
145145
```
146146

147147
### Usage with a bash script
@@ -192,17 +192,18 @@ $ cd hooks/cloudflare
192192
$ git pull
193193
$ cd ../..
194194
$ source dehydrated_env/bin/activate
195-
$ (dehydrated_env) pip3 install -r hooks/cloudflare/requirements.txt
195+
$ (dehydrated_env) pip install -r hooks/cloudflare/requirements.txt
196196
```
197197

198-
and then re-generate your certifcate as before:
198+
NOTE: To clean up older dependencies installed by pip, run `pip freeze | xargs pip uninstall -y` in your (virtual) environment to remove all currently installed packages, then reinstall only the ones listed in `hooks/cloudflare/requirements.txt` using the above `pip install`.
199+
200+
After installing/updating the dependencies, re-generate your certificate as before:
199201

200202
```
201203
$ (dehydrated_env) cd ~/cert_workspace
202204
$ (dehydrated_env) ./domaincert.sh
203205
```
204206

205-
206207
## Testing
207208
### Unit Tests
208209
If you are making changes to the code, run the unit tests with `tox` to make sure your changes aren't breaking the hook.
@@ -226,5 +227,8 @@ $ ./dehydrated --register --accept-terms --ca letsencrypt-test
226227
$ ./dehydrated -c --ca letsencrypt-test --force --force-validation -d example.com -t dns-01 -k 'hooks/cloudflare/hook.py'
227228
```
228229

230+
## Compatibility
231+
Python 3 is required. We support Linux distributions with LTS designation and active public support (e.g., Ubuntu 20.04+, Debian 11+). If your system does not map python and pip to Python 3, you may need to use python3 and pip3 instead, or install python-is-python3 (on Ubuntu/Debian).
232+
229233
## Further reading
230234
If you want some prose to go with the code, check out the relevant blog post here: [From StartSSL to Let's Encrypt, using CloudFlare DNS](http://kappataumu.com/articles/letsencrypt-cloudflare-dns-01-hook.html).

0 commit comments

Comments
 (0)