Photo Sharing. For Everyone.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
daniel 48098883c0
Merge pull request #298 from BrainBlasted/detailed_readme
general: Add detailed README.md
7 years ago
app Update compiled assets 7 years ago
bootstrap Add Laravel Framework 7 years ago
config Allow setting the locale from environment 7 years ago
contrib Replaced docker-compose.yml, run composer as root, create needed directories for application storage, revert changes to nginx.conf 7 years ago
database Add Email Verification 7 years ago
public Update logo 7 years ago
resources Update logo 7 years ago
routes Add Email Verification 7 years ago
storage Fix avatar bug 7 years ago
tests Add Laravel Framework 7 years ago
.dockerignore Also added the second docker-compose configuration file to dockerignore 7 years ago
.editorconfig Add .editorconfig 7 years ago
.env.example general: Add detailed README.md 7 years ago
.gitattributes Add .gitignore 7 years ago
.gitignore Greek translation 7 years ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 7 years ago
Dockerfile Replaced docker-compose.yml, run composer as root, create needed directories for application storage, revert changes to nginx.conf 7 years ago
LICENSE Replace to perfect license 7 years ago
README.md general: Add detailed README.md 7 years ago
artisan Add Laravel Framework 7 years ago
composer.json Add laravel-backup 7 years ago
composer.lock Add laravel-backup 7 years ago
docker-compose.yml Replaced docker-compose.yml, run composer as root, create needed directories for application storage, revert changes to nginx.conf 7 years ago
package-lock.json Update package.json 7 years ago
package.json Update package.json 7 years ago
phpunit.xml Add Laravel Framework 7 years ago
server.php Add Laravel Framework 7 years ago
webpack.mix.js Add pagination to notifications 7 years ago
yarn.lock Add Laravel Framework 7 years ago

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, 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/dansup/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
php artisan serve --host=localhost --port=80

Check your browser at http://localhost

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