Update 'README.md'
All checks were successful
ci/woodpecker/push/build Pipeline was successful

This commit is contained in:
2023-03-18 01:34:39 +01:00
parent 78b0731457
commit e05a7d01b0

View File

@@ -13,7 +13,7 @@ this image is intended to be used in a CI piple
|`SMTP_FROM` | Yes | Your email address | `my_email@gmail.com` |`SMTP_FROM` | Yes | Your email address | `my_email@gmail.com`
|`SMTP_USER` | Yes | Your username for the server<br>usually the same as your email addres or the part before the @ | `my_email` |`SMTP_USER` | Yes | Your username for the server<br>usually the same as your email addres or the part before the @ | `my_email`
|`SMTP_PASSWORD` | Yes | its where the password go's<br>*the password gets stored in plaintext on the container* | `Hunter22` |`SMTP_PASSWORD` | Yes | its where the password go's<br>*the password gets stored in plaintext on the container* | `Hunter22`
|`EMAIL` | No | The "raw" email | Example [here](###-the-second-way) |`EMAIL` | No | The "raw" email | Example [here](#the-second-way)
|`TO_ADDRESSES` | Yes | The adress or addresses to send to<br> to send to multiple addresses add `, ` (comma and space) betean each address | `alice@outlook.com, bob@gamil.com` |`TO_ADDRESSES` | Yes | The adress or addresses to send to<br> to send to multiple addresses add `, ` (comma and space) betean each address | `alice@outlook.com, bob@gamil.com`
|`SUBJECT` | No | The email subject | `text` |`SUBJECT` | No | The email subject | `text`
|`MESSAGE` | No | The body off the email | `lots of text` |`MESSAGE` | No | The body off the email | `lots of text`
@@ -21,7 +21,7 @@ this image is intended to be used in a CI piple
|`SMTP_TLS` | No | enable/disable TLS encryption<br>Valid values are `off` or `on` *this is the default* | `on` |`SMTP_TLS` | No | enable/disable TLS encryption<br>Valid values are `off` or `on` *this is the default* | `on`
### Environment variables files ### Environment variables files
it is also posable subsitute the variables [above](##-Environment-variables) with a file it is also posable subsitute the variables [above](#environment-variables) with a file
to use this simpy take what you normaly use for the variable and put it in a file to use this simpy take what you normaly use for the variable and put it in a file
and make the contents of the `_FILE` variable the path to that file and make the contents of the `_FILE` variable the path to that file
using this way other proccesses could provide the email content using this way other proccesses could provide the email content