mirror of https://github.com/pixelfed/pixelfed
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.
106 lines
5.7 KiB
Markdown
106 lines
5.7 KiB
Markdown
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://pixelfed.nyc3.cdn.digitaloceanspaces.com/logos/pixelfed-full-color-dark.svg">
|
|
<source media="(prefers-color-scheme: light)" srcset="https://pixelfed.nyc3.cdn.digitaloceanspaces.com/logos/pixelfed-full-color.svg">
|
|
<img alt="Pixelfed logo" src="https://pixelfed.nyc3.cdn.digitaloceanspaces.com/logos/pixelfed-full-color.svg">
|
|
</picture>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://packagist.org/packages/pixelfed/pixelfed"><img src="https://poser.pugx.org/pixelfed/pixelfed/v/stable.svg" alt="Latest Stable Version"></a>
|
|
<a href="https://packagist.org/packages/pixelfed/pixelfed"><img src="https://poser.pugx.org/pixelfed/pixelfed/license.svg" alt="License"></a>
|
|
<a title="Crowdin" target="_blank" href="https://crowdin.com/project/pixelfed"><img src="https://badges.crowdin.net/pixelfed/localized.svg"></a>
|
|
<a href="https://fedidb.org/software/pixelfed"><img src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.fedidb.org%2Fv1%2Fsoftware%2Fpixelfed&query=%24.user_count&logo=pixelfed&logoColor=white&label=Total%20Users" alt="Total Pixelfed users from FediDB" /></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a target="_blank" href="https://discord.gg/msXs3MumsK"><img src="https://dcbadge.limes.pink/api/server/https://discord.gg/msXs3MumsK" alt="" /></a>
|
|
</p>
|
|
|
|
</p>
|
|
|
|
## Introduction
|
|
|
|
Photo sharing the way it should be. Pixelfed lets your casual shots and creative photography find their audience naturally, without algorithmic barriers. Join [millions](https://fedidb.com) of people sharing across the [fediverse](https://fediverse.info).
|
|
|
|
<p align="center">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://pixelfed.nyc3.cdn.digitaloceanspaces.com/media/pixelfed-readme-dark.jpg">
|
|
<source media="(prefers-color-scheme: light)" srcset="https://pixelfed.nyc3.cdn.digitaloceanspaces.com/media/pixelfed-readme-light.jpg">
|
|
<img alt="Pixelfed web user interface in light mode" src="https://pixelfed.nyc3.cdn.digitaloceanspaces.com/media/pixelfed-readme-light.jpg">
|
|
</picture>
|
|
</p>
|
|
|
|
## AI-Generated Contributions
|
|
|
|
> **AI-generated contributions are not accepted.**
|
|
>
|
|
> Pull requests, patches, documentation, translations, issues, or other contributions that are substantially generated by generative AI or large language models will not be accepted.
|
|
>
|
|
> Contributors are expected to understand, author, and take responsibility for the work they submit. Tools such as linters, formatters, autocomplete, spellcheckers, and other non-generative development tools are unaffected by this policy.
|
|
|
|
## PHP Support
|
|
|
|
Notice: While older unsupported PHP versions might work, we recommend using the recommended version.
|
|
|
|
- PHP 8.5 (Recommended) - Our baseline for testing/Docker images.
|
|
- PHP 8.4 (Supported) - Active support ends _31 Dec 2026_.
|
|
|
|
Reference: https://www.php.net/supported-versions.php
|
|
|
|
## Database Support (Please report any regressions)
|
|
|
|
- MySQL 8+ is officially supported (Strict mode is not default).
|
|
- MariaDB 11+ is officially supported (Strict mode is default).
|
|
- PostgreSQL 14+ is best effort _as of writing_ (Not recommended).
|
|
|
|
Notice: We need to improve the ecosystem to test/validate the codebase to be database agnostic, but this will require considerable engineering effort. Thank you for your understanding.
|
|
|
|
## Official Documentation
|
|
|
|
- As of September 2026, we recommend using Docker compose to run your instances. Non-docker is obviously supported, but the Dockerfile will be maintained and updated with best practices and latest releases.
|
|
|
|
Documentation for Pixelfed can be found on the [Pixelfed documentation website](https://docs.pixelfed.org/).
|
|
|
|
## API/Developer Documentation
|
|
|
|
API and Developer documentation for Pixelfed can be found on the [Pixelfed Developers website](https://developers.pixelfed.org).
|
|
|
|
## License
|
|
|
|
Pixelfed is open-sourced software licensed under the AGPL license.
|
|
|
|
## Communication
|
|
|
|
The ways you can communicate on the project are below. Before interacting, please
|
|
read through the [Code Of Conduct](CODE_OF_CONDUCT.md).
|
|
|
|
- Matrix: [matrix.to/#/#pixeldev:matrix.org](https://matrix.to/#/#pixeldev:matrix.org)
|
|
- Mastodon: [@pixelfed@mastodon.social](https://mastodon.social/@pixelfed)
|
|
- E-mail: [hello@pixelfed.org](mailto:hello@pixelfed.org)
|
|
|
|
## Pixelfed Sponsors
|
|
|
|
We would like to extend our thanks to the following sponsors for funding Pixelfed development. If you are interested in becoming a sponsor, please visit the Pixelfed [Patreon Page](https://www.patreon.com/dansup/overview)
|
|
|
|
- [NLnet Foundation](https://nlnet.nl) and [NGI0
|
|
Discovery](https://nlnet.nl/discovery/), part of the [Next Generation
|
|
Internet](https://ngi.eu) initiative.
|
|
|
|
<p>This project is supported by:</p>
|
|
<p>
|
|
<a href="https://www.fastly.com/fast-forward">
|
|
<img src="https://github.com/user-attachments/assets/f1499b1f-c05f-480a-a5d5-dbebcb0e20fd">
|
|
</a>
|
|
</p>
|
|
|
|
## Host your own instance with these unofficial cloud providers
|
|
|
|
[](https://install-app.yunohost.org/?app=pixelfed) Pixelfed app for [YunoHost](https://yunohost.org "YunoHost"). See [the package source code](https://github.com/YunoHost-Apps/pixelfed_ynh "pixelfed_ynh repository on GitHub")
|
|
|
|
[](https://repocloud.io/details/Pixelfed/)
|
|
|
|
[](https://zop.dev/zopday/app/deploy?repo=https://github.com/pixelfed/pixelfed&port=8080&name=pixelfed&utm_source=github&utm_medium=one_click&utm_content=pixelfed)
|
|
|
|
[](https://pethost.dev/templates/pixelfed/)
|