diff --git a/docs/source/configuration/environmentvariables.md b/docs/source/configuration/environmentvariables.md index a63c6144f1..74758c262f 100644 --- a/docs/source/configuration/environmentvariables.md +++ b/docs/source/configuration/environmentvariables.md @@ -11,6 +11,8 @@ myst: This page describes environment variables and their usage for configuration of your Volto application at runtime. +For more detailed information about environment variables and other configurations, you can refer to the [Razzle Documentation](https://razzlejs.org/docs/environment-variables). + ## Runtime environment variables @@ -24,13 +26,39 @@ You could, for example, build your Volto application, then start it in productio yarn build && RAZZLE_API_PATH=https://plone.org yarn start:prod ``` +```{glossary} +:sorted: +`HOST` + Represents the host or IP address on which a server should listen. + Default is `0.0.0.0`. + +`PORT` + Used to specify the port on which a web server should listen for incoming requests. + Default is `3000`. + +`RAZZLE_API_PATH` + Used to configure the API path for the application. + +`RAZZLE_PUBLIC_URL` + Used to specify the base URL or path where static assets—such as images, stylesheets, and other resources—are hosted or served. + +`RAZZLE_DEV_PROXY_API_PATH` + Used during development to configure a proxy for API requests. + +`RAZZLE_INTERNAL_API_PATH` + Used to specify the path to an internal API that the server-rendered application should use. + +`RAZZLE_PROXY_REWRITE_TARGET` + Used to specify the target URL for a proxy server. +``` + This brings you a lot of power since you don't have to rebuild on every configuration change. You can also generate builds on your continuous integration, then deploy them anywhere. ## Environment variable reference -````{glossary} +```{glossary} :sorted: `RAZZLE_LEGACY_TRAVERSE` If `true`, Volto will construct API URLs without the `/++api++` prefix. @@ -184,7 +212,7 @@ You can also generate builds on your continuous integration, then deploy them an ```shell VOLTOCONFIG=../../volto.config.js yarn start ``` -```` +``` ## Access environment variables in a browser diff --git a/packages/volto/news/5319.documentation b/packages/volto/news/5319.documentation new file mode 100644 index 0000000000..bd787892c5 --- /dev/null +++ b/packages/volto/news/5319.documentation @@ -0,0 +1 @@ +Document environment variables and link the Razzle documentation. @Manas-Kenge \ No newline at end of file