1
0
Fork 0
mirror of synced 2024-06-02 19:04:49 +12:00

Update docs/tutorials/add-environment-variable.md

Co-authored-by: Christy Jacob <christyjacob4@gmail.com>
This commit is contained in:
Damodar Lohani 2021-02-08 11:00:44 +05:45 committed by GitHub
parent 2d3b6ed320
commit ab324f3c83
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -10,7 +10,7 @@ Adding new features may require various configurations options to be set by the
This tutorial will cover, how to properly add a new environment variable in Appwrite.
### Naming environment varialbe
The environment variables in Appwrite are prefixed with `_APP_`. If it belongs to a specific cateogry, the category name is appended as `_APP_REDIS` for the redis category. The available categories are General, Redis, MariaDB, InfluxDB, StatsD, SMTP, Storage and Functions. Finally the properly describing name is given to the variable as `_APP_REDIS_HOST` for redis host. You can find more information on available categories and existing environment variables at [environment variables doc](https://appwrite.io/docs/environment-variables).
The environment variables in Appwrite are prefixed with `_APP_`. If it belongs to a specific cateogry, the category name is appended as `_APP_REDIS` for the redis category. The available categories are General, Redis, MariaDB, InfluxDB, StatsD, SMTP, Storage and Functions. Finally the properly describing name is given to the variable as `_APP_REDIS_HOST` for redis host. You can find more information on available categories and existing environment variables in the [environment variables doc](https://appwrite.io/docs/environment-variables).
### Describe new environment variable
First of all, we add the new environment variable to `app/config/variables.php` in the designated category. If none of the categories fit, add it to the General category. Copy the existing variables description to create a new one, so that you will not miss any required fields.
@ -29,4 +29,4 @@ With these steps, your environment variable is properly added and can be accesse
If everything went well, commit and initiate a PR and wait for the Appwrite team's approval.
Whooho! you have successfully added new environment variable to Appwrite. 🎉
Whooho! you have successfully added new environment variable to Appwrite. 🎉