PixelFed Alpha Installation

.env

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

ADMIN_DOMAIN="localhost"
APP_DOMAIN="localhost"

LOG_CHANNEL=stack

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

BROADCAST_DRIVER=log
CACHE_DRIVER=redis
SESSION_DRIVER=redis
SESSION_LIFETIME=120
QUEUE_DRIVER=redis

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_DRIVER=log
MAIL_HOST=smtp.mailtrap.io
MAIL_PORT=2525
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null

SESSION_DOMAIN=localhost
SESSION_SECURE_COOKIE=true
API_BASE="/api/1/"
API_SEARCH="/api/search"

OPEN_REGISTRATION=true

MIX_PUSHER_APP_KEY="${PUSHER_APP_KEY}"
MIX_PUSHER_APP_CLUSTER="${PUSHER_APP_CLUSTER}"
MIX_APP_URL="${APP_URL}"
MIX_API_BASE="${API_BASE}"
MIX_API_SEARCH="${API_SEARCH}"

Installation.md

PixelFed Installation (Alpha)

Please note this is alpha software, not recommended for production use, federation is not supported yet

Requirements

• PHP >= 7.3
• MySQL, Postgres
• Redis
• Composer
• GD or ImageMagick
• OpenSSL PHP Extension
• PDO PHP Extension
• Mbstring PHP Extension
• Tokenizer PHP Extension
• XML PHP Extension
• Ctype PHP Extension
• JSON PHP Extension
• JpegOptim
• Optipng
• Pngquant 2

Installation

This guide assumes you have NGINX/Apache installed, along with the dependencies. Those will not be covered in these early docs.

Please see the attached example .env file with updated values I have not yet pushed to the repo.

git clone https://github.com/pixelfed/pixelfed.git

cd pixelfed

composer install

cp .env.example .env

Edit .env file with proper values

php artisan key:generate

php artisan storage:link

php artisan migrate

php artisan horizon

Why do you say that MariaDB doesn't work?
It's an MySQL fork which is fully compatible to it.
I haven't tested it but I'm sure that it works fine.

@nipos It lacks the "json" field type, the DB migration crashes because of it, see pixelfed/pixelfed#132

@dansup The php artisan horizon command seem to need to be run in the background, is it required for a single-user node?

@MrPetovan: Redis is required for all setups

s/PixelFed Test/"PixelFed Test"/