pixelfed

mirror of https://github.com/pixelfed/pixelfed.git synced 2024-12-24 16:53:17 +00:00

No description

Find a file

Daniel Supernault 2871427815 Update admin views		2019-01-31 14:24:57 -07:00
.circleci	Fix CI	2018-11-28 20:06:19 -07:00
app	Update RestrictedNames	2019-01-31 14:00:39 -07:00
bootstrap	Add Laravel Framework	2018-04-15 17:56:48 -06:00
config	Update HTML Purifier config	2019-01-31 14:01:32 -07:00
contrib	Configure and enable mod_remoteip, and handle X-Forwarded-Proto header.	2019-01-08 15:40:49 +00:00
database	Add page migration	2019-01-31 12:57:02 -07:00
public	Merge pull request #748 from Simounet/feature/web-app-manifest	2019-01-23 19:28:35 -07:00
resources	Update admin views	2019-01-31 14:24:57 -07:00
routes	Update routes	2019-01-06 20:29:46 -07:00
storage	Update framework, 5.6 => 5.7	2018-10-23 13:02:29 -06:00
tests	Fix tests	2019-01-30 18:39:51 -07:00
.dockerignore	Fix the docker build	2018-08-23 22:57:22 +02:00
.editorconfig	Add .editorconfig	2018-06-07 14:52:17 +09:00
.env.example	more useful settings in .env.example file	2019-01-02 18:41:12 +00:00
.env.testing	Fix tests	2019-01-30 18:39:51 -07:00
.gitattributes
.gitignore	Remove composer.lock	2018-10-23 20:18:26 -06:00
artisan	Add Laravel Framework	2018-04-15 17:56:48 -06:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md	2018-05-17 16:28:08 -06:00
composer.json	Update composer.json	2019-01-07 10:32:13 +01:00
docker-compose.yml	Drop privileges when starting artisan or horizon	2018-11-11 18:04:23 +01:00
Dockerfile	Move Dockerfiles to contrib/	2018-08-23 22:43:47 +02:00
LICENSE	Replace to perfect license	2018-06-05 13:33:38 +09:00
package-lock.json	Update laravel mix	2018-12-30 21:32:41 -07:00
package.json	Update laravel mix	2018-12-30 21:32:41 -07:00
phpunit.xml	Add Laravel Framework	2018-04-15 17:56:48 -06:00
README.md	Update README.md	2019-01-10 17:57:15 -07:00
server.php	Apply fixes from StyleCI	2018-08-28 03:07:36 +00:00
webpack.mix.js	Update webpack	2018-11-08 23:32:27 -07:00

README.md

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.3 (7.2.x recommended for stable version)
MySQL >= 5.7 (Postgres, MariaDB and sqlite are not supported)
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
BCMath 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.

IRC: #pixelfed on irc.freenode.net (#freenode_#pixelfed:matrix.org through Matrix
Project on Mastodon: @pixelfed@mastodon.social
E-mail: hello@pixelfed.org

Support

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

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]