Skip to content

Configuration

Reference for environment variables.

Basic

ParameterExample / DefaultRequiredDescription
APP_URLhttps://mysite.com/The URL the application will be hosted from, including the scheme.
APP_NAME"My Pilcrow Site"The name of your application instance.
APP_KEYbase64:xdfsd9f...A 32 char string used to encrypt data in the application.
APP_ENV"prod"The environment the application is running under.
APP_DEBUGfalseEnable debug logging / output

Database required

The application requires a Mysql database connection to store data. The following values are used to configure the application's connection to the database.

env
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=my_db
DB_USERNAME=my_db_username
DB_PASSWORD=my_db_super_secret_password

Outgoing Mail required

The application has to be able to send transactional email (notifications, password resets, confirmations, etc). Mail from address and mail from name must be configured, no matter which email provider you are using.

env
MAIL_FROM_NAME="Hello from Pilcrow"
MAIL_FROM_ADDRESS="myemail@example.com"

The actual connection to send email can be an SMTP connection (which a number of transactional email providers make available).

env
MAIL_HOST=smtp.example.com
MAIL_PORT=1025
MAIL_USERNAME=my_username@example.com
MAIL_PASSWORD=my_super_secret_password
MAIL_ENCRYPTION=true

Laravel also supports a number of mail services. While we aren't able to provide support for each mailer service, feel free to open a ticket if you find a problem with non-smtp options.

Redis

Redis can improve application performance by functioning as an in-memory key-value store for cached data. To configure a redis connection:

env
CACHE_DRVIER=redis #change this from the default "file" cache
REDIS_HOST=redis.example.com
REDIS_PASSWORD=my secret password
REDIS_PORT=6379