Federated Image Sharing (WIP)
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3c5cf78 Nov 19, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Update AccountController Nov 19, 2018
app Update ProfileController Nov 20, 2018
bootstrap Add Laravel Framework Apr 15, 2018
config Bump version Nov 20, 2018
contrib Run pixelfed update tasks upon startup Oct 18, 2018
database Update user factory seeder Nov 4, 2018
public Update compiled assets Nov 20, 2018
resources Update nav Nov 20, 2018
routes Update routes Nov 20, 2018
storage Update framework, 5.6 => 5.7 Oct 23, 2018
tests Add HTTPSignature tests Nov 19, 2018
.dockerignore Fix the docker build Aug 23, 2018
.editorconfig Add .editorconfig Jun 7, 2018
.env.example and remove extra empty line, no need to cause a change in the repo Aug 13, 2018
.gitattributes Add .gitignore Apr 15, 2018
.gitignore Remove composer.lock Oct 24, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md May 17, 2018
Dockerfile Move Dockerfiles to contrib/ Aug 23, 2018
LICENSE Replace to perfect license Jun 5, 2018
README.md Change to pixelfed/pixelfed repo URL Oct 16, 2018
artisan Add Laravel Framework Apr 15, 2018
composer.json Update composer.json, add proper license Nov 9, 2018
docker-compose.yml Merge branch 'dev' of https://github.com/dansup/pixelfed into dev Aug 13, 2018
package-lock.json Add readmore.js Nov 13, 2018
package.json Add readmore.js Nov 13, 2018
phpunit.xml Add Laravel Framework Apr 15, 2018
server.php Apply fixes from StyleCI Aug 28, 2018
webpack.mix.js Update webpack Nov 9, 2018
yarn.lock Add Laravel Framework Apr 15, 2018


PixelFed: Federated Image Sharing

PixelFed is a federated social image sharing platform, similar to Instagram. Federation is done using the ActivityPub protocol, which is used by Mastodon, PeerTube, Pleroma, and more. Through ActivityPub PixelFed can share and interact with these platforms, as well as other instances of PixelFed.

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

PixelFed is very early into the development stage. If you would like to have a permanent instance with minimal breakage, do not use this software until there is a stable release. The following setup instructions are intended for testing and development.


  • PHP >= 7.1.3 (7.2+ recommended for stable version)
  • MySQL >= 5.7, Postgres (MariaDB and sqlite are not supported yet)
  • 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
  • SVGO
  • Gifsicle


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

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


The ways you can communicate on the project are below. Before interacting, please read through the Code Of Conduct.


The lead maintainer is on Patreon! You can become a Patron at https://www.patreon.com/dansup