Skip to content

Commit d9e288a

Browse files
authored
Update Readme.md
1 parent 577fd3b commit d9e288a

File tree

1 file changed

+35
-3
lines changed

1 file changed

+35
-3
lines changed

Readme.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,40 @@ Implemented mainly to make Letsencrypt DNS01 Challenge easier.
99
Tested with Python 3.11 but *should* work with any other current version of python.
1010

1111
### Usage
12-
13-
For now there is a configuration file you need to create und ***conf/config.toml*** with your API Key and HTTP Bearer
12+
For now there is a configuration file you need to create under ***conf/config.toml*** with your API Key and HTTP Bearer
1413
Token.
14+
You can also supply this information on execution of the script via the CLI.
15+
16+
It is preferred to use a virtual environment!
17+
Be sure to install all requirements before running the script!
18+
19+
20+
To run the letsencrypt script use:
21+
```
22+
python main.py
23+
```
24+
or:
25+
```
26+
python main.py -l
27+
```
28+
<br>
29+
30+
To check if an edit is completed use:
31+
32+
```
33+
python main.py -c
34+
```
35+
<br>
36+
37+
For the help function use:
38+
39+
```
40+
python main.py -h
41+
```
42+
<br>
43+
44+
You can also run both the check and letsencrypt script, whereas the check will execute before letsencrypt, using:
1545

16-
Then just run the prototype script to get some basic info about your CSC Tenant and the domain you queried.
46+
```
47+
python main.py -c -l
48+
```

0 commit comments

Comments
 (0)