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?