summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLuke Smith <luke@lukesmith.xyz>2020-05-03 10:50:21 -0400
committerGitHub <noreply@github.com>2020-05-03 10:50:21 -0400
commitcd69caf89864902ef901198dbcf50e90e00c098e (patch)
tree31c36ab6f4e07ee43a647498e0b518c2238924cb /README.md
parent1664fc4b5157c03f517b7a111c44885a90813dda (diff)
parent272e6b23267e18b291afe61ff93152ee92dca1f5 (diff)
Merge branch 'master' into patch-1
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 5 insertions, 14 deletions
diff --git a/README.md b/README.md
index d046d47..552d4c5 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,8 @@
I wrote this script during the gruelling process of installing and setting up a web server.
It perfectly reproduces my successful steps to ensure the same setup time and time again.
-Deviate from one command and everything might fall apart unless you know better!
-I've linked this file on Github to a shorter, more memorable address on my LARBS.xyz domain, so you can get it on your machine with this short command:
+I've linked this file on Github to a shorter, more memorable address on my website so you can get it on your machine with this short command:
```
curl -LO lukesmith.xyz/emailwiz.sh
@@ -13,7 +12,7 @@ curl -LO lukesmith.xyz/emailwiz.sh
When prompted by a dialog menu at the beginning, select "Internet Site", then give your full domain without any subdomain, i.e. `lukesmith.xyz`.
Read this readme and peruse the script's comments before running it.
-Expect it to fail.
+Expect it to fail and you have to do bug testing and you will be very happy when it actually works perfectly.
## This script...
@@ -36,23 +35,15 @@ Expect it to fail.
- **SSL for your site's mail subdomain**, specifically for mail.yourdomain.tld with Let's Encrypt. The script will look to Let's Encrypt's generated configs. If you have some other SSL system, you can manually change the SSL locations in the script before running it and it should be fine.
- After the script runs, you'll have to add an *additional DNS TXT record* which involves the OpenDKIM key that it generates during the script.
-## Don't get offended by this section
+## Caveats
My intention is to have this script working for me on my Debian web server which I have with Vultr.
Different VPS hosts or distros might have a startup config that's a little different and I'm sure as heck not going to make sure everything works on every possible machine out there, please do not even ask.
If a lot of people try this script and see that it works as expected everywhere, then I might try to label it as such and try to make it universal, but think of this script as a script that works on my exact setup that has some educational comments for the uninitiated and only _might_ work as intended.
-Configuring an email server is a living nightmare and that's why I made this script so I wouldn't have to do it again.
-Don't ask me to configure your email server unless you are paying me big bucks to do it.
-With this script and the comments in it, I've given you way more than I owe you.
-
-If something is broken, start a PR to fix it, but ***do not*** open Issues about some problem you have unless you have figured out a solution and are offering a way for me to add a small change that will make this script more robust.
-Your mindset in running this script should be "Oh, look, it puts all the commands in a bash-readable format, so I can run it and troubleshoot errors as they come up.".
-The script works for me and if it works for you without a problem, be thankful and feel lucky because setting up email is usually just so much less forgiving.
-
If you decide to start a VPS, specifically Vultr since I made this script and have tempered it most on their default setup,
-use [this referal link of mine](https://www.vultr.com/?ref=7914655-4F) because you get a free $50 credit, and if you stay on the site, then eventually I'll get a kickback too.
-I honestly don't have a really strong preference of Vultr over other VPS providers, but they're about as cheap and reliable as it gets and if we can get free money, lol whatever click the link 👏👏.
+use [this referal link of mine](https://www.vultr.com/?ref=8384069-6G) because you get a free $100 credit for a month, and if you stay on the site, eventually I get a smaller kickback too.
+I honestly have no really strong preference of Vultr over other VPS providers, but they're about as cheap and reliable as it gets and if we can get free money, lol whatever click the link 👏👏.
## Details