adding feature to allow for override of the default rekor domain on s… (

#67)

* adding feature to allow for override of the default rekor domain on startup of the UI

Signed-off-by: Ahmed Alsabag <ahmed.alsabag@gmail.com>

* adding comment to explain the use of the NEXT_PUBLIC prefix

Signed-off-by: Ahmed Alsabag <ahmed.alsabag@gmail.com>

* fixing formatting and spacing issues

Signed-off-by: Ahmed Alsabag <ahmed.alsabag@gmail.com>

---------

Signed-off-by: Ahmed Alsabag <ahmed.alsabag@gmail.com>

README.md

@@ -17,3 +17,12 @@ Open [http://localhost:3000](http://localhost:3000) with your browser to see the
 ## Deploy
 
 The app is based on [Next.JS](https://nextjs.org/) and is automatically built & deployed to GitHub Pages when pushing to the `main` branch.
+
+## Internal Server Configuration
+
+This app supports overriding of the default rekor server instance for those running private instances of the the sigstore stack.
+Create a `.env.local` file at the root and include in it this environment variable
+
+```properties
+NEXT_PUBLIC_REKOR_DEFAULT_DOMAIN=https://privaterekor.sigstore.dev
+```

src/modules/api/context.tsx

@@ -24,6 +24,16 @@ export const RekorClientProvider: FunctionComponent<PropsWithChildren<{}>> = ({
 	const [baseUrl, setBaseUrl] = useState<string>();
 
 	const context: RekorClientContext = useMemo(() => {
+		/*
+		Using the Next.js framework, the NEXT_PUBLIC_REKOR_DEFAULT_DOMAIN env variable requires
+		a NEXT_PUBLIC_* prefix to make the value of the variable accessible to the browser.
+		Variables missing this prefix are only accessible in the Node.js environment.
+		https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables
+		*/
+		if (baseUrl === undefined && process.env.NEXT_PUBLIC_REKOR_DEFAULT_DOMAIN) {
+			setBaseUrl(process.env.NEXT_PUBLIC_REKOR_DEFAULT_DOMAIN);
+		}
+
 		return {
 			client: new RekorClient({ BASE: baseUrl }),
 			baseUrl,

src/modules/components/Settings.tsx

@@ -30,6 +30,13 @@ export function Settings({
 	}, []);
 
 	const onSave = useCallback(() => {
+		if (
+			localBaseUrl === undefined &&
+			process.env.NEXT_PUBLIC_REKOR_DEFAULT_DOMAIN
+		) {
+			setLocalBaseUrl(process.env.NEXT_PUBLIC_REKOR_DEFAULT_DOMAIN);
+		}
+
 		setBaseUrl(localBaseUrl);
 		onClose();
 	}, [localBaseUrl, setBaseUrl, onClose]);
@@ -49,7 +56,9 @@ export function Settings({
 					<Typography variant="overline">Override rekor endpoint</Typography>
 					<TextField
 						value={localBaseUrl ?? ""}
-						placeholder="https://rekor.sigstore.dev"
+						placeholder={
+							baseUrl === undefined ? "https://rekor.sigstore.dev" : baseUrl
+						}
 						onChange={handleChangeBaseUrl}
 						fullWidth
 					/>