superset_app_root doesn't work in superset 4.1.2 with nginx

[wqbbs911]

Bug description

hi, i need to prefix superset app in k8s cluster.
so i installed superset 4.1.2-py311 in K8S with official helm chart superset/superset:0.14.2 and tried to visit it via proxy nginx , but it doesn't work. the steps are:

1. According to official document https://superset.apache.org/docs/configuration/configuring-superset/#configuring-the-application-root , added below env in superset_config.py via alues-orig.yaml configOverrides field:

SUPERSET_APP_ROOT= '/analytics'
ENABLE_PROXY_FIX = True
STATIC_ASSETS_PREFIX = '/analytics'

2. configure nginx, (BTW, my nginx server not in k8s, but the network if reachable, it able to visit superset pod ip )

location /analytics/ {
    proxy_pass         http://pod_ip:8080/;
    proxy_set_header Host $host;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Script-Name /analytics;
}

3. after deployed , try to visit it via https://servername/analytics, it will redirect to https://servername/superset/welcome/ and then got 404

4. i checked env and superset_config.py in pod, seems no problem:

root@superset-5f44bc7bf6-gf2zx:/app# env
REDIS_DB=1
KUBERNETES_SERVICE_PORT_HTTPS=443
PYTHON_SHA256=2a9920c7a0cd236de33644ed980a13cbbc21058bfdc528febb6081575ed73be3
KUBERNETES_SERVICE_PORT=443
HOSTNAME=superset-5f44bc7bf6-gf2zx
PYTHON_VERSION=3.11.11
SUPERSET_REDIS_MASTER_PORT_6379_TCP_ADDR=10.11.254.79
REDIS_HOST=superset-redis-headless
REDIS_USER=
SUPERSET_SERVICE_PORT=8080
SUPERSET_REDIS_MASTER_PORT_6379_TCP_PORT=6379
PWD=/app
SUPERSET_REDIS_MASTER_PORT_6379_TCP_PROTO=tcp
REDIS_PROTO=redis
SUPERSET_SERVICE_PORT_HTTP=8080
DB_PORT=5432
DB_USER=superset
HOME=/root
LANG=C.UTF-8
KUBERNETES_PORT_443_TCP=tcp://10.11.252.1:443
GPG_KEY=A035C8C19219BA821ECEA86B64E628F8D684696D
SUPERSET_HOME=/app/superset_home
SUPERSET_REDIS_MASTER_SERVICE_PORT=6379
SUPERSET_SERVICE_HOST=10.11.254.75
SUPERSET_PORT_8080_TCP=tcp://10.11.254.75:8080
REDIS_CELERY_DB=0
SUPERSET_REDIS_MASTER_PORT=tcp://10.11.254.79:6379
PYTHONPATH=/app/pythonpath
TERM=xterm
DB_HOST=superset-postgresql
SUPERSET_PORT_8080_TCP_PORT=8080
FLASK_APP=superset.app:create_app()
SUPERSET_PORT_8080_TCP_ADDR=10.11.254.75
SHLVL=1
KUBERNETES_PORT_443_TCP_PROTO=tcp
SUPERSET_PORT_8080_TCP_PROTO=tcp
KUBERNETES_PORT_443_TCP_ADDR=10.11.252.1
REDIS_PORT=6379
DB_NAME=superset
KUBERNETES_SERVICE_HOST=10.11.252.1
LC_ALL=C.UTF-8
KUBERNETES_PORT=tcp://10.11.252.1:443
KUBERNETES_PORT_443_TCP_PORT=443
PATH=/usr/local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
SUPERSET_PORT=8080
SUPERSET_APP_ROOT=/analytics
SUPERSET_REDIS_MASTER_SERVICE_HOST=10.11.254.79
DB_PASS=superset
SUPERSET_REDIS_MASTER_SERVICE_PORT_TCP_REDIS=6379
SUPERSET_REDIS_MASTER_PORT_6379_TCP=tcp://10.11.254.79:6379
SUPERSET_ENV=production
_=/usr/bin/env
root@superset-5f44bc7bf6-gf2zx:/app#

part of my custom setting in superset_config.py:

...
...
# Overrides
# my_override
WTF_CSRF_ENABLED = False
DEFAULT_FEATURE_FLAGS = {
  "ENABLE_TEMPLATE_PROCESSING": True
  }
