Required to set custom context url for superset

[tanmoyrsc]

I required to access using customized URL like https://FQDN/base/dashboard, but not able to do so, could you please let me know if this feature is available or not, if available then how to do it?
Br,
Tanmoy

[dosubot[bot]]

Hey @tanmoyrsc! 👋 I'm here to help you with any bugs, questions, or contributions you have in mind. I'm a bot designed to assist you while you wait for a human maintainer.

To set a custom context URL for Apache Superset, you need to modify the SUPERSET_WEBSERVER_BASEURL property in the superset_config.py file. This will allow you to access Superset using a customized URL like https://FQDN/base/dashboard.

Here is how you can configure it:

1. Create or modify the superset_config.py file.
2. Add the following configuration to set the base URL:

# superset_config.py

# Set the base URL for Superset
SUPERSET_WEBSERVER_BASEURL = 'https://FQDN/base'

3. Ensure that the superset_config.py file is in your PYTHONPATH or set the SUPERSET_CONFIG_PATH environment variable to the full path of the superset_config.py file.

For example, if deploying on a Linux-based system where your superset_config.py is under the /app directory, you can run:

export SUPERSET_CONFIG_PATH=/app/superset_config.py

If you are using Docker, you can add your overrides as shown below:

COPY --chown=superset superset_config.py /app/
ENV SUPERSET_CONFIG_PATH /app/superset_config.py

This change will set the base URL to /base, allowing you to access Superset using the customized URL https://FQDN/base/dashboard ^[1][2].

To continue talking to Dosu, mention @dosu.

[crsenthil78]

@tanmoyrsc had a chance to try the solution did it worked?

[Abdi-Arslene]

this doesn't work

[dosubot[bot]]

Yes, Apache Superset supports setting a custom context URL or base path. You can achieve this by configuring the APPLICATION_ROOT parameter in your superset_config.py file. Here is how you can do it:

1. Update superset_config.py:

   # superset_config.py
   
   # Set the application root to the desired subpath
   APPLICATION_ROOT = '/base'

2. Enable Proxy Fix:
   Ensure that the reverse proxy (e.g., NGINX) forwards the correct headers by setting ENABLE_PROXY_FIX to True:

   # superset_config.py
   
   ENABLE_PROXY_FIX = True

3. Configure Your Reverse Proxy (e.g., NGINX):
   You need to configure your reverse proxy to handle the subpath correctly. Here is an example NGINX configuration:

   server {
       listen 80;
       server_name your_domain.com;
   
       location /base/ {
           proxy_pass http://localhost:8088/;
           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-Forwarded-Host $host;
           proxy_set_header X-Forwarded-Port $server_port;
       }
   }

These configurations should help you run Superset under a custom base path URL ^[1][2].

To continue talking to Dosu, mention @dosu.

[ghettosamson]

Has anyone gotten this to work? If so, what was your solution?

[v1690117]

The best I've found is #1866 (comment) .
Generally works.

[v9dev]

I Changed the frontend and backend code and test it I am able to change the url completely If Anyone want then I can upload my code on the github. I don't chages the test files codes so it can be problem if we use test commands but without test it work without any problem.

[rowi-dev]

@v9dev can you please upload the updated code

[pettyferlove]

你需要添加一个独立的代理Nginx，以Docker-Compose为例

1. 添加superset.conf.template

upstream superset {
  server superset:8088;
}

