docs: update backend README.md with latest changes and setup instructions
This commit is contained in:
parent
1f7d3f475b
commit
7da9277d69
1 changed files with 30 additions and 7 deletions
|
|
@ -2,17 +2,40 @@
|
||||||
|
|
||||||
## Env Configuration
|
## Env Configuration
|
||||||
|
|
||||||
To set the mail configuration for the backend, you must create an `.env` file in the root directory of your project. This file should have the following content:
|
To configure your backend application, you need to create an `.env` file in the videoflix folder of your project. This file contains various environment-specific settings, including email, security, and monitoring configuration.
|
||||||
|
|
||||||
### Step 1: Creating the `.env` file
|
### Step 1: Create the `.env` file
|
||||||
|
|
||||||
Create a file named `.env` in the root directory of the project.
|
Create a file named `.env` inside the videoflix folder of your project:
|
||||||
|
|
||||||
### Step 2: Add the e-mail configuration
|
```
|
||||||
|
/your-project-root/
|
||||||
|
└── videoflix/
|
||||||
|
├── .env_example
|
||||||
|
└── .env ← create this file
|
||||||
|
```
|
||||||
|
|
||||||
Open the `.env` file and add the following lines:
|
You can also simply rename or copy the existing `.env_example` file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cp videoflix/.env_example videoflix/.env
|
||||||
|
```
|
||||||
|
|
||||||
|
Then open `videoflix/.env` and adjust the values according to your environment.
|
||||||
|
|
||||||
|
### Step 2: Add the required configuration
|
||||||
|
|
||||||
|
Open the `.env` file and include the following lines according to your needs:
|
||||||
|
|
||||||
```env
|
```env
|
||||||
EMAIL_HOST_USER=example@gmail.com
|
# General settings
|
||||||
EMAIL_HOST_PASSWORD=password
|
DEBUG=False
|
||||||
|
SECRET_KEY=your_secret_key_here
|
||||||
|
|
||||||
|
# Email settings
|
||||||
|
EMAIL_HOST_USER=your_email_user
|
||||||
|
EMAIL_HOST_PASSWORD=your_email_password
|
||||||
|
|
||||||
|
# Sentry settings
|
||||||
|
SENTRY_DSN=your_sentry_dsn
|
||||||
```
|
```
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue