All configuration files are located in the config/ folder of your Pixelfed installation. These are the environment variables you can set in your .env file; note that some variables are currently unused and do nothing.

Summary of important variables

For a user-facing guide to which environment variables you might want to set, check out the installation guide instead.

app [link]

APP_NAME [link]

Pixelfed

APP_ENV [link]

production

APP_DEBUG [link]

false

APP_URL [link]

https://localhost

APP_TIMEZONE [link]

UTC

APP_LOCALE [link]

en

APP_FALLBACK_LOCALE [link]

en

APP_KEY [link]

A random 32-character string to be used as an encryption key. No default value; use php artisan key:generate to generate.

broadcasting [link]

BROADCAST_DRIVER [link]

Possible values:

  • pusher
  • redis
  • log
  • null (default)

PUSHER_APP_KEY [link]

PUSHER_APP_SECRET [link]

PUSHER_APP_ID [link]

PUSHER_APP_CLUSTER [link]

cache [link]

CACHE_DRIVER [link]

Defaults to file.

CACHE_PREFIX [link]

Defaults to APP_NAME_cache, or laravel_cache if no APP_NAME is set.

MEMCACHED_PERSISTENT_ID [link]

MEMCACHED_USERNAME [link]

MEMCACHED_PASSWORD [link]

MEMCACHED_HOST [link]

127.0.0.1

MEMCACHED_PORT [link]

11211

REDIS_CLIENT [link]

predis

REDIS_SCHEME [link]

tcp

REDIS_PATH [link]

No default value.

REDIS_HOST [link]

localhost

REDIS_PASSWORD [link]

null

REDIS_PORT [link]

6379

REDIS_DATABASE [link]

0

costar [link]

CS_BLOCKED_DOMAINS [link]

Comma-separated list of domains to block. Defaults to null.

CS_CW_DOMAINS [link]

Comma-separated list of domains to add warnings. Defaults to null.

CS_UNLISTED_DOMAINS [link]

Comma-separated list of domains to remove from public timelines. Defaults to null.

CS_BLOCKED_KEYWORDS [link]

Comma-separated list of keywords to block. Defaults to null.

CS_CW_KEYWORDS [link]

Comma-separated list of keywords to add warnings. Defaults to null.

CS_UNLISTED_KEYWORDS [link]

Comma-separated list of keywords to remove from public timelines. Defaults to null.

CS_BLOCKED_ACTOR [link]

CS_CW_ACTOR [link]

CS_UNLISTED_ACTOR [link]

database [link]

DB_CONNECTION [link]

Sets the database driver. Defaults to mysql.

DB_DATABASE [link]

When using sqlite for DB_CONNECTION. Defaults to database.sqlite

DB_HOST [link]

Defaults to 127.0.0.1 when using mysql or pgsql for DB_CONNECTION, or localhost when using sqlsrv.

DB_PORT [link]

Defaults to 3306 for mysql, 5432 for pgsql, or 1433 for sqlsrv.

DB_DATABASE [link]

Defaults to forge

DB_USERNAME [link]

Defaults to forge

DB_PASSWORD [link]

Defaults to an empty string.

DB_SOCKET [link]

Defaults to an empty string.

REDIS_CLIENT [link]

predis

REDIS_SCHEME [link]

tcp

REDIS_PATH [link]

No default value.

REDIS_HOST [link]

127.0.0.1

REDIS_PASSWORD [link]

null

REDIS_PORT [link]

6379

REDIS_DATABASE [link]

0

exp [link]

EXP_LC [link]

false

EXP_REC [link]

false

EXP_LOOPS [link]

false

federation [link]

ACTIVITY_PUB [link]

false

AP_OUTBOX [link]

true

AP_INBOX [link]

true

AP_SHARED_INBOX [link]

false

AP_REMOTE_FOLLOW [link]

false

ACTIVITYPUB_DELIVERY_TIMEOUT [link]

2.0

ACTIVITYPUB_DELIVERY_CONCURRENCY [link]

10

AP_LOGGER_ENABLED [link]

false

ATOM_FEEDS [link]

true

NODEINFO [link]

true

WEBFINGER [link]

true

filesystem [link]

FILESYSTEM_DRIVER [link]

local

FILESYSTEM_CLOUD [link]

s3

AWS_ACCESS_KEY_ID [link]

AWS_SECRET_ACCESS_KEY [link]

AWS_DEFAULT_REGION [link]

AWS_BUCKET [link]

AWS_URL [link]

AWS_ENDPOINT [link]

AWS_USE_PATH_STYLE_ENDPOINT [link]

false

DO_SPACES_KEY [link]

DO_SPACES_SECRET [link]

DO_SPACES_ENDPOINT [link]

DO_SPACES_REGION [link]

DO_SPACES_BUCKET [link]

DO_SPACES_ROOT [link]

/

hashids [link]

APP_HASHID_SALT [link]

v3MsJ1Hgnlma8YPrD3f4sW6vAn6zLnkuh6vOpKnR5IKkLqDGIk7TCADS2igpEN4ADrtXkkzV2E8HBfzpz7BreDzQqVOYDMeb4cJ1xhDhDwDeicZVUPyrxihHDaMWpTsP

hashing [link]

Possible drivers are bcrypt and argon, but this requires manual editing of driver (which is hardcoded as bcrypt).

BCRYPT_COST [link]

How many rounds of hashing to use. Defaults to 10.

ARGON_MEM [link]

1024

ARGON_THREADS [link]

2

ARGON_TIME [link]

2

horizon [link]

HORIZON_PREFIX [link]

Defaults to horizon-xxxxxxxx:, where xxxxxxxx is a random 8-character string.

HORIZON_DARKMODE [link]

false

image [link]

IMAGE_DRIVER [link]

Pixelfed supports GD or ImageMagick to process images. Defaults to gd. Set IMAGE_DRIVER='imagick' to use ImageMagick instead.

instance [link]

INSTANCE_DESCRIPTION [link]

null

INSTANCE_CONTACT_FORM [link]

false

INSTANCE_CONTACT_MAX_PER_DAY [link]

1

EXP_LOOPS [link]

false

INSTANCE_PUBLIC_HASHTAGS [link]

false

INSTANCE_CONTACT_EMAIL [link]

No default value.

INSTANCE_PUBLIC_LOCAL_TIMELINE [link]

false

PAGE_404_HEADER [link]

'Sorry, this page isn\'t available.'

PAGE_404_BODY [link]

PAGE_503_HEADER [link]

PAGE_503_BODY [link]

BANNED_USERNAMES [link]

USERNAME_REMOTE_FORMAT [link]

USERNAME_REMOTE_CUSTOM_TEXT [link]

STORIES_ENABLED [link]

false

RESTRICTED_INSTANCE [link]

false. Level is hardcoded to 1.

OAUTH_PAT_ENABLED [link]

false

OAUTH_PAT_ID [link]

No default value.

logging [link]

LOG_CHANNEL [link]

Possible values:

  • single
  • daily
  • slack
  • syslog
  • errorlog
  • monolog
  • custom
  • stack (default)

LOG_SLACK_WEBHOOK_URL [link]

No default value.

mail [link]

MAIL_DRIVER [link]

Possible values:

  • smtp (default)
  • sendmail
  • mailgun
  • mandrill
  • ses
  • sparkpost
  • log
  • array

MAIL_HOST [link]

smtp.mailgun.org

MAIL_PORT [link]

587

MAIL_FROM_ADDRESS [link]

hello@example.com

MAIL_FROM_NAME [link]

Example

MAIL_ENCRYPTION [link]

tls

MAIL_USERNAME [link]

No default value.

MAIL_PASSWORD [link]

No default value.

media [link]

MEDIA_EXIF_DATABASE [link]

false

passport [link]

By default, encryption keys are stored as local files, but can be set as environment variables if that is more convenient.

PASSPORT_PRIVATE_KEY [link]

PASSPORT_PUBLIC_KEY [link]

pixelfed [link]

ADMIN_DOMAIN [link]

APP_DOMAIN [link]

MEMORY_LIMIT [link]

1024M

OPEN_REGISTRATION [link]

true

MAX_ACCOUNT_SIZE [link]

Per-user file-size limit in KB. Defaults to 1000000 (1GB).

MAX_PHOTO_SIZE [link]

Per-file file-size limit in KB. Defaults to 15000 (15MB).

MAX_AVATAR_SIZE [link]

2000 (2MB)

MAX_CAPTION_LENGTH [link]

500

MAX_BIO_LENGTH [link]

125

MAX_NAME_LENGTH [link]

30

MAX_ALBUM_LENGTH [link]

4

ENFORCE_EMAIL_VERIFICATION [link]

true

IMAGE_QUALITY [link]

0-100 value for optimization level. Defaults to 80.

ACCOUNT_DELETION [link]

true

ACCOUNT_DELETE_AFTER [link]

Queue account deletion for X days. Defaults to false, i.e., immediately.

PF_ENABLE_CLOUD [link]

false

PF_MAX_USERS [link]

false

PF_OPTIMIZE_IMAGES [link]

true

PF_OPTIMIZE_VIDEOS [link]

true

PF_USER_INVITES [link]

false

PF_USER_INVITES_TOTAL_LIMIT [link]

0

PF_USER_INVITES_DAILY_LIMIT [link]

0

PF_USER_INVITES_MONTHLY_LIMIT [link]

0

MEDIA_TYPES [link]

'image/jpeg,image/png,image/gif'

LIMIT_ACCOUNT_SIZE [link]

true

IMPORT_INSTAGRAM [link]

false

IMPORT_INSTAGRAM_POST_LIMIT [link]

100

IMPORT_INSTAGRAM_SIZE_LIMIT [link]

5000

OAUTH_ENABLED [link]

false

ADMIN_ENV_EDITOR [link]

`false

purify [link]

RESTRICT_HTML_TYPES [link]

true

queue [link]

QUEUE_DRIVER [link]

  • sync (default)
  • database
  • beanstalkd
  • sqs
  • redis
  • null

SQS_KEY [link]

your-public-key

SQS_SECRET [link]

your-secret-key

SQS_PREFIX [link]

https://sqs.us-east-1.amazonaws.com/your-account-id

SQS_QUEUE [link]

your-queue-name

SQS_REGION [link]

us-east-1

DB_CONNECTION [link]

mysql

services [link]

MAILGUN_DOMAIN [link]

MAILGUN_SECRET [link]

SES_KEY [link]

SES_SECRET [link]

SES_REGION [link]

us-east-1

SPARKPOST_SECRET [link]

STRIPE_KEY [link]

STRIPE_SECRET [link]

session [link]

SESSION_DRIVER [link]

  • file
  • cookie
  • database (default)
  • apc
  • memcached
  • redis
  • array

SESSION_LIFETIME [link]

86400

SESSION_DOMAIN [link]

Defaults to the value of APP_DOMAIN, or null.

trustedproxy [link]

TRUST_PROXIES [link]

Defaults to empty string.

websockets [link]

PUSHER_APP_ID [link]

APP_NAME [link]

PUSHER_APP_KEY [link]

PUSHER_APP_SECRET [link]

WSS_CM [link]

WSS_STATS [link]

WSS_LOCAL_CERT [link]

WSS_LOCAL_PK [link]

WSS_PASSPHRASE [link]

WSS_VERIFY_PEER [link]