Doc add environment variable by lohanidamodar · Pull Request #867 · appwrite/appwrite

lohanidamodar · 2021-02-01T06:58:35Z

What does this PR do?

New doc for adding Environment variables

Test Plan

N/A

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

YES

eldadfux · 2021-02-01T09:33:41Z

+This tutorial will cover, how to properly add new environment variable in Appwrite.
+
+### Naming environment varialbe
+The environment variables in Appwrite is prefixed with `_APP_`. Then if it belongs to specific cateogry, the category name is appended as `_APP_REDIS` for redis category. Finally the properly describing name is given to the variable as `_APP_REDIS_HOST` for redis host.


Mention list of categories is available at https://appwrite.io/docs/environment-variables

eldadfux · 2021-02-01T09:35:42Z

+First of all we add the new environment variable to `app/config/variables.php` under specific category. If none of the categories fit, add it in general category. Copy the existing variables description to create new one so that you will not miss any required fields.
+
+### Add to .env and Dockerfile
+If newly introduced environment variable has a default value, add it to the `.env` and `Dockerfile` along with other environment variables.


Add a note that we use the .env file as setting for the Appwrite development environment.

Still pending

eldadfux · 2021-02-01T09:37:28Z

+
+If everything goes well, commit and initiate a PR and wait for the Appwrite team's approval.
+
+Whooho! you have successfully added new environment variable to Appwrite.


This requires a celebration emoji!! 😉

The more emojis the better hehe

Hehe I mean inside the tutorial, make it happier add emojis 😃

TorstenDittmann · 2021-02-01T12:16:03Z

+### Agenda
+Adding new features may require various configurations options to be set by the users. And for such options we use environment variables in Appwrite.
+
+This tutorial will cover, how to properly add new environment variable in Appwrite.


a new environment *

TorstenDittmann · 2021-02-01T12:18:32Z

+This tutorial will cover, how to properly add new environment variable in Appwrite.
+
+### Naming environment varialbe
+The environment variables in Appwrite is prefixed with `_APP_`. Then if it belongs to specific cateogry, the category name is appended as `_APP_REDIS` for 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).


in Appwrite are *

Then if it belongs <- remove the Then

to a specific cateogry *

for the Redis category *

TorstenDittmann · 2021-02-01T12:21:54Z

+The environment variables in Appwrite is prefixed with `_APP_`. Then if it belongs to specific cateogry, the category name is appended as `_APP_REDIS` for 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).
+
+### Describe new environment variable
+First of all we add the new environment variable to `app/config/variables.php` under specific category. If none of the categories fit, add it in general category. Copy the existing variables description to create new one so that you will not miss any required fields.


First of all, we *

in the designated category. *

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. *

TorstenDittmann · 2021-02-01T12:24:10Z

+
+The `docker-compose.yml` file is used by the Appwrite maintainers during development where as `app/views/install/compose.phtml` file is used by the Appwrite setup script.
+
+With these steps, your environment variable is properly added and can be accessed inside Appwrite code or any other containers where it is passed. You can access and use those variables to implement the features you are trying to implement.


accessed inside Appwrite code and any other containers *

You can access and use those variables to implement the features you are trying to achieve. *

TorstenDittmann · 2021-02-01T12:24:30Z

+
+With these steps, your environment variable is properly added and can be accessed inside Appwrite code or any other containers where it is passed. You can access and use those variables to implement the features you are trying to implement.
+
+If everything goes well, commit and initiate a PR and wait for the Appwrite team's approval.


If everything went well *

lohanidamodar · 2021-02-05T07:48:06Z

@eldadfux I believe this is ready too!

Co-authored-by: Christy Jacob <[email protected]>

christyjacob4

LGTM 😄

lohanidamodar added 2 commits February 1, 2021 11:59

WIP

a95fd75

adding environment variable first draft

10bab0d

lohanidamodar requested review from Glide7, TorstenDittmann, christyjacob4 and eldadfux February 1, 2021 06:58

lohanidamodar mentioned this pull request Feb 1, 2021

Doc add storage adapter #864

Merged

eldadfux changed the base branch from master to 0.7.x February 1, 2021 09:32

eldadfux requested changes Feb 1, 2021

View reviewed changes

updated docs as suggested in review

dccd44a

lohanidamodar requested a review from eldadfux February 1, 2021 10:51

TorstenDittmann requested changes Feb 1, 2021

View reviewed changes

grammar updates

2d3b6ed

lohanidamodar requested a review from TorstenDittmann February 2, 2021 05:29

TorstenDittmann approved these changes Feb 3, 2021

View reviewed changes

christyjacob4 reviewed Feb 6, 2021

View reviewed changes

Comment thread docs/tutorials/add-environment-variable.md Outdated

christyjacob4 reviewed Feb 6, 2021

View reviewed changes

Comment thread docs/tutorials/add-environment-variable.md Outdated

Glide7 approved these changes Feb 7, 2021

View reviewed changes

lohanidamodar and others added 3 commits February 8, 2021 11:00

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

ab324f3

Co-authored-by: Christy Jacob <[email protected]>

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

8b57b23

Co-authored-by: Christy Jacob <[email protected]>

updated from suggestion

8e22568

lohanidamodar requested a review from christyjacob4 February 8, 2021 05:19

christyjacob4 approved these changes Feb 8, 2021

View reviewed changes

eldadfux merged commit 60af368 into appwrite:0.7.x Feb 9, 2021


		If everything goes well, commit and initiate a PR and wait for the Appwrite team's approval.

		Whooho! you have successfully added new environment variable to Appwrite. No newline at end of file


		The `docker-compose.yml` file is used by the Appwrite maintainers during development where as `app/views/install/compose.phtml` file is used by the Appwrite setup script.

		With these steps, your environment variable is properly added and can be accessed inside Appwrite code or any other containers where it is passed. You can access and use those variables to implement the features you are trying to implement.

Conversation

lohanidamodar commented Feb 1, 2021

What does this PR do?

Test Plan

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

lohanidamodar commented Feb 5, 2021

Uh oh!

Uh oh!

Uh oh!

christyjacob4 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants