Added ACKEE_ANONYMOUS Environmental Variable For Allowing Users To View The Ackee UI Without Logging In

app.json

@@ -32,6 +32,10 @@
     "ACKEE_TRACKER": {
       "description": "Specifies a custom name for the tracking script (Default: tracker.js)",
       "required": false
+    },
+    "ACKEE_ANONYMOUS": {
+      "description": "When set to true, allows users to view the Ackee UI without a username and password",
+      "required": false
     }
   }
-}
+}

docs/Options.md

@@ -46,6 +46,14 @@ ACKEE_USERNAME=username
 ACKEE_PASSWORD=password
 ```
 
+## Anonymous Mode
+
+When set to `true`, allows users to access the Ackee UI without a username or password.  Can be useful for when Ackee is behind a reverse proxy and the reverse proxy is handling authentication.
+
+```
+ACKEE_ANONYMOUS=true
+```
+
 ## TTL
 
 Specifies how long a generated token is valid. Defaults to `3600000` (1 day).

netlify.toml

@@ -14,4 +14,5 @@
   ACKEE_MONGODB = "ACKEE_MONGODB"
   ACKEE_USERNAME = "ACKEE_USERNAME"
   ACKEE_PASSWORD = "ACKEE_PASSWORD"
-  ACKEE_ALLOW_ORIGIN = "ACKEE_ALLOW_ORIGIN"
+  ACKEE_ALLOW_ORIGIN = "ACKEE_ALLOW_ORIGIN"
+  ACKEE_ANONYMOUS = "ACKEE_ANONYMOUS"

src/index.js

@@ -31,6 +31,10 @@ connect(config.dbUrl).then(() => {
 	if (config.isDemoMode === true) {
 		signale.info('Demo mode enabled')
 	}
+
+	if (config.isAnonymousMode === true) {
+		signale.info('Anonymous mode enabled')
+	}
 })
 	.catch((error) => {
 		signale.fatal(error)

src/resolvers/tokens.js

@@ -14,13 +14,16 @@ const response = (entry) => ({
 module.exports = {
 	Mutation: {
 		createToken: async (parent, { input }, { setCookies }) => {
-			const { username, password } = input
+			// If anonymous mode then skip checking for a username and password and just make the token
+			if (!config.isAnonymousMode) {
+				const { username, password } = input
 
-			if (config.username == null) throw new KnownError('Ackee username missing in environment')
-			if (config.password == null) throw new KnownError('Ackee username missing in environment')
+				if (config.username == null) throw new KnownError('Ackee username missing in environment')
+				if (config.password == null) throw new KnownError('Ackee username missing in environment')
 
-			if (username !== config.username) throw new KnownError('Username or password incorrect')
-			if (password !== config.password) throw new KnownError('Username or password incorrect')
+				if (username !== config.username) throw new KnownError('Username or password incorrect')
+				if (password !== config.password) throw new KnownError('Username or password incorrect')
+			}
 
 			const entry = await tokens.add()
 

src/ui/index.js

@@ -11,6 +11,7 @@ const signale = require('../utils/signale')
 const index = () => {
 	return layout('<div id="main"></div>', 'favicon.ico', [ 'index.css' ], [ 'index.js' ], {
 		isDemoMode: config.isDemoMode,
+		isAnonymousMode: config.isAnonymousMode,
 		customTracker,
 	})
 }

src/ui/scripts/components/overlays/OverlayLogin.js

@@ -34,6 +34,23 @@ const OverlayLogin = (props) => {
 		props.setToken(data.createToken.payload.id)
 	}
 
+	// If in anonymous mode go ahead and generate the token and then close this modal
+	const createAnonymousToken = async () => {
+		const { data } = await createToken.mutate({
+			variables: {
+				input: {
+					username: 'anonymous',
+					password: 'anonymous',
+				},
+			},
+		})
+		props.setToken(data.createToken.payload.id)
+	}
+
+	if (window.env.isAnonymousMode) {
+		createAnonymousToken()
+	}
+
 	return (
 		h('form', { className: 'card card--overlay', onSubmit },
 			h('div', { className: 'card__inner align-center' },

src/ui/scripts/components/routes/RouteSettings.js

@@ -69,16 +69,24 @@ const RouteSettings = (props) => {
 	const eventsItems = createItems(events.value, showEventEditModal, showEventAddModal, 'New event')
 	const permanentTokensItems = createItems(permanentTokens.value, showPermanentTokenEditModal, showPermanentTokenAddModal, 'New permanent token')
 
+	const accountCard = window.env.isAnonymousMode ?
+		h(CardSetting, {
+			headline: 'Account',
+		},
+			h(LinkItem, { type: 'p', disabled: true, text: version }, 'Version'),
+		) :
+		h(CardSetting, {
+			headline: 'Account',
+		},
+			h(LinkItem, { type: 'p', disabled: true, text: version }, 'Version'),
+			h(Line),
+			h(LinkItem, { type: 'button', onClick: onSignOut }, 'Sign Out'),
+		)
+
 	return (
 		h(Fragment, {},
 
-			h(CardSetting, {
-				headline: 'Account',
-			},
-				h(LinkItem, { type: 'p', disabled: true, text: version }, 'Version'),
-				h(Line),
-				h(LinkItem, { type: 'button', onClick: onSignOut }, 'Sign Out'),
-			),
+			accountCard,
 
 			h(CardSetting, {
 				headline: 'Domains',

src/utils/config.js

@@ -16,6 +16,7 @@ module.exports = new Proxy({}, {
 			isDemoMode: process.env.ACKEE_DEMO === 'true',
 			isDevelopmentMode: process.env.NODE_ENV === 'development',
 			isPreBuildMode: process.env.BUILD_ENV === 'pre',
+			isAnonymousMode: process.env.ACKEE_ANONYMOUS,
 		}
 
 		return data[prop]