Skip to content

Commit 13e89f6

Browse files
committed
Updated API_ADMINISTRATOR_USER_EMAIL_ADDRESS documentation
1 parent db13485 commit 13e89f6

File tree

1 file changed

+26
-8
lines changed

1 file changed

+26
-8
lines changed

docs/docs/docs/developer-resources/operation.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,35 @@ slug: /developer-resources/operation
55
sidebar_position: 3
66
---
77

8-
## Operation
9-
108
This section covers how Talawa API operates
119

12-
### Key Concepts
10+
## Key Concepts
1311

1412
Before you begin, here are some important summaries of the technologies used.
1513

16-
#### Docker Development Containers (devcontainers)
14+
### API Administrators
15+
16+
The role of API Administrators is defined in the [Talawa Core Concepts page](https://docs.talawa.io/docs/introduction/core-concepts).
17+
18+
This section explains how they are managed in the database.
19+
20+
1. When the API starts, it checks fo the existence of an account with the email address that matches the `API_ADMINISTRATOR_USER_EMAIL_ADDRESS` parameter in the API's `.env` file
21+
1. If an account with this email address does not exist:
22+
1. An account is automatically created using the configured `API_ADMINISTRATOR_USER_EMAIL_ADDRESS` as the username and `API_ADMINISTRATOR_USER_PASSWORD` as the password
23+
1. The account with the matching `API_ADMINISTRATOR_USER_EMAIL_ADDRESS` becomes the API Administrtor
24+
1. The account automatically has `adminstrator` rights.
25+
1. If an account with this email address exists:
26+
1. The account with the matching `API_ADMINISTRATOR_USER_EMAIL_ADDRESS` becomes the API Administrtor
27+
1. The account automatically has `adminstrator` rights.
28+
29+
Therefore. Make sure to configure the API's `.env` file with these parameters.
30+
31+
```
32+
API_ADMINISTRATOR_USER_EMAIL_ADDRESS
33+
API_ADMINISTRATOR_USER_PASSWORD
34+
```
35+
36+
### Docker Development Containers (devcontainers)
1737

1838
Talawa API uses devcontainers for many features
1939

@@ -30,7 +50,7 @@ Regular Docker's core features are contrary to using it as a developer environme
3050

3151
Visit [this link](https://stackoverflow.com/questions/75652065/whats-the-difference-between-docker-compose-and-dev-containers) for further information on the differences between Containers and Dev Containers.
3252

33-
##### Talawa API Dev Containers
53+
#### Talawa API Dev Containers
3454

3555
In Talawa API, the API devcontainer operates like a lightweight virtual machine which has network access available to the external containers services including:
3656

@@ -53,6 +73,4 @@ The API runs by default when the devcontainer starts, but only after the these c
5373
3. Preexisting `.env` files are not automatically updated with remote changes, you have to do that yourself.
5474
2. Healthchecks are skipped in the devcontainer, because if the healthcheck for it was running then the api devcontainer would never start.
5575

56-
### Startup Sequence
57-
58-
## Troubleshooting
76+
## Startup Sequence

0 commit comments

Comments
 (0)