Project: APISIX (Orchestration & Management / API Gateway)
File: profile.md

title: Configuration based on environments keywords: Apache APISIX API Gateway Configuration Environment description: This document describes how you can change APISIX configuration based on environments. <!-- --> Extracting configuration from the code makes APISIX adaptable to changes in the operating environments. For example, APISIX can be deployed in a development environment for testing and then moved to a production environment. The configuration for APISIX in these environments would be different. APISIX supports managing multiple configurations through environment variables in two different ways: Using environment variables in the configuration file Using an environment variable to switch between multiple configuration profiles This is useful when you want to change some configurations based on the environment. To use environment variables, you can use the syntax `keyname: ${{ENVIRONMENTVARIABLENAME:=}}`. You can also set a default value to fall back to if no environment variables are set by adding it to the configuration as `keyname: ${{ENVIRONMENTVARIABLENAME:=VALUE}}`. The example below shows how you can modify your configuration file to use environment variables to set the listening ports of APISIX: ```yaml title="config.yaml" apisix: node_listen: ${{APISIXNODELISTEN:=}} deployment: admin: admin_listen: port: ${{DEPLOYMENTADMINADMIN_LISTEN:=}} ``` When you run APISIX, you can set these environment variables dynamically: ```shell export APISIXNODELISTEN=8132 export DEPLOYMENTADMINADMIN_LISTEN=9232 ``` :::caution You should set these variables with `export`. If you do not export, APISIX will fail to resolve for these variables. ::: Now when you start APISIX, it will listen on port `8132` and expose the Admin API on port `9232`. To use default values if no environment variables are set, you can add it to your configuration file as shown below: ```yaml title="config.yaml" apisix: node_listen: ${{APISIXNODELISTEN:=9080}} deployment: admin: admin_listen: port: ${{DEPLOYMENTADMINADMIN_LISTEN:=9180}} ``` Now if you don't specify these environment variables when running APISIX, it will fall back to the default values and expose the Admin API on port `9180` and listen on port `9080`. Similarly, you can also use environment variables in `apisix.yaml` when deploying APISIX in standalone mode. For example, you can export the upstream address and port to environment variables: ```shell export HOST_ADDR=httpbin.org export HOST_PORT=80 ``` Then create a route as such: ```yaml title="apisix.yaml" routes: uri: "/anything" upstream: nodes: "${{HOSTADDR}}:${{HOSTPORT}}": 1 type: roundrobin ``` Initialize and start APISIX in standalone mode, requests to `/anything` should now be forwarded to `httpbin.org:80/anything`. WARNING: When using docker to deploy APISIX in standalone mode. New environment variables added to `apisix.yaml` while APISIX has been initialized will only take effect after a reload. If you have multiple configuration changes for multiple environments, it might be better to have a different configuration file for each. Although this might increase the number of configuration files, you would be able to manage each independently and can even do version management. APISIX uses the `APISIXPROFILE` environment variable to switch between environments, i.e. to switch between different sets of configuration files. If the value of `APISIXPROFILE` is `env`, then APISIX will look for the configuration files `conf/config-env.yaml`, `conf/apisix-env.yaml`, and `conf/debug-env.yaml`. For example for the production environment, you can have: conf/config-prod.yaml conf/apisix-prod.yaml conf/debug-prod.yaml And for the development environment: conf/config-dev.yaml conf/apisix-dev.yaml conf/debug-dev.yaml And if no environment is specified, APISIX can use the default configuration files: conf/config.yaml conf/apisix.yaml conf/debug.yaml To use a particular configuration, you can specify it in the environment variable: ```shell export APISIX_PROFILE=prod ``` APISIX will now use the `-prod.yaml` configuration files.