The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Link directly to docs about specific environment variables (#73558)
Rodrigo López Dato0a7d5b2d2fa4
diff --git a/docs/configuring-metabase/config-file.md b/docs/configuring-metabase/config-file.mdindex 40c0e15061b..ee3e1762643 100644--- a/docs/configuring-metabase/config-file.md+++ b/docs/configuring-metabase/config-file.md@@ -9,7 +9,7 @@ title: "Configuration file"On self-hosted [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans, Metabase supports initialization on launch from a config file named `config.yml`. The config file should be located at:- The current directory (the directory where the running Metabase JAR is located).-- The path specified by the `MB_CONFIG_FILE_PATH` [environment variable](./environment-variables.md).+- The path specified by the [`MB_CONFIG_FILE_PATH`](./environment-variables.md#mb_config_file_path) environment variable.The settings in the config file work the same as if you'd set the settings in the Admin Settings in your Metabase. Settings defined in this configuration file will update any existing settings. If, for example, a database already exists (that is, you'd already added it via the initial set up or **Admin settings** > **Databases**, Metabase will update the database entry based on the data in the config file). Which means: if you define a setting in the config file, and then later change that setting in your Metabase application, keep in mind that the config file will overwrite that change whenever Metabase restarts. Let's reiterate that in a blockquote:@@ -276,7 +276,7 @@ But you can set any of the Admin settings with the config file (for a list of se## Loading a new Metabase from a config file-Since loading from a config file is a Pro/Enterprise feature: for new installations, you'll need to supply Metabase with a token using the `MB_PREMIUM_EMBEDDING_TOKEN` environment variable.+Since loading from a config file is a Pro/Enterprise feature: for new installations, you'll need to supply Metabase with a token using the [`MB_PREMIUM_EMBEDDING_TOKEN`](./environment-variables.md#mb_premium_embedding_token) environment variable.```shMB_PREMIUM_EMBEDDING_TOKEN="[your token]" java --add-opens java.base/java.nio=ALL-UNNAMED -jar metabase.jardiff --git a/docs/installation-and-operation/configuring-application-database.md b/docs/installation-and-operation/configuring-application-database.mdindex a2cab78689d..f8de29b6d93 100644--- a/docs/installation-and-operation/configuring-application-database.md+++ b/docs/installation-and-operation/configuring-application-database.md@@ -45,7 +45,7 @@ export MB_DB_CONNECTION_URI="jdbc:postgresql://localhost:5432/metabase?user=<usejava --add-opens java.base/java.nio=ALL-UNNAMED -jar metabase.jar```-If you want to pass the connection URI, user, and password credentials separately from the JDBC connection string (useful if the password contains special characters), you can use the `MB_DB_CONNECTION_URI` [environment variable](../configuring-metabase/environment-variables.md) in combination with `MB_DB_USER` and `MB_DB_PASS` variables:+If you want to pass the connection URI, user, and password credentials separately from the JDBC connection string (useful if the password contains special characters), you can use the [`MB_DB_CONNECTION_URI`](../configuring-metabase/environment-variables.md#mb_db_connection_uri) environment variable in combination with [`MB_DB_USER`](../configuring-metabase/environment-variables.md#mb_db_user) and [`MB_DB_PASS`](../configuring-metabase/environment-variables.md#mb_db_pass) variables:```shexport MB_DB_CONNECTION_URI="jdbc:postgresql://localhost:5432/metabase"diff --git a/docs/installation-and-operation/running-metabase-on-azure.md b/docs/installation-and-operation/running-metabase-on-azure.mdindex 903d4ea026f..4ecdbebe075 100644--- a/docs/installation-and-operation/running-metabase-on-azure.md+++ b/docs/installation-and-operation/running-metabase-on-azure.md@@ -119,7 +119,7 @@ Now click on the huge plus sign next to **Add VNET** and select the VNET that yoReturn to the application configuration page and click on **Settings** -> **Configuration** on the left side of the page. You should see a few Application Settings already configured.-You'll need to add the [environment Variables](../configuring-metabase/environment-variables.md) for connecting Metabase to its [PostgreSQL Application Database](../installation-and-operation/configuring-application-database.md#postgresql). Make sure that you use the full **MB_DB_CONNECTION_URI**.+You'll need to add the [environment variables](../configuring-metabase/environment-variables.md) for connecting Metabase to its [PostgreSQL Application Database](../installation-and-operation/configuring-application-database.md#postgresql). Make sure that you use the full [`MB_DB_CONNECTION_URI`](../configuring-metabase/environment-variables.md#mb_db_connection_uri).Also, consider that the username in Azure PostgreSQL is `user@name_of_your_database_engine` so in this case the entire connection uri would be as follows:diff --git a/docs/installation-and-operation/running-metabase-on-docker.md b/docs/installation-and-operation/running-metabase-on-docker.mdindex f04522388d7..ea5d8a55b49 100644--- a/docs/installation-and-operation/running-metabase-on-docker.md+++ b/docs/installation-and-operation/running-metabase-on-docker.md@@ -337,13 +337,13 @@ secrets:We currently support the following [environment variables](../configuring-metabase/environment-variables.md) to be used as secrets:-- `MB_DB_USER`-- `MB_DB_PASS`-- `MB_DB_CONNECTION_URI`-- `MB_EMAIL_SMTP_PASSWORD`-- `MB_EMAIL_SMTP_USERNAME`-- `MB_LDAP_PASSWORD`-- `MB_LDAP_BIND_DN`+- [`MB_DB_USER`](../configuring-metabase/environment-variables.md#mb_db_user)+- [`MB_DB_PASS`](../configuring-metabase/environment-variables.md#mb_db_pass)+- [`MB_DB_CONNECTION_URI`](../configuring-metabase/environment-variables.md#mb_db_connection_uri)+- [`MB_EMAIL_SMTP_PASSWORD`](../configuring-metabase/environment-variables.md#mb_email_smtp_password)+- [`MB_EMAIL_SMTP_USERNAME`](../configuring-metabase/environment-variables.md#mb_email_smtp_username)+- [`MB_LDAP_PASSWORD`](../configuring-metabase/environment-variables.md#mb_ldap_password)+- [`MB_LDAP_BIND_DN`](../configuring-metabase/environment-variables.md#mb_ldap_bind_dn)In order for the Metabase container to read the files and use the contents as a secret, the environment variable name needs to be appended with a "\_FILE" as explained above.diff --git a/docs/installation-and-operation/running-the-metabase-jar-file.md b/docs/installation-and-operation/running-the-metabase-jar-file.mdindex 8e14df22d7d..62d0fe5121a 100644--- a/docs/installation-and-operation/running-the-metabase-jar-file.md+++ b/docs/installation-and-operation/running-the-metabase-jar-file.md@@ -103,7 +103,7 @@ Metabase will start using the default settings. You should see some log entriesAt this point you're ready to go! You can access your new Metabase server on port 3000, most likely at `http://localhost:3000`.-You can use another port than 3000 by setting the `MB_JETTY_PORT` [environment variable](../configuring-metabase/environment-variables.md) before running the jar.+You can use another port than 3000 by setting the `MB_JETTY_PORT` [environment variable](../configuring-metabase/environment-variables.md#mb_jetty_port) before running the jar.If you are using a Pro or Enterprise version of Metabase, be sure to [activate your license](../installation-and-operation/activating-the-enterprise-edition.md).diff --git a/docs/questions/exporting-results.md b/docs/questions/exporting-results.mdindex 6086d0e7705..749577af926 100644--- a/docs/questions/exporting-results.md+++ b/docs/questions/exporting-results.md@@ -63,7 +63,7 @@ The reason Metabase doesn't try to export results as a native Excel PivotTable iBy default, Metabase will export first 1048575 rows of results.-- For CSV exports, you can increase this limit with an environment variable: [`MB_DOWNLOAD_ROW_LIMIT`](../configuring-metabase/environment-variables.md). Increasing this limit, however, may impact your Metabase's performance.+- For CSV exports, you can increase this limit with an environment variable: [`MB_DOWNLOAD_ROW_LIMIT`](../configuring-metabase/environment-variables.md#mb_download_row_limit). Increasing this limit, however, may impact your Metabase's performance.- XLSX exports will always be limited to Excel's maximum of 1048575 rows (plus the header row).### Cell character limit in Excel exports