ENABLE_CORS = True
CORS_ORIGINS = ["*"]
CORS_HEADERS = "*"
CORS_SUPPORTS_CREDENTIALS = True
APPLICATION_ROOT = '/analytics'
STATIC_ASSETS_PREFIX = '/analytics'
SUPERSET_APP_ROOT= '/analytics'
ENABLE_PROXY_FIX = True
LOG_LEVEL = "DEBUG"
...
...

5. checkk logs
   nginx log:

pod log:

i also tried other ways below also doesn't work:
https://github.com/emesday/prefixed-superset/blob/main/nginx/conf.d/superset.conf.template
https://www.restack.io/docs/superset-knowledge-superset-url-prefix-guide
https://github.com/KomootArchive/superset-reverse-nginx-example/blob/master/nginx/nginx.conf

any suggestion ?

Screenshots/recordings

No response

Superset version

4.1.2

Python version

3.11

Node version

Not applicable

Browser

Firefox

Additional context

No response

Checklist

• I have searched Superset docs and Slack and didn't find a solution to my problem.
• I have searched the GitHub issue tracker and didn't find a similar bug report.
• I have checked Superset's logs for errors and if I found a relevant Python stacktrace, I included it here as text in the "additional context" section.

[dosubot[bot]]

To resolve the 404 error when accessing Apache Superset 4.1.2 with a custom application root '/analytics' in a Kubernetes environment using Nginx as a proxy, ensure that the SUPERSET_APP_ROOT is correctly configured. You can do this by setting the SUPERSET_APP_ROOT environment variable to '/analytics'. Additionally, ensure that your Nginx configuration correctly forwards requests to the Superset application with the '/analytics' prefix.

Here is how you can set the SUPERSET_APP_ROOT:

FLASK_APP="superset:create_app(superset_app_root='/analytics')"

Or, if you are using Docker:

SUPERSET_APP_ROOT='/analytics'

Make sure your Nginx configuration is set to handle the '/analytics' path correctly, forwarding it to the Superset service. This might involve setting up a location block in your Nginx configuration like this:

location /analytics/ {
    proxy_pass http://your-superset-service/analytics/;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    proxy_set_header X-Forwarded-Proto $scheme;
}

Ensure that the Nginx configuration and the Superset application root are consistent with each other ^[1].

Additionally, when using a reverse proxy with a custom application root, you should enable the ENABLE_PROXY_FIX setting in the Superset configuration to ensure that all X-Forwarded headers are used correctly. This is important when Superset is behind a reverse proxy. You can do this by setting:

ENABLE_PROXY_FIX = True

Furthermore, ensure that the X-Script-Name header is set correctly in your Nginx configuration to match the prefix ^[1][2].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[wqbbs911]

please don't reply by BOT , its suggestion doesn't work.

[rusackas]

What doesn't work about the bot's response? It looks at least mostly correct to me. Here's the latest PR regarding SUPERSET_APP_ROOT that may help with more info. #30134

I'll move this to a Discussion, since it's a config/infra question rather than a Superset bug.

[dsuarez]

I am also having problems with this topic.

I have tried multiple configurations, including APPLICATION_ROOT variable in superset_config.py, and environment variable SUPERSET_APP_ROOT. It is unclear what is the right way to do it properly.

Moreover, in some of the configurations, I was able to access superset in my non-root directory, but statics were not properly located.

I am using docker-compose. I mount superset_config.py from host in /app/pythonpath_docker in the containers.

I am using nginx as proxy to load certificates and HTTPs, like this:

location /my/dir/ {
    proxy_pass         http://superset_upstream/my/dir;
    proxy_set_header   Host              $host;
    proxy_set_header   X-Real-IP         $remote_addr;
    proxy_set_header   X-Forwarded-For   $proxy_add_x_forwarded_for;
    proxy_set_header   X-Forwarded-Proto $scheme;
}

[irodriguez-nebustream]

I also could not get it to work. Tried everything just like you. I actually went in and changed the image tag to FROM apache/superset:GHA-dev-14737083364 and that worked. I'll be completely honest, I am not sure why that worked, but I'm going to keep it for now.

[irodriguez-nebustream]

I also could not get it to work. Tried everything just like you. I actually went in and changed the image tag to FROM apache/superset:GHA-dev-14737083364 and that worked. I'll be completely honest, I am not sure why that worked, but I'm going to keep it for now.