¿Ya sabes para que sirve el archivo .env.example en Laravel?

Si llevas poco tiempo programando y no estás muy familiarizado con los archivos dotenv seguramente no sabrás para qué sirve el archivo .env.example que Laravel nos ofrece en la raíz de nuestro proyecto al momento de crearlo.

Algo que debemos saber es que el archivo que contiene las variables de entorno en Laravel es el archivo .env ubicado en la raíz de nuestro proyecto, de base algo así.

APP_NAME=Laravel
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost

LOG_CHANNEL=stack
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=blog
DB_USERNAME=root
DB_PASSWORD=

BROADCAST_DRIVER=log
CACHE_DRIVER=file
FILESYSTEM_DISK=local
QUEUE_CONNECTION=sync
SESSION_DRIVER=file
SESSION_LIFETIME=120

MEMCACHED_HOST=127.0.0.1

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_MAILER=smtp
MAIL_HOST=mailhog
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null
MAIL_FROM_ADDRESS=null
MAIL_FROM_NAME="${APP_NAME}"

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false

PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
PUSHER_APP_CLUSTER=mt1

MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"

El archivo .env nunca debe publicarse en nuestro repositorio ya que contiene variables para nuestro entorno y deben modificarse en cada entorno, desarrollo, staging, producción etcétera.

Ahora pregúntate, ¿cómo podría saber otra persona que se incorpora a trabajar en tu proyecto qué variables de entorno debe definir en su archivo .env si al clonar el repositorio este archivo no existe? Voila! Para eso está el archivo .env.example.

Para trabajar de forma correcta en proyectos que contienen en este caso archivos .env lo que debemos hacer es conforme vayamos añadiendo nuevas variables en el archivo .env con los valores para nuestro entorno, hacer lo mismo en el .env.example pero con valores vacíos. De esta forma, si alguien clona tu proyecto algún día sabrá qué variables de entorno debe definir para que todo funcione correctamente.

Si deseas conocer más temas relacionados con el tratado en este post no te pierdas este curso.