mirror of
https://github.com/pixelfed/pixelfed.git
synced 2024-11-26 08:13:16 +00:00
Update readme
This commit is contained in:
Daniel Supernault
parent
37215d11ed
commit
f4a6ccda90
1 changed files with 31 additions and 72 deletions
103
README.md
103
README.md
|
|
@ -1,66 +1,27 @@
|
||||||
# PixelFed: Federated Image Sharing
|
<p align="center"><img src="https://pixelfed.nyc3.cdn.digitaloceanspaces.com/logos/pixelfed-full-color.svg" width="300px"></p>
|
||||||
[](#backers)
|
|
||||||
[](#sponsors)
|
|
||||||
|
|
||||||
PixelFed is a federated social image sharing platform, similar to Instagram.
|
<p align="center">
|
||||||
Federation is done using the [ActivityPub](https://activitypub.rocks/) protocol,
|
<a href="https://circleci.com/gh/pixelfed/pixelfed"><img src="https://circleci.com/gh/pixelfed/pixelfed.svg?style=svg" alt="Build Status"></a>
|
||||||
which is used by [Mastodon](http://joinmastodon.org/), [PeerTube](https://joinpeertube.org/en/),
|
<a href="https://packagist.org/packages/pixelfed/pixelfed"><img src="https://poser.pugx.org/pixelfed/pixelfed/d/total.svg" alt="Total Downloads"></a>
|
||||||
[Pleroma](https://pleroma.social/), and more. Through ActivityPub PixelFed can share
|
<a href="https://packagist.org/packages/pixelfed/pixelfed"><img src="https://poser.pugx.org/pixelfed/pixelfed/v/stable.svg" alt="Latest Stable Version"></a>
|
||||||
and interact with these platforms, as well as other instances of PixelFed.
|
<a href="https://packagist.org/packages/pixelfed/pixelfed"><img src="https://poser.pugx.org/pixelfed/pixelfed/license.svg" alt="License"></a>
|
||||||
|
</p>
|
||||||
|
|
||||||
**_Please note this is alpha software, not recommended for production use,
|
## Introduction
|
||||||
and federation is not supported yet._**
|
|
||||||
|
|
||||||
PixelFed is very early into the development stage. If you would like to have a
|
A free and ethical photo sharing platform, powered by ActivityPub federation.
|
||||||
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
|
<p align="center">
|
||||||
- PHP >= 7.1.3 < 7.3 (7.2.x recommended for stable version)
|
<img src="https://pixelfed.nyc3.cdn.digitaloceanspaces.com/media/Screen%20Shot%202019-02-05%20at%206.34.59%20PM.png">
|
||||||
- MySQL >= 5.7 (Postgres, MariaDB and sqlite are not supported)
|
</p>
|
||||||
- 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
|
## Official Documentation
|
||||||
|
|
||||||
This guide assumes you have NGINX/Apache installed, along with the dependencies.
|
Documentation for Pixelfed can be found on the [Pixelfed documentation website](https://pixelfed.github.io/docs/master/).
|
||||||
Those will not be covered in these early docs.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
git clone https://github.com/pixelfed/pixelfed.git
|
|
||||||
cd pixelfed
|
|
||||||
composer install
|
|
||||||
cp .env.example .env
|
|
||||||
```
|
|
||||||
|
|
||||||
**Edit .env file with proper values**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan key:generate
|
|
||||||
```
|
|
||||||
|
|
||||||
```bash
|
|
||||||
php artisan storage:link
|
|
||||||
php artisan migrate
|
|
||||||
php artisan horizon
|
|
||||||
```
|
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Pixelfed is open-sourced software licensed under the AGPL license.
|
||||||
|
|
||||||
## Communication
|
## Communication
|
||||||
|
|
||||||
|
|
@ -68,7 +29,7 @@ The ways you can communicate on the project are below. Before interacting, pleas
|
||||||
read through the [Code Of Conduct](CODE_OF_CONDUCT.md).
|
read through the [Code Of Conduct](CODE_OF_CONDUCT.md).
|
||||||
|
|
||||||
* IRC: #pixelfed on irc.freenode.net ([#freenode_#pixelfed:matrix.org through
|
* IRC: #pixelfed on irc.freenode.net ([#freenode_#pixelfed:matrix.org through
|
||||||
Matrix](https://matrix.to/#/#freenode_#pixelfed:matrix.org)
|
Matrix](https://matrix.to/#/#freenode_#pixelfed:matrix.org))
|
||||||
* Project on Mastodon: [@pixelfed@mastodon.social](https://mastodon.social/@pixelfed)
|
* Project on Mastodon: [@pixelfed@mastodon.social](https://mastodon.social/@pixelfed)
|
||||||
* E-mail: [hello@pixelfed.org](mailto:hello@pixelfed.org)
|
* E-mail: [hello@pixelfed.org](mailto:hello@pixelfed.org)
|
||||||
|
|
||||||
|
|
@ -80,29 +41,27 @@ https://www.patreon.com/dansup
|
||||||
### Contributors
|
### Contributors
|
||||||
|
|
||||||
This project exists thanks to all the people who contribute.
|
This project exists thanks to all the people who contribute.
|
||||||
<a href="https://github.com/pixelfed/pixelfed/graphs/contributors"><img src="https://opencollective.com/pixelfed-528/contributors.svg?width=890&button=false" /></a>
|
<a href="https://github.com/pixelfed/pixelfed/graphs/contributors"><img src="https://opencollective.com/pixelfed/contributors.svg?width=890&button=false" /></a>
|
||||||
|
|
||||||
|
|
||||||
### Backers
|
### Backers
|
||||||
|
|
||||||
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/pixelfed-528#backer)]
|
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/pixelfed#backer)]
|
||||||
|
|
||||||
<a href="https://opencollective.com/pixelfed-528#backers" target="_blank"><img src="https://opencollective.com/pixelfed-528/backers.svg?width=890"></a>
|
<a href="https://opencollective.com/pixelfed#backers" target="_blank"><img src="https://opencollective.com/pixelfed/backers.svg?width=890"></a>
|
||||||
|
|
||||||
|
|
||||||
### Sponsors
|
### Sponsors
|
||||||
|
|
||||||
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/pixelfed-528#sponsor)]
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/pixelfed#sponsor)]
|
||||||
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/0/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/0/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/1/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/1/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/2/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/2/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/3/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/3/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/4/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/4/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/5/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/5/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/6/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/6/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/7/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/7/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/8/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/8/avatar.svg"></a>
|
|
||||||
<a href="https://opencollective.com/pixelfed-528/sponsor/9/website" target="_blank"><img src="https://opencollective.com/pixelfed-528/sponsor/9/avatar.svg"></a>
|
|
||||||
|
|
||||||
|
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/0/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/0/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/1/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/1/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/2/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/2/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/3/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/3/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/4/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/4/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/5/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/5/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/6/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/6/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/7/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/7/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/8/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/8/avatar.svg"></a>
|
||||||
|
<a href="https://opencollective.com/pixelfed/sponsor/9/website" target="_blank"><img src="https://opencollective.com/pixelfed/sponsor/9/avatar.svg"></a>
|
||||||
Loading…
Reference in a new issue