Go to file
Daniel Supernault fbb6d860a4
Update layout files, replace or with ?? in blade views
2018-10-23 12:15:10 -06:00
.circleci
app Update FederationController 2018-10-22 18:05:05 -06:00
bootstrap
config Update pixelfed config 2018-10-20 23:16:11 -06:00
contrib Run pixelfed update tasks upon startup 2018-10-18 08:26:32 +02:00
database Add new migration 2018-10-20 21:45:00 -06:00
public Update compiled assets 2018-10-21 19:50:40 -06:00
resources Update layout files, replace or with ?? in blade views 2018-10-23 12:15:10 -06:00
routes Updaet web routes 2018-10-22 19:53:24 -06:00
storage Add .gitignore to html purify storage cache 2018-10-17 12:16:34 -06:00
tests
.dockerignore
.editorconfig
.env.example
.gitattributes
.gitignore
CODE_OF_CONDUCT.md
Dockerfile
LICENSE
README.md Change to pixelfed/pixelfed repo URL 2018-10-16 09:28:03 +03:00
artisan Add Laravel Framework 2018-04-15 17:56:48 -06:00
composer.json
composer.lock
docker-compose.yml
package-lock.json Update package.json 2018-10-21 00:05:52 -06:00
package.json Update package.json 2018-10-21 00:05:52 -06:00
phpunit.xml
server.php
webpack.mix.js
yarn.lock

README.md

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.

Requirements

  • 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

Installation

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

Communication

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

Support

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