mirror of
https://github.com/YunoHost-Apps/pixelfed_ynh.git
synced 2024-09-03 20:06:04 +02:00
commit
4cae295495
11 changed files with 214 additions and 41 deletions
66
README.md
66
README.md
|
@ -1,26 +1,43 @@
|
||||||
|
<!--
|
||||||
|
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
|
# Pixelfed for YunoHost
|
||||||
|
|
||||||
[](https://dash.yunohost.org/appci/app/pixelfed)  
|
[](https://dash.yunohost.org/appci/app/pixelfed)  
|
||||||
[](https://install-app.yunohost.org/?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.
|
> *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.*
|
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The federated image sharing service Pixelfed, for YunoHost
|
|
||||||
|
|
||||||
**Shipped version:** 0.11.0~ynh2
|
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.1~ynh1
|
||||||
|
|
||||||
|
**Demo:** https://demo.example.com
|
||||||
|
|
||||||
|
## Screenshots
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Disclaimers / important information
|
||||||
|
|
||||||
## Important points to read before installing
|
## Important points to read before installing
|
||||||
|
|
||||||
1. **Pixelfed** require a dedicated **root domain**, eg. pixelfed.domain.tld
|
1. **Pixelfed** require a dedicated **root domain**, eg. pixelfed.domain.tld
|
||||||
|
|
||||||
## Screenshots
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
## Configuration
|
|
||||||
|
|
||||||
### Administrator
|
### Administrator
|
||||||
|
|
||||||
After being first registered, you need to execute the folloing command to promote first registered as admin
|
After being first registered, you need to execute the folloing command to promote first registered as admin
|
||||||
|
@ -48,31 +65,14 @@ 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.
|
Since 0.10.10, by default `/discover/places/`, `/stories/` and `/i/` are present in that file.
|
||||||
|
|
||||||
### Pixelfed php commands and php version
|
## Documentation and resources
|
||||||
|
|
||||||
Pixelfed might require some command line instructions if you want to make manual changes to your configuration.
|
* Official app website: https://pixelfed.org/
|
||||||
By default php 7.0 is currently used when you type `php`. You need to use `php7.3 [command]` instead.
|
* Official user documentation: https://docs.pixelfed.org/
|
||||||
Those commands can be found in the official documentation.
|
* Official admin documentation: https://docs.pixelfed.org/running-pixelfed/administration.html
|
||||||
|
* Upstream app code repository: https://github.com/pixelfed/pixelfed
|
||||||
## Documentation
|
* YunoHost documentation for this app: https://yunohost.org/app_pixelfed
|
||||||
|
* Report a bug: https://github.com/YunoHost-Apps/pixelfed_ynh/issues
|
||||||
* [Official documentation](https://docs.pixelfed.org/)
|
|
||||||
|
|
||||||
## YunoHost specific features
|
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/pixelfed/)
|
|
||||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/pixelfed/)
|
|
||||||
|
|
||||||
## Links
|
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/pixelfed_ynh
|
|
||||||
* App website: https://pixelfed.org
|
|
||||||
* Upstream app repository: https://github.com/pixelfed/pixelfed
|
|
||||||
* YunoHost website: https://yunohost.org
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Developer info
|
## Developer info
|
||||||
|
|
||||||
|
@ -84,3 +84,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/pixelfed_ynh/tree/tes
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade pixelfed -u https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug
|
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
|
85
README_fr.md
Normal file
85
README_fr.md
Normal file
|
@ -0,0 +1,85 @@
|
||||||
|
# Pixelfed pour YunoHost
|
||||||
|
|
||||||
|
[](https://dash.yunohost.org/appci/app/pixelfed)  
|
||||||
|
[](https://install-app.yunohost.org/?app=pixelfed)
|
||||||
|
|
||||||
|
*[Read this readme in english.](./README.md)*
|
||||||
|
*[Lire ce readme en français.](./README_fr.md)*
|
||||||
|
|
||||||
|
> *Ce package vous permet d'installer Pixelfed rapidement et simplement sur un serveur YunoHost.
|
||||||
|
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
|
||||||
|
|
||||||
|
## Vue d'ensemble
|
||||||
|
|
||||||
|
PixelFed est un logiciel décentralisé et fédéré de partage d'images en cours de développement.
|
||||||
|
En plus de reprendre les fonctionnalités d'Instagram, le fonctionnement de PixelFed est:
|
||||||
|
|
||||||
|
* Décentralisé : Chaque instance peut suivre une ou plusieurs autres instances PixelFed afin de permettre à leurs membres respectifs d'interagir. Une première instance publique pixelfed.social limitée à 10 000 membres a déjà été créée.
|
||||||
|
|
||||||
|
* Fédéré : Via le protocole ActivityPub, PixelFed peut interagir avec d'autres logiciels qui font partie du Fediverse, comme Mastodon ou PeerTube par exemple.
|
||||||
|
|
||||||
|
Il est également possible d'importer ses données depuis Instagram.
|
||||||
|
|
||||||
|
|
||||||
|
**Version incluse :** 0.11.1~ynh1
|
||||||
|
|
||||||
|
**Démo :** https://demo.example.com
|
||||||
|
|
||||||
|
## Captures d'écran
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## Avertissements / informations importantes
|
||||||
|
|
||||||
|
## Points importants à lire avant l'installation
|
||||||
|
|
||||||
|
1. **Pixelfed** nécessite un **domaine racine** dédié, par ex. pixelfed.domain.tld
|
||||||
|
|
||||||
|
### Administrateur
|
||||||
|
|
||||||
|
Après avoir été enregistré pour la première fois, vous devez exécuter la commande suivante pour promouvoir le premier enregistré en tant qu'administrateur
|
||||||
|
|
||||||
|
**Courir:**
|
||||||
|
|
||||||
|
$ (cd /var/www/pixelfed && php7.3 artisan user:admin 1)
|
||||||
|
|
||||||
|
et répondez oui à la question « Ajouter des privilèges d'administrateur à cet utilisateur ? »
|
||||||
|
|
||||||
|
### Autoriser/Fermer les inscriptions
|
||||||
|
|
||||||
|
Les inscriptions sont ouvertes par défaut.
|
||||||
|
Pour modifier ce paramètre, modifiez `/var/www/pixelfed/.env` et définissez `OPEN_REGISTRATION=false` au lieu de `true`.
|
||||||
|
Ensuite, exécutez `php7.3 artisan config:cache` pour recharger les paramètres.
|
||||||
|
|
||||||
|
### Désactiver l'indexation des moteurs de recherche
|
||||||
|
|
||||||
|
Si vous ne voulez pas que votre instance Pixelfed soit indexée dans le moteur de recherche (et ainsi de suite), modifiez `/var/www/pixelfed/public/robots.txt` comme ceci :
|
||||||
|
```
|
||||||
|
Agent utilisateur: *
|
||||||
|
Interdire : /
|
||||||
|
```
|
||||||
|
Remarque : les moteurs de recherche verront ce fichier et pourront ou non respecter son contenu.
|
||||||
|
|
||||||
|
Depuis la 0.10.10, par défaut `/discover/places/`, `/stories/` et `/i/` sont présents dans ce fichier.
|
||||||
|
|
||||||
|
## Documentations et ressources
|
||||||
|
|
||||||
|
* Site officiel de l'app : https://pixelfed.org/
|
||||||
|
* Documentation officielle utilisateur : https://docs.pixelfed.org/
|
||||||
|
* Documentation officielle de l'admin : https://docs.pixelfed.org/running-pixelfed/administration.html
|
||||||
|
* Dépôt de code officiel de l'app : https://github.com/pixelfed/pixelfed
|
||||||
|
* Documentation YunoHost pour cette app : https://yunohost.org/app_pixelfed
|
||||||
|
* Signaler un bug : https://github.com/YunoHost-Apps/pixelfed_ynh/issues
|
||||||
|
|
||||||
|
## Informations pour les développeurs
|
||||||
|
|
||||||
|
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing).
|
||||||
|
|
||||||
|
Pour essayer la branche testing, procédez comme suit.
|
||||||
|
```
|
||||||
|
sudo yunohost app install https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug
|
||||||
|
ou
|
||||||
|
sudo yunohost app upgrade pixelfed -u https://github.com/YunoHost-Apps/pixelfed_ynh/tree/testing --debug
|
||||||
|
```
|
||||||
|
|
||||||
|
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
|
@ -1,7 +1,7 @@
|
||||||
;; Test complet
|
;; Test complet
|
||||||
; Manifest
|
; Manifest
|
||||||
domain="domain.tld" (DOMAIN)
|
domain="domain.tld"
|
||||||
is_public=1 (PUBLIC|public=1|private=0)
|
is_public=1
|
||||||
; Checks
|
; Checks
|
||||||
pkg_linter=1
|
pkg_linter=1
|
||||||
setup_sub_dir=0
|
setup_sub_dir=0
|
||||||
|
@ -30,12 +30,14 @@
|
||||||
# upgrade=1 from_commit=8ef41895fbd38008f3718e164d0bf3f0d97a2c03
|
# upgrade=1 from_commit=8ef41895fbd38008f3718e164d0bf3f0d97a2c03
|
||||||
# 0.11.0~ynh1
|
# 0.11.0~ynh1
|
||||||
upgrade=1 from_commit=c7181d1c7cb6cba53bb65e622c78b0309a53b76a
|
upgrade=1 from_commit=c7181d1c7cb6cba53bb65e622c78b0309a53b76a
|
||||||
|
# 0.11.0~ynh2
|
||||||
|
upgrade=1 from_commit=d85b0b112afd19313dbf4cfba954e255789dfb88
|
||||||
backup_restore=1
|
backup_restore=1
|
||||||
multi_instance=1
|
multi_instance=1
|
||||||
port_already_use=0
|
port_already_use=0
|
||||||
change_url=1
|
change_url=1
|
||||||
;;; Options
|
;;; Options
|
||||||
Email=jean-baptiste@holcroft.fr;yalh@yahoo.com
|
Email=yalh@yahoo.com
|
||||||
Notification=all
|
Notification=all
|
||||||
;;; Upgrade options
|
;;; Upgrade options
|
||||||
; commit=10c3703567d1e9504ea4f298778464c7dd561470
|
; commit=10c3703567d1e9504ea4f298778464c7dd561470
|
||||||
|
@ -54,3 +56,5 @@ Notification=all
|
||||||
name=0.10.10~ynh4
|
name=0.10.10~ynh4
|
||||||
; commit=c7181d1c7cb6cba53bb65e622c78b0309a53b76a
|
; commit=c7181d1c7cb6cba53bb65e622c78b0309a53b76a
|
||||||
name=0.11.0~ynh1
|
name=0.11.0~ynh1
|
||||||
|
; commit=d85b0b112afd19313dbf4cfba954e255789dfb88
|
||||||
|
name=0.11.0~ynh2
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
SOURCE_URL=https://github.com/pixelfed/pixelfed/archive/v0.11.0.tar.gz
|
SOURCE_URL=https://github.com/pixelfed/pixelfed/archive/v0.11.1.tar.gz
|
||||||
SOURCE_SUM=6959505c6c60f317091f51fa3756fc073a8ddc8c277e5736be285eb825ca625c
|
SOURCE_SUM=132dfceac3c0ea27dd54198d145d2d84f1714b4aa333c8b6f5141d259a77e9cb
|
||||||
OURCE_SUM_PRG=sha256sum
|
OURCE_SUM_PRG=sha256sum
|
||||||
SOURCE_FORMAT=tar.gz
|
SOURCE_FORMAT=tar.gz
|
||||||
SOURCE_IN_SUBDIR=true
|
SOURCE_IN_SUBDIR=true
|
||||||
|
|
8
doc/DESCRIPTION.md
Normal file
8
doc/DESCRIPTION.md
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
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.
|
8
doc/DESCRIPTION_fr.md
Normal file
8
doc/DESCRIPTION_fr.md
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
PixelFed est un logiciel décentralisé et fédéré de partage d'images en cours de développement.
|
||||||
|
En plus de reprendre les fonctionnalités d'Instagram, le fonctionnement de PixelFed est:
|
||||||
|
|
||||||
|
* Décentralisé : Chaque instance peut suivre une ou plusieurs autres instances PixelFed afin de permettre à leurs membres respectifs d'interagir. Une première instance publique pixelfed.social limitée à 10 000 membres a déjà été créée.
|
||||||
|
|
||||||
|
* Fédéré : Via le protocole ActivityPub, PixelFed peut interagir avec d'autres logiciels qui font partie du Fediverse, comme Mastodon ou PeerTube par exemple.
|
||||||
|
|
||||||
|
Il est également possible d'importer ses données depuis Instagram.
|
30
doc/DISCLAIMER.md
Normal file
30
doc/DISCLAIMER.md
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
## 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:**
|
||||||
|
|
||||||
|
$ (cd /var/www/pixelfed && php7.3 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.3 artisan config:cache` to reload the settings.
|
||||||
|
|
||||||
|
### 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.
|
30
doc/DISCLAIMER_fr.md
Normal file
30
doc/DISCLAIMER_fr.md
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
## Points importants à lire avant l'installation
|
||||||
|
|
||||||
|
1. **Pixelfed** nécessite un **domaine racine** dédié, par ex. pixelfed.domain.tld
|
||||||
|
|
||||||
|
### Administrateur
|
||||||
|
|
||||||
|
Après avoir été enregistré pour la première fois, vous devez exécuter la commande suivante pour promouvoir le premier enregistré en tant qu'administrateur
|
||||||
|
|
||||||
|
**Courir:**
|
||||||
|
|
||||||
|
$ (cd /var/www/pixelfed && php7.3 artisan user:admin 1)
|
||||||
|
|
||||||
|
et répondez oui à la question « Ajouter des privilèges d'administrateur à cet utilisateur ? »
|
||||||
|
|
||||||
|
### Autoriser/Fermer les inscriptions
|
||||||
|
|
||||||
|
Les inscriptions sont ouvertes par défaut.
|
||||||
|
Pour modifier ce paramètre, modifiez `/var/www/pixelfed/.env` et définissez `OPEN_REGISTRATION=false` au lieu de `true`.
|
||||||
|
Ensuite, exécutez `php7.3 artisan config:cache` pour recharger les paramètres.
|
||||||
|
|
||||||
|
### Désactiver l'indexation des moteurs de recherche
|
||||||
|
|
||||||
|
Si vous ne voulez pas que votre instance Pixelfed soit indexée dans le moteur de recherche (et ainsi de suite), modifiez `/var/www/pixelfed/public/robots.txt` comme ceci :
|
||||||
|
```
|
||||||
|
Agent utilisateur: *
|
||||||
|
Interdire : /
|
||||||
|
```
|
||||||
|
Remarque : les moteurs de recherche verront ce fichier et pourront ou non respecter son contenu.
|
||||||
|
|
||||||
|
Depuis la 0.10.10, par défaut `/discover/places/`, `/stories/` et `/i/` sont présents dans ce fichier.
|
BIN
doc/screenshots/screenshots.png
Normal file
BIN
doc/screenshots/screenshots.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 714 KiB |
|
@ -6,8 +6,16 @@
|
||||||
"en": "ActivityPub Federated Image Sharing",
|
"en": "ActivityPub Federated Image Sharing",
|
||||||
"fr": "Logiciel de partage d'image fédéré via ActivityPub"
|
"fr": "Logiciel de partage d'image fédéré via ActivityPub"
|
||||||
},
|
},
|
||||||
"version": "0.11.0~ynh2",
|
"version": "0.11.1~ynh1",
|
||||||
"url": "https://pixelfed.org/",
|
"url": "https://pixelfed.org/",
|
||||||
|
"upstream": {
|
||||||
|
"license": "AGPL-3.0-or-later",
|
||||||
|
"website": "https://pixelfed.org/",
|
||||||
|
"demo": "https://demo.example.com",
|
||||||
|
"admindoc": "https://docs.pixelfed.org/running-pixelfed/administration.html",
|
||||||
|
"userdoc": "https://docs.pixelfed.org/",
|
||||||
|
"code": "https://github.com/pixelfed/pixelfed"
|
||||||
|
},
|
||||||
"license": "AGPL-3.0-or-later",
|
"license": "AGPL-3.0-or-later",
|
||||||
"maintainer": [
|
"maintainer": [
|
||||||
{
|
{
|
||||||
|
|
|
@ -40,8 +40,6 @@ phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
|
||||||
#=================================================
|
#=================================================
|
||||||
ynh_script_progression --message="Validating restoration parameters..."
|
ynh_script_progression --message="Validating restoration parameters..."
|
||||||
|
|
||||||
ynh_webpath_available --domain=$domain --path_url=$path_url \
|
|
||||||
|| ynh_die --message="Path not available: ${domain}${path_url}"
|
|
||||||
test ! -d $final_path \
|
test ! -d $final_path \
|
||||||
|| ynh_die --message="There is already a directory: $final_path "
|
|| ynh_die --message="There is already a directory: $final_path "
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue