From 5d2f4b1bbae047b43efdd5156ce028d9e44548c3 Mon Sep 17 00:00:00 2001 From: Ian Fijolek Date: Wed, 17 Feb 2021 10:31:06 -0800 Subject: [PATCH] Update readme to describe removal of openssl dependency --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7d7d054..c7a9d64 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ Set your Slack status via the command line ## Requirements -Rather than host a web server that you would need to trust, this command runs one on your local machine to retrieve the OAuth code. This page is hosted with an auto generated, self-signed certificate. +Rather than host a web server that you would need to trust, this command runs one on your local machine to retrieve the OAuth code. This page is hosted with an embedded, self-signed certificate. -This requires you to have `openssl` installed on your machine and, when the page loads for the first time, it will require you to trust the certificate or ignore the warning. +When the page loads for the first time, it will require you to trust the certificate or ignore the warning. Here's how to do that on [Firefox](https://support.mozilla.org/en-US/kb/error-codes-secure-websites?as=u&utm_source=inproduct#w_self-signed-certificate). On Chrome, you may have to enable `chrome://flags/#allow-insecure-localhost`. If you can't get the link to open in Chrome, you can copy the URL into a different browser and try it there. It should work in Firefox or Safari. @@ -69,3 +69,7 @@ Clear existing status and snooze durations Snooze notifications without updating your status slack-status -duration 15m -snooze + +## Development + +Building requires you to have `openssl` installed on your machine and to export `CLIENT_ID` and `CLIENT_SECRET` environment variables. The certificate and client info can be overridden at runtime for development purposes by running with exported variables post compilation as well as placing the your openssl pem files in the application's config directory. See `auth.go` for more information.