diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 00000000..9c21f0d5 --- /dev/null +++ b/doc/DESCRIPTION.md @@ -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. \ No newline at end of file diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 00000000..c3d63943 --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -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. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 00000000..8985c7fb --- /dev/null +++ b/doc/DISCLAIMER.md @@ -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. diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 00000000..05935e26 --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -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. diff --git a/doc/screenshots/screenshots.png b/doc/screenshots/screenshots.png new file mode 100644 index 00000000..e5d6500f Binary files /dev/null and b/doc/screenshots/screenshots.png differ diff --git a/manifest.json b/manifest.json index 9379a69f..a0f11f76 100644 --- a/manifest.json +++ b/manifest.json @@ -8,6 +8,14 @@ }, "version": "0.11.1~ynh1", "url": "https://pixelfed.org/", + "upstream": { + "license": "AGPL-3.0-or-later", + "website": "https://pixelfed.org/", + "demo": "https://demo.example.com", + "admindoc": "https://yunohost.org/packaging_apps", + "userdoc": "https://yunohost.org/apps", + "code": "https://some.forge.com/example/example" + }, "license": "AGPL-3.0-or-later", "maintainer": [ {