Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Cannot pass in authConfig via environment variable #460

Closed
alukach opened this issue Aug 7, 2024 · 1 comment · May be fixed by #461
Closed

Cannot pass in authConfig via environment variable #460

alukach opened this issue Aug 7, 2024 · 1 comment · May be fixed by #461

Comments

@alukach
Copy link

alukach commented Aug 7, 2024 •
edited
Loading

I don't believe that it is currently possible to set the authConfig via environment variable.

Issue

  1. Build docker image: docker build -t stac-browser
  2. Run docker image with auth config set as environment variable: docker run -it -e SB_authConfig='{"foo": "bar"}' --name stac-browser stac-browser
  3. In another terminal, review the generated config: docker exec stac-browser cat /usr/share/nginx/html/config.js

You should see an object where the authConfig property is a string rather than an object:

window.STAC_BROWSER_CONFIG = {
  authConfig: '{"foo": "bar"}',
}

Cause

This is caused by the fact that when we parse the SB_* environment values based on their type as specified in the config.schema.json we don't handle the object type so it is run through the catch-all safe_echo code:

stac-browser/config.schema.json

Lines 225 to 236 in 108947e

"authConfig": {
"type": [
"object"
],
"allOf": [
{
"$ref": "https://stac-extensions.github.io/authentication/v1.1.0/schema.json"
}
],
"noCLI": true,
"noEnv": true
}

stac-browser/docker/docker-entrypoint.sh

Lines 58 to 92 in 108947e

env -0 | cut -f1 -d= | tr '\0' '\n' | grep "^SB_" | {
echo "window.STAC_BROWSER_CONFIG = {"
while IFS='=' read -r name; do
# Strip the prefix
argname="${name#SB_}"
# Read the variable's value
value="$(eval "echo \"\$$name\"")"
# Get the argument type from the schema
argtype="$(echo "$config_schema" | jq -r ".properties.$argname.type[0]")"
arraytype="$(echo "$config_schema" | jq -r ".properties.$argname.items.type[0]")"
# Encode key/value
echo -n " $argname: "
case "$argtype" in
string)
safe_echo "$value"
;;
boolean)
bool "$value"
;;
integer | number)
object "$value"
;;
array)
array "$value" "$arraytype"
;;
*)
safe_echo "$value"
;;
esac
echo ","
done
echo "}"
} > /usr/share/nginx/html/config.js

This keeps it as a string:

stac-browser/docker/docker-entrypoint.sh

Lines 1 to 2 in 108947e

# echo a string, handling different types
safe_echo() {

@alukach alukach mentioned this issue Aug 7, 2024
Open
@alukach
Copy link
Author

alukach commented Aug 9, 2024

As @m-mohr pointed out, the docs do indeed state that this is unsupported. Discussion on whether it should be supported can take place in #461.

@alukach alukach closed this as completed Aug 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Permit passing config object via env vars alukach/stac-browser
1 participant
@alukach