diff --git a/docs/oauth.rst b/docs/oauth.rst index d5519356..9b094b70 100644 --- a/docs/oauth.rst +++ b/docs/oauth.rst @@ -18,13 +18,13 @@ Configuring your provider In order to use OAuth, configure your OAuth provider (GitHub, Google, Azure AD). -You must configure your provider to use the Netmaker Dashboard URI dashboard. as the origin URL. +You must configure your provider (except for Azure AD) to use the Netmaker Dashboard URI dashboard. as the origin URL. For example: `https://dashboard.netmaker.mydomain.com` -You must configure your provider to use the Netmaker API URI redirect route with the following format: https://api./api/oauth2/callback. +You must configure your provider to use the Netmaker API URI redirect route with the following format: https://api./api/oauth/callback. -For example: `https://api.netmaker.mydomain.com/api/oauth2/callback` +For example: `https://api.netmaker.mydomain.com/api/oauth/callback` General provider instructions can be found with the following links: @@ -41,14 +41,18 @@ Next, Configure Netmaker with the following environment variables. If any are le .. code-block:: - AUTH_PROVIDER="" - CLIENT_ID="" - CLIENT_SECRET="" - SERVER_HTTP_HOST="https://" - FRONTEND_URL="https://" + AUTH_PROVIDER: "" + CLIENT_ID: "" + CLIENT_SECRET: "" + SERVER_HTTP_HOST: "api." + FRONTEND_URL: "https://dashboard." -After restarting your server, the Netmaker logs will indicate if the OAuth provider was successfully initialized. +After restarting your server, the Netmaker logs will indicate if the OAuth provider was successfully initialized: + +.. code-block:: + + sudo docker logs netmaker Once successful, users can click the key symbol on the login page to sign-in with your configured OAuth provider.