server {
  listen 80;

  # 开启gzip压缩
  gzip on;
  gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;
  gzip_min_length 1000;
  gzip_proxied any;

  # 安全headers
  add_header X-Frame-Options "SAMEORIGIN" always;
  add_header X-XSS-Protection "1; mode=block" always;
  add_header X-Content-Type-Options "nosniff" always;
  add_header Referrer-Policy "no-referrer-when-downgrade" always;

  # 根路径重定向
  location = / {
    return 301 $scheme://$host/${SUPERSET_CONTEXT_PATH}/;
  }

  location / {
    rewrite ^/$ /${SUPERSET_CONTEXT_PATH}/ permanent;
    rewrite ^/(.*)$ /${SUPERSET_CONTEXT_PATH}/$1 permanent;
  }

  # 主要代理配置
  location ^~ /${SUPERSET_CONTEXT_PATH}/ {
    rewrite ^/${SUPERSET_CONTEXT_PATH}/(.*)$ /$1?$args break;
    proxy_pass http://superset;

    # 超时设置
    proxy_connect_timeout 300;
    proxy_send_timeout 300;
    proxy_read_timeout 300;

    # 缓冲区配置
    proxy_buffer_size 128k;
    proxy_buffers 4 256k;
    proxy_busy_buffers_size 256k;

    # WebSocket支持
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";

    # 基础头部设置
    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;
    proxy_set_header X-Forwarded-Host $host;
    proxy_set_header X-Script-Name /${SUPERSET_CONTEXT_PATH};
    proxy_set_header Accept-Encoding "";

    # URL替换配置
    sub_filter_types *;
    sub_filter_once off;

    # API路径替换
    sub_filter '/api/v1/' '/${SUPERSET_CONTEXT_PATH}/api/v1/';
    sub_filter 'api/v1/' '${SUPERSET_CONTEXT_PATH}/api/v1/';

    # 静态资源路径替换
    sub_filter '/static/assets/' '/${SUPERSET_CONTEXT_PATH}/static/assets/';
    sub_filter '/static/appbuilder/' '/${SUPERSET_CONTEXT_PATH}/static/appbuilder/';
    sub_filter 'href="static/' 'href="${SUPERSET_CONTEXT_PATH}/static/';
    sub_filter 'src="static/' 'src="${SUPERSET_CONTEXT_PATH}/static/';

    # Superset核心路径替换
    sub_filter '/superset/' '/${SUPERSET_CONTEXT_PATH}/superset/';
    sub_filter '/dashboard/' '/${SUPERSET_CONTEXT_PATH}/dashboard/';
    sub_filter '/dashboardasync/' '/${SUPERSET_CONTEXT_PATH}/dashboardasync/';
    sub_filter '/chart/' '/${SUPERSET_CONTEXT_PATH}/chart/';
    sub_filter '/sqllab/' '/${SUPERSET_CONTEXT_PATH}/sqllab/';
    sub_filter '/users/' '/${SUPERSET_CONTEXT_PATH}/users/';
    sub_filter '/lang/' '/${SUPERSET_CONTEXT_PATH}/lang/';
    sub_filter '/roles/' '/${SUPERSET_CONTEXT_PATH}/roles/';
    sub_filter '/logout' '/${SUPERSET_CONTEXT_PATH}/logout';
    sub_filter '/logout/' '/${SUPERSET_CONTEXT_PATH}/logout/';
    sub_filter '/login' '/${SUPERSET_CONTEXT_PATH}/login';
    sub_filter '/login/' '/${SUPERSET_CONTEXT_PATH}/login/';
    sub_filter '/explore/' '/${SUPERSET_CONTEXT_PATH}/explore/';
    sub_filter '/alert/' '/${SUPERSET_CONTEXT_PATH}/alert/';

    # 管理视图路径替换
    sub_filter '/tabstateview/' '/${SUPERSET_CONTEXT_PATH}/tabstateview/';
    sub_filter '/savedqueryview/' '/${SUPERSET_CONTEXT_PATH}/savedqueryview/';
    sub_filter '/savedqueryviewapi/' '/${SUPERSET_CONTEXT_PATH}/savedqueryviewapi/';
    sub_filter '/databaseview/' '/${SUPERSET_CONTEXT_PATH}/databaseview/';
    sub_filter '/tablemodelview/' '/${SUPERSET_CONTEXT_PATH}/tablemodelview/';
    sub_filter '/rowlevelsecurity/' '/${SUPERSET_CONTEXT_PATH}/rowlevelsecurity/';
    sub_filter '/rowlevelsecurityfiltersmodelview/' '/${SUPERSET_CONTEXT_PATH}/rowlevelsecurityfiltersmodelview/';
    sub_filter '/logmodelview/' '/${SUPERSET_CONTEXT_PATH}/logmodelview/';
    sub_filter '/annotationlayer/' '/${SUPERSET_CONTEXT_PATH}/annotationlayer/';
    sub_filter '/annotationlayermodelview/' '/${SUPERSET_CONTEXT_PATH}/annotationlayermodelview/';
    sub_filter '/csstemplatemodelview/' '/${SUPERSET_CONTEXT_PATH}/csstemplatemodelview/';
    sub_filter '/csstemplateasyncmodelview/' '/${SUPERSET_CONTEXT_PATH}/csstemplateasyncmodelview/';
    sub_filter '/tableschemaview/' '/${SUPERSET_CONTEXT_PATH}/tableschemaview/';
    sub_filter '/csvtodatabaseview/' '/${SUPERSET_CONTEXT_PATH}/csvtodatabaseview/';
    sub_filter '/columnartodatabaseview/' '/${SUPERSET_CONTEXT_PATH}/columnartodatabaseview/';
    sub_filter '/exceltodatabaseview/' '/${SUPERSET_CONTEXT_PATH}/exceltodatabaseview/';
    sub_filter '/annotationmodelview/' '/${SUPERSET_CONTEXT_PATH}/annotationmodelview/';

    # 特殊路径处理
    sub_filter 'href="/back"' 'href="/${SUPERSET_CONTEXT_PATH}/back"';

    # 代理重定向设置
    proxy_redirect 'http://$host/' '/${SUPERSET_CONTEXT_PATH}/';
    proxy_redirect '/' '/${SUPERSET_CONTEXT_PATH}/';
  }

  # 静态文件处理
  location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
    expires 30d;
    add_header Cache-Control "public, no-transform";
    try_files $uri /${SUPERSET_CONTEXT_PATH}/$uri /${SUPERSET_CONTEXT_PATH}/$uri?$query_string @rules;
  }

  # 通用路径处理
  location ~ ^/(static|superset|sqllab|savedqueryview|druid|tablemodelview|databaseasync|dashboardmodelview|slicemodelview|api|dashboard|dashboardasync|chart|users|lang|roles|logout|login|explore|alert|tabstateview|savedqueryviewapi|databaseview|rowlevelsecurity|rowlevelsecurityfiltersmodelview|logmodelview|annotationlayer|annotationlayermodelview|csstemplatemodelview|csstemplateasyncmodelview|tableschemaview|csvtodatabaseview|columnartodatabaseview|exceltodatabaseview|annotationmodelview|back|static/assets|static/appbuilder) {
    try_files $uri /${SUPERSET_CONTEXT_PATH}/$uri /${SUPERSET_CONTEXT_PATH}/$uri?$query_string @rules;
  }

  location @rules {
    rewrite ^(.*)$ /${SUPERSET_CONTEXT_PATH}$1 permanent;
  }

  # 错误页面处理
  error_page 500 502 503 504 /50x.html;
  location = /50x.html {
    root /usr/share/nginx/html;
  }
}

2. 修改docker-compose-image-tag.yml，添加nginx

services:
  # 省略其他容器...
  # 以下是新增的容器
  superset-nginx:
    image: nginx:alpine
    environment:
      - "SUPERSET_CONTEXT_PATH=${SUPERSET_CONTEXT_PATH:-awesome}"
    command: /bin/sh -c "envsubst '$${SUPERSET_CONTEXT_PATH}' < /etc/nginx/conf.d/superset.conf.template > /etc/nginx/conf.d/default.conf && cat /etc/nginx/conf.d/default.conf && nginx -g 'daemon off;'"
    volumes:
      - "./superset.conf.template:/etc/nginx/conf.d/superset.conf.template"
    ports:
      - "80:80"
    depends_on:
      - superset

3. 修改superset_config.py

class ReverseProxied(object):
    def __init__(self, app):
        self.app = app

    def __call__(self, environ, start_response):
        script_name = environ.get('HTTP_X_SCRIPT_NAME', '')
        if script_name:
            environ['SCRIPT_NAME'] = script_name
            path_info = environ['PATH_INFO']
            if path_info.startswith(script_name):
                environ['PATH_INFO'] = path_info[len(script_name):]

        scheme = environ.get('HTTP_X_SCHEME', '')
        if scheme:
            environ['wsgi.url_scheme'] = scheme
        return self.app(environ, start_response)

ADDITIONAL_MIDDLEWARE = [ReverseProxied, ]

这些配置经过验证可以满足你需要