mirror of
https://github.com/YunoHost-Apps/pixelfed_ynh.git
synced 2024-09-03 20:06:04 +02:00
101 lines
3.8 KiB
Markdown
101 lines
3.8 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Pixelfed for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/pixelfed)  
|
|
[](https://install-app.yunohost.org/?app=pixelfed)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Pixelfed quickly and simply on a YunoHost server.
|
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
PixelFed is a decentralized and federated image sharing software under development.
|
|
In addition to taking over the functionality of Instagram, the functioning of PixelFed is:
|
|
|
|
* Decentralized: Each instance can follow one or more other PixelFed instances in order to allow their respective members to interact. A first pixelfed.social public body limited to 10,000 members has already been created.
|
|
|
|
* Federated: Via the ActivityPub protocol, PixelFed can interact with other software that is part of the Fediverse, such as Mastodon or PeerTube for example.
|
|
|
|
It is also possible to import your data from Instagram.
|
|
|
|
**Shipped version:** 0.11.4~ynh3
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
## Important points to read before installing
|
|
|
|
1. **Pixelfed** require a dedicated **root domain**, eg. pixelfed.domain.tld
|
|
|
|
### Administrator
|
|
|
|
After being first registered, you need to execute the folloing command to promote first registered as admin
|
|
|
|
**Run:**
|
|
|
|
$ sudo php7.4 /var/www/pixelfed/artisan user:admin 1
|
|
|
|
and respond yes to the question ` Add admin privileges to this user?`.
|
|
|
|
### Allow/Close registrations
|
|
|
|
Registrations are open by default.
|
|
To change that setting, edit `/var/www/pixelfed/.env` and set `OPEN_REGISTRATION=false` instead of `true`.
|
|
Then run `php7.4 artisan config:cache` to reload the settings.
|
|
|
|
### Change max upload limit
|
|
|
|
To change max upload limit (default : 50MB), edit the Pixelfed `php-fpm.conf` file and find the line `Common values to change to increase file upload limit`
|
|
And adjust those values:
|
|
```
|
|
php_admin_value[post_max_size] = 50M
|
|
php_admin_value[upload_max_filesize] = 50M
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### Disable search engine indexing
|
|
|
|
If you don't want your Pixelfed instance to be indexed in search engine (and so on), edit `/var/www/pixelfed/public/robots.txt` like this:
|
|
```
|
|
User-agent: *
|
|
Disallow: /
|
|
```
|
|
Note: search engines will see that file and may or may not respect its content.
|
|
|
|
Since 0.10.10, by default `/discover/places/`, `/stories/` and `/i/` are present in that file.
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://pixelfed.org/>
|
|
* Official user documentation: <https://docs.pixelfed.org/>
|
|
* Official admin documentation: <https://docs.pixelfed.org/running-pixelfed/administration.html>
|
|
* Upstream app code repository: <https://github.com/pixelfed/pixelfed>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_pixelfed>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/pixelfed_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade pixelfed -u https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|