diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Features.md | 4 | ||||
| -rw-r--r-- | doc/Tags-and-Mentions.md | 4 | ||||
| -rw-r--r-- | doc/Widgets.md | 16 | ||||
| -rw-r--r-- | doc/addons.bb | 21 | ||||
| -rw-r--r-- | doc/cloud.bb | 2 | ||||
| -rw-r--r-- | doc/comanche.bb | 4 | ||||
| -rw-r--r-- | doc/database/db_term.bb | 22 | ||||
| -rw-r--r-- | doc/extra_features.bb | 4 | ||||
| -rw-r--r-- | doc/features.bb | 4 | ||||
| -rw-r--r-- | doc/fr/about.bb | 25 | ||||
| -rw-r--r-- | doc/fr/git_for_non_developers.bb | 73 | ||||
| -rw-r--r-- | doc/fr/main.bb | 12 | ||||
| -rw-r--r-- | doc/hidden_configs.bb | 162 | ||||
| -rw-r--r-- | doc/roles.md | 10 | ||||
| -rw-r--r-- | doc/tags_and_mentions.bb | 4 | ||||
| -rw-r--r-- | doc/to_do_code.bb | 3 |
16 files changed, 265 insertions, 105 deletions
diff --git a/doc/Features.md b/doc/Features.md index 5a1e8c747..3c5105582 100644 --- a/doc/Features.md +++ b/doc/Features.md @@ -57,9 +57,9 @@ Private messages are encrypted during transport and storage. In this day and age This provides the ability to select posts by date ranges -**Collections Filter** +**Privacy Group Filter** -Enable widget to display stream posts only from selected collections. This also toggles the outbound permissions while you are viewing a collection. This is analogous to Google "circles" or Disapora "aspects". +Enable widget to display stream posts only from selected groups of connection. This also toggles the outbound permissions while you are viewing a privacy group. This is analogous to Google "circles" or Disapora "aspects". **Saved Searches** diff --git a/doc/Tags-and-Mentions.md b/doc/Tags-and-Mentions.md index 84442dd7a..f01b0ee74 100644 --- a/doc/Tags-and-Mentions.md +++ b/doc/Tags-and-Mentions.md @@ -11,9 +11,9 @@ When you start to mention somebody, it will create an auto-complete box to selec **Private Mentions** -If you wish to restrict a post to a single person or a number of people, you can do this by selecting channels or collections from the privacy tool. You can also just tag them with a privacy tag. A privacy tag is a name preceded by the two characters @! - and in addition to tagging these channels, will also change the privacy permissions of the post to include them (and perhaps restrict the post from "everybody" if this was the default). You can have more than one privacy tag, for instance @!bob and @!linda will send the post only to Bob and Linda (in addition to any recipients you selected with the privacy selector - if any). +If you wish to restrict a post to a single person or a number of people, you can do this by selecting channels or privacy groups from the privacy tool. You can also just tag them with a privacy tag. A privacy tag is a name preceded by the two characters @! - and in addition to tagging these channels, will also change the privacy permissions of the post to include them (and perhaps restrict the post from "everybody" if this was the default). You can have more than one privacy tag, for instance @!bob and @!linda will send the post only to Bob and Linda (in addition to any recipients you selected with the privacy selector - if any). -You may also tag public collections. When you create or edit a collection, there is a checkbox to allow the group members to be seen by others. If this box is checked for a collection and you tag (for instance) @!Friends - the post will be restricted to the Friends collection. Check that the collection is public before doing this - as there is no way to take back a post except to delete it. The collection name will appear in the post and will alert members of that collection that they are members of it. +You may also tag privacy groups which are "public". When you create or edit a privacy group, there is a checkbox to allow the group members to be seen by others. If this box is checked for a group and you tag (for instance) @!Friends - the post will be restricted to the Friends group. Check that the group is public before doing this - as there is no way to take back a post except to delete it. The group name will appear in the post and will alert members of that group that they are members of it. diff --git a/doc/Widgets.md b/doc/Widgets.md index baacffd6f..8442bf687 100644 --- a/doc/Widgets.md +++ b/doc/Widgets.md @@ -15,7 +15,7 @@ Some/many of these widgets have restrictions which may restrict the type of page * args: count - number of items to return (default 24) <br /> <br /> -* collections - collection selector for the current logged in channel +* collections - privacy group selector for the current logged in channel * args: mode - one of "conversation", "group", "abook" depending on module <br /> <br /> @@ -74,8 +74,11 @@ Some/many of these widgets have restrictions which may restrict the type of page * suggestedchats - "interesting" chatrooms chosen for the current observer -* item - displays a single webpage item by mid - * args: mid - message_id of webpage to display (must be webpage, not a conversation item) +* item - displays a single webpage item by mid or page title + * args: + * channel_id - channel that owns the content, defualt is the profile_uid + * mid - message_id of webpage to display (must be webpage, not a conversation item) + * title - URL page title of webpage (must provide one of either title or mid) <br /> <br /> * photo - display a single photo @@ -85,6 +88,13 @@ Some/many of these widgets have restrictions which may restrict the type of page * style - CSS style string <br /> <br /> +* cover_photo - display the cover photo for the selected channel + * args: + * channel_id - channel to use, default is the profile_uid + * style - CSS style string (default is dynamically resized to width of region) +<br /> <br /> + + * photo_rand - display a random photo from one of your photo albums. Photo permissions are honoured * args: * album - album name (very strongly recommended if you have lots of photos) diff --git a/doc/addons.bb b/doc/addons.bb index a6d2cfc2f..67282521f 100644 --- a/doc/addons.bb +++ b/doc/addons.bb @@ -1,19 +1,22 @@ [h3]Plugins/Addons[/h3] [list=1] [*] abcjsplugin - Create musical scores in your posts +[*] adultphotoflag - prevents nsfw photos from being displayed in public albums [*] bbmath - use complex math expressions in your posts [*] bookmarker - replace #^ with bookmark link in posts [*] buglink - provide a bug reporting icon in the lower-left corner of every page [*] calc - a scientific calculator +[*] chess - cross domain identity aware interactive chess games [*] chords - generate fingering charts and alternatives for every known guitar chord [*] custom_home - set a custom page as the hub start page -[*] diaspora - crosspost to a Diaspora account (different from the built-in Diaspora emulator) +[*] dfedfix - fixes some federation issues with Diaspora releases around aug-sep 2015 +[*] diaspora - Diaspora protocol emulator +[*] diaspost - crosspost to a Diaspora account (different from the Diaspora protocol emulator) [*] dirstats - show some interesting statistics generated by the driectory server [*] donate - provides a project donation page [*] dwpost - crosspost to Dreamwidth -[*] embedly - use the embedly (formerly ooehmbed) service to embed media from many providers [*] extcron - use an external cron service to run your hub's scheduled tasks -[*] flattr - provides a "Flattr Us" button +[*] flattrwidget - provides a "Flattr Us" button [*] flip - create upside down text [*] fortunate - displays random quote (fortune cookie). Requires setting up a fortune server. [*] frphotos - import photo albums from Friendica @@ -26,12 +29,16 @@ [*] libertree - crosspost to Libertree [*] likebanner - create a "like us on red#matrix" banner image [*] ljpost - crosspost to LiveJournal +[*] logrot - logfile rotation utility [*] mahjongg - Chinese puzzle game [*] mailhost - when using multiple channel clones, select one to receive email notifications [*] mayan_places - set location field to a random city in the Mayan world [*] morechoice - additional gender/sexual-preference choices for profiles (not safe for work) [*] moremoods - Additional mood options [*] morepokes - additional poke options (not safe for work) +[*] msgfooter - provide legal or other text on each outgoing post +[*] noembed - use noembed.com as an addition to Hubzilla's native oembed functionality (currently broken) +[*] nofed - prevent "federation" of channel posts, maintains all interaction on your site [*] nsabait - add random terrorism related hashtags to your posts [*] nsfw - Highly recommended plugin to collpase posts with inappropriate content [*] openclipatar - choose a profile photo from hundreds of royalty free images @@ -42,21 +49,29 @@ [*] qrator - generate QR code images [*] rainbowtag - display your tag and category clouds in colours [*] randpost - post/reply bot based on and requires fortunate +[*] redfiles - import file storage from redmatrix +[*] redphotos - import photo albums from redmatrix [*] redred - Crosspost to another Red Matrix or Hubzilla channel [*] rtof - Crosspost to Friendica +[*] sendzid - add 'zid' auth parmaters to all outbound links, not just in-network links +[*] skeleton - sample addon/plugin to demonstrate plugin development [*] smiley_pack - extend the built-in smilie (emoticon) support [*] smileybutton - provides a smiley selector on the post window [*] startpage - set a personal preferred page to redirect after logging in. +[*] statistics_json - Diaspora statistics generator [*] statusnet - GNU-social and StatusNet crosspost [zrl=[baseurl]/help/addons_gnusocial]Posting To Gnu Social[/zrl] [*] superblock - Highly recommended - completely block an offensive channel from your stream +[*] testdrive - Turns your hub into a test drive site with accounts that expire after a trail period. [*] tictac - 3D tic-tac-toe [*] torch - flashlight app [*] tour - feature tour for new members [*] twitter - crosspost to Twitter [*] upload_limits - discover what server setting (there are a few) may be causing large photo uploads to fail [*] visage - show visitors to your channel +[*] wholikesme - provides a page to display what connections have 'liked' your posts the most [*] webRTC - use an external server (mayfirst.org) to negotiate webRTC hookups [*] wppost - crosspost to WordPress (or other wordpress XMLRPC service) +[*] xmpp - XMPP chat based on converse.js [/list] [h3]Addon Repositories[/h3] diff --git a/doc/cloud.bb b/doc/cloud.bb index 20498e6a5..d5195c0f5 100644 --- a/doc/cloud.bb +++ b/doc/cloud.bb @@ -22,6 +22,6 @@ See: [zrl=[baseurl]/help/cloud_desktop_clients]Cloud Desktop Clients[/zrl] [b]Permissions[/b]
-When using WebDAV, the file is created with your channel's default file permissions and this cannot be changed from within the operating system. It also may not be as restrictive as you would like. What we've found is that the preferred method of making files private is to first create folders or directories; then visit "filestorage/{{username}}"; select the directory and change the permissions. Do this before you put anything into the directory. The directory permissions take precedence so you can then put files or other folders into that container and they will be protected from unwanted viewers by the directory permissions. It is common for folks to create a "personal" or "private" folder which is restricted to themselves. You can use this as a personal cloud to store anything from anywhere on the web or any computer and it is protected from others. You might also create folders for "family" and "friends" with permission granted to appropriate collections of channels.
+When using WebDAV, the file is created with your channel's default file permissions and this cannot be changed from within the operating system. It also may not be as restrictive as you would like. What we've found is that the preferred method of making files private is to first create folders or directories; then visit "filestorage/{{username}}"; select the directory and change the permissions. Do this before you put anything into the directory. The directory permissions take precedence so you can then put files or other folders into that container and they will be protected from unwanted viewers by the directory permissions. It is common for folks to create a "personal" or "private" folder which is restricted to themselves. You can use this as a personal cloud to store anything from anywhere on the web or any computer and it is protected from others. You might also create folders for "family" and "friends" with permission granted to appropriate privacy groups.
#include doc/macros/main_footer.bb;
diff --git a/doc/comanche.bb b/doc/comanche.bb index 2eaa15deb..6a96d5251 100644 --- a/doc/comanche.bb +++ b/doc/comanche.bb @@ -27,8 +27,8 @@ Currently there are five layout templates, unless your site provides additional edgesthree - three column layout with fixed side margins
full - three column layout with fixed side margins and adds a "header" region beneath the navigation bar
- [b]redable[/b]
- A template for reading longer texts. Three columns: aside, content and right_aside.
+ [b]redable[/b] (sic)
+ A template for reading longer texts full screen (so without navigation bar). Three columns: aside, content and right_aside.
For maximum readability it is advised to only use the middle content column.
[b]zen[/b]
diff --git a/doc/database/db_term.bb b/doc/database/db_term.bb index c0546cc6a..e1f6415fa 100644 --- a/doc/database/db_term.bb +++ b/doc/database/db_term.bb @@ -1,27 +1,27 @@ [table] [tr][th]Field[/th][th]Description[/th][th]Type[/th][th]Null[/th][th]Key[/th][th]Default[/th][th]Extra [/th][/tr] -[tr][td]tid[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment +[tr][td]tid[/td][td]sequential index[/td][td]int(10) unsigned[/td][td]NO[/td][td]PRI[/td][td]NULL[/td][td]auto_increment [/td][/tr] -[tr][td]aid[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]0[/td][td] +[tr][td]aid[/td][td]channel_account_id of the controlling channel[/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]0[/td][td] [/td][/tr] -[tr][td]uid[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]0[/td][td] +[tr][td]uid[/td][td]channel_id of the controlling channel[/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]0[/td][td] [/td][/tr] -[tr][td]oid[/td][td][/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]oid[/td][td]DB index of linked thing[/td][td]int(10) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]otype[/td][td][/td][td]tinyint(3) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]otype[/td][td]type of linked thing[/td][td]tinyint(3) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]type[/td][td][/td][td]tinyint(3) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]type[/td][td]taxonomy type (See Tag/term types in boot.php)[/td][td]tinyint(3) unsigned[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]term[/td][td][/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]term[/td][td]the actual taxonomy term[/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]url[/td][td][/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] +[tr][td]url[/td]relevant link (for tags and mentions, a link to the associated resource)[td][/td][td]char(255)[/td][td]NO[/td][td][/td][td]NULL[/td][td] [/td][/tr] -[tr][td]imgurl[/td][td][/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] +[tr][td]imgurl[/td][td]rarely used - an image associated with this taxonomy term[/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td]NULL[/td][td] [/td][/tr] -[tr][td]term_hash[/td][td][/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td][/td][td] +[tr][td]term_hash[/td][td]unique hash for this entry[/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td][/td][td] [/td][/tr] -[tr][td]parent_hash[/td][td][/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td][/td][td] +[tr][td]parent_hash[/td][td]for hierarchical taxonomies, the hash of the relevant parent[/td][td]char(255)[/td][td]NO[/td][td]MUL[/td][td][/td][td] [/td][/tr] [/table] diff --git a/doc/extra_features.bb b/doc/extra_features.bb index ed513eeb3..9fb43d9a1 100644 --- a/doc/extra_features.bb +++ b/doc/extra_features.bb @@ -47,9 +47,9 @@ Private messages are encrypted during transport and storage. In this day and age This provides the ability to select posts by date ranges
-[b]Collections Filter[/b]
+[b]Privacy Group Filter[/b]
-Enable widget to display stream posts only from selected collections. This also toggles the outbound permissions while you are viewing a collection. This is analogous to Google "circles" or Disapora "aspects".
+Enable widget to display stream posts only from selected privacy groups. This also toggles the outbound permissions while you are viewing a group. This is analogous to Google "circles" or Disapora "aspects".
[b]Saved Searches[/b]
diff --git a/doc/features.bb b/doc/features.bb index 2d9849d4e..3daf403c3 100644 --- a/doc/features.bb +++ b/doc/features.bb @@ -106,9 +106,9 @@ There is also experimental support for OpenID authentication which may be used i Channels may have permissions to become "derivative channels" where two or more existing channels combine to create a new topical channel.
-[b]Collections[/b]
+[b]Privacy Groups[/b]
-"Collections" is our implementation of privacy groups, which is similar to Google "Circles" and Diaspora "Aspects". This allows you to filter your incoming stream by collections or groups, and automatically set the outbound Access Control List to only those in the Collection when you post. You may over-ride this at any time (prior to sending the post).
+Our implementation of privacy groups is similar to Google "Circles" and Diaspora "Aspects". This allows you to filter your incoming stream by selected groups, and automatically set the outbound Access Control List to only those in that privacy group when you post. You may over-ride this at any time (prior to sending the post).
[b]Directory Services[/b]
diff --git a/doc/fr/about.bb b/doc/fr/about.bb new file mode 100644 index 000000000..7988c777e --- /dev/null +++ b/doc/fr/about.bb @@ -0,0 +1,25 @@ + +$Projectname est un réseau de communication décentralisé, qui a pour but de proposer un moyen de communication qui est résistant à la censure, respecte la confidentialité et qui est indépendant des grandes companies mondiales. Ces companies géantes fonctionnent comme des espions. Ce sont des monopoles centralisés sur internet. A l'orignie internet ne fonctionnait pas ainsi, il était décentralisé. + +$Projectname est libre et open source. Il est conçu pour pouvoir monter en charge depuis un petite Raspberry Pi jusqu'à un serveur puissant à plusieurs coeurs. Il peut être utilisé pour servir de moyen de communication entre quelques individus mais peut monter pour héberger plusieurs milliers d'utilisateurs. + +$Projectname a pour but d'être utilisable sans documentation. Il est facile à utiliser pour un usage quotidien pour un utilisateur moyen mais aussi par des administrateurs système ou des développeurs. + +Comment utiliser ? Cela dépend de ce que vous voulez en faire. + +Il est écrit en php. Cela le rend facile à installer sur des hébergement actuels. + +It is written in the PHP scripting language, thus making it trivial to install on any hosting platform in use today comme par exemple [url=http://mediatemple.com/]Media Temple[/url] ou bien [url=http://www.dreamhost.com/r.cgi?455365/]Dreamhost[/url] ou bien encore [url=https://www.linode.com]Linode[/url], [url=http://greenqloud.com]GreenQloud[/url] ou [url=https://aws.amazon.com]Amazon AWS[/url]. Il fonctionne aussi trés bien sur un VPS de OVH. + +En d'autres mots, $Projectname peut tourner sur n'importe quelle plateforme qui a un serveur web, une base de donnée mysql et du php. + + +En plus, $Projectname offre un grand nombre de suppléments : + +[b]Identification en un clic :[/b] cela signifie que vous pouvez accéder à d'autres sits $Projectname simplement en cliquant sur un lien. L'authentificaiton se fera alors automatiquement sans mot de passe. Oubliez le temps ou il vous fallait un grand nom de mot de passe pour aller sur différents sites. + +[b]Clone :[/b] Votre présence en ligne n'a plus besoin d'être faite sur un seul et unique site. Vous pouvez cloner ou importer votre identité (on peut aussi dire votre canal) sur un autre serveur (hub). Si votre serveur principal a des problème et s'arrête, pas de problème, vos contacts, vos messages seront continueront automatiquement à être accessible grĉe à votre canal clone. [i](*: Pour le moment seul les messages sont clonés)[/i] + +[b]Confidentialité :[/b] Votre identité $Projectname (Zot IDs) peut être supprimé, sauvegardé ou cloné. L'utilisateur à le total contrôle sur ses donnés. Et si vous décidez de supprimer totalement votre compte avec tous le contenu, tout ce que vous avez à faire est de cliquer sur le bouton de suppression du compte. C'est immédiat. Aucune question ne vous sera posé sur la raion. Vous être libre de le faire quand vous voulez. + +#include doc/macros/main_footer.bb; diff --git a/doc/fr/git_for_non_developers.bb b/doc/fr/git_for_non_developers.bb new file mode 100644 index 000000000..9e2448e68 --- /dev/null +++ b/doc/fr/git_for_non_developers.bb @@ -0,0 +1,73 @@ +[b]Git pour les non développeurs[/b] + +Bon vous traduivez ou contribuez à un thème et chaque fois que vous faites un pull request, vous devez parler avec un des développeurs avant que vos changements soient pris en compte. + +Vous devez trouver un petit tutorial pour vous aider à maintenair les choses synchronisé. C'est trés facile + + + +After you've created a fork of the repo (just click "fork" at github), you need to clone your own copy. + +For the sake of examples, we'll assume you're working on a theme called redexample (which does not exist). + +[code]git clone https://github.com/username/red.git[/code] + +Once you've done that, cd into the directory, and add an upstream. + +[code] +cd red +git remote add upstream https://github.com/redmatrix/redmatrix +[/code] + +From now on, you can pull upstream changes with the command +[code]git fetch upstream[/code] + +Before your changes can be merged automatically, you will often need to merge upstream changes. + +[code] +git merge upstream/master +[/code] + +You should always merge upstream before pushing any changes, and [i]must[/i] merge upstream with any pull requests to make them automatically mergeable. + +99% of the time, this will all go well. The only time it won't is if somebody else has been editing the same files as you - and often, only if they have been editing the same lines of the same files. If that happens, that would be a good time to request help until you get the hang of handling your own merge conflicts. + +Then you just need to add your changes [code]git add view/theme/redexample/[/code] + +This will add all the files in view/theme/redexample and any subdirectories. If your particular files are mixed throughout the code, you should add one at a time. Try not to do git add -a, as this will add everything, including temporary files (we mostly, but not always catch those with a .gitignore) and any local changes you have, but did not intend to commit. + +Once you have added all the files you have changed, you need to commit them. [code]git commit[/code] + +This will open up an editor where you can describe the changes you have made. Save this file, and exit the editor. + +Finally, push the changes to your own git +[code]git push[/code] + +And that's it, your repo is up to date! + +All you need to do now is actually create the pull request. There are two ways to do this. + +The easy way, if you're using Github is to simply click the green button at the top of your own copy of the repository, enter a description of the changes, and click 'create pull request'. The +main repository, themes, and addons all have their main branch at Github, so this method can be used most of the time. + +Most people can stop here. + +Some projects in the extended RedMatrix ecosphere have no Github presence, to pull request these is a bit different - you'll have to create your pull request manually. Fortunately, this isn't +much harder. + +[code]git request-pull -p <start> <url>[/code] + +Start is the name of a commit to start at. This must exist upstream. Normally, you just want master. + +URL is the URL of [i]your[/i] repo. + +One can also specify <end>. This defaults to HEAD. + +Example: +[code] +git request-pull master https://example.com/project +[/code] + +And simply send the output to the project maintainer. + +#include doc/macros/main_footer.bb; diff --git a/doc/fr/main.bb b/doc/fr/main.bb new file mode 100644 index 000000000..e46d0440a --- /dev/null +++ b/doc/fr/main.bb @@ -0,0 +1,12 @@ + +[zrl=[baseurl]/help/about][b]$Projectname c'est quoi ?[/b][/zrl] +$Projectname est un logiciel de publication et de communication décentralisé qui vous permet de garder le contrôle de vos besoins et de vos données. C'est vous et seulement vous qui décidez qui vous autorisez à voir vos publications. + + +[zrl=[baseurl]/help/features][b]$Projectname fonctionalités[/b][/zrl] +$Projectname est un réseau global distribué qui est souple et peut monter en puissance depuis un petit site d'une personne jusqu'à pouvant héberger une communauté de nombreuses personnes. + +$Projectname fonctionne en tant que réseau global distribué. Il est souple et peut monter en puissance. On peut l'utiliser pour une famille, pour une communauté en ligne, pour des forums, des blogs et des pages web. + +[zrl=[baseurl]/help/what_is_zot][b]Zot c'est quoi ?[/b][/zrl] +Zot est un protocole de communication inventé spécialement pour $Projectname. En tant que membre vous n'êtes plus lié à un site web unique ou à un hub grâce à l'identité nomade. Vous pouvez migrer facilement sur d'autres serveurs et garder vos contacts. Vous pouvez aussi cloner votre cannal et il se trouvera sur plusieurs serveurs. Au cas ou un serveur ne fonctionnerait plus, vous ne perdrez pas vos données. En plus si vous êtes dans $Projectname vous n'aurez plus besoin de vous identifier plusieurs fois même pour accéder à l'autres site $Projectname site. Zot est donc le coeur de $Projectname. diff --git a/doc/hidden_configs.bb b/doc/hidden_configs.bb index 8a02a23f2..0f6c0f635 100644 --- a/doc/hidden_configs.bb +++ b/doc/hidden_configs.bb @@ -3,7 +3,7 @@ $Projectname contains many configuration options hidden from the main admin panel. These are generally options considered too niche, confusing, or advanced for -the average member. These settings can be activated from the the top level Red +the average member. These settings can be activated from the the top level web directory with the syntax [code]util/config cat key value[/code] for a site configuration, or [code]util/pconfig channel_id cat key value[/code] for a member configuration. @@ -11,14 +11,14 @@ member configuration. This document assumes you're an administrator. [b]pconfig[/b] - [b]system > user_scalable[/b] + [b]system.user_scalable[/b] Determine if the app is scalable on touch screens. Defaults to on, to disable, set to zero - real zero, not just false. - [b]system > always_my_theme[/b] + [b]system.always_my_theme[/b] Always use your own theme when viewing channels on the same hub. This will break in some quite imaginative ways when viewing channels with theme dependent Comanche. - [b]system > paranoia[/b] + [b]system.paranoia[/b] Sets the security level of IP checking. If the IP address of a logged-in session changes apply this level to determine if the account should be logged out as a security breach. Options are: @@ -26,151 +26,179 @@ This document assumes you're an administrator. 1 - check 3 octets 2 - check 2 octets 3 - check for any difference at all - [b]system > prevent_tag_hijacking[/b] + [b]system.prevent_tag_hijacking[/b] Prevent foreign networks hijacking hashtags in your posts and directing them at its own resources. - [b]system > blocked[/b] + [b]system.blocked[/b] An array of xchans blocked by this channel. Technically, this is a hidden config and does belong here, however, addons (notably superblock) have made this available in the UI. - [b]system > default_cipher[/b] + [b]system.default_cipher[/b] Set the default cipher used for E2EE items. - [b]system > network_page_default[/b] + [b]system.network_page_default[/b] Set default params when viewing the network page. This should contain the same querystring as manual filtering. - [b]system > display_friend_count[/b] + [b]system.display_friend_count[/b] Set the number of connections to display in the connections profile widget. - [b]system > taganyone[/b] + [b]system.taganyone[/b] Requires the config of the same name to be enabled. Allow the @mention tagging of anyone, whether you are connected or not. This doesn't scale. - [b]system > startpage[/b] + [b]system.startpage[/b] Another of those technically hidden configs made available by addons. Sets the default page to view when logging in. This is exposed to the UI by the startpage addon. - [b]system > forcepublicuploads[/b] + [b]system.forcepublicuploads[/b] Force uploaded photos to be public when uploaded as wall items. It makes far more sense to just set your permissions properly in the first place. Do that instead. - [b]system > do_not_track[/b] + [b]system.do_not_track[/b] As the browser header. This will break many identity based features. You should really just set permissions that make sense. [b]Site config[/b] - [b]system > taganyone[/b] + [b]system.taganyone[/b] Allow the @mention tagging of anyone whether you are connected or not. - [b]system > directorytags[/b] - Set the number of keyword tags displayed on the directory page. - [b]system > startpage[/b] + [b]system.directorytags[/b] + Set the number of keyword tags displayed on the directory page. Default is 50 unless set to a + positive integer. + [b]system.disable_directory_keywords[/b] + If '1', do not show directory keywords. If the hub is a directory server, prevent returning + tags to any directory clients. Please do not set this for directory servers in the RED_GLOBAL realm. + [b]system.disable_dreport[/b] + If '1', don't store or link to delivery reports + [b]system.startpage[/b] Set the default page to be taken to after a login for all channels at this website. Can be overwritten by user settings. - [b]system > projecthome[/b] - Set the project homepage as the homepage of your hub. - [b]system > workflow_channel_next[/b] + [b]system.projecthome[/b] + Set the project homepage as the homepage of your hub. (Obsolete) + [b]system.auto_channel_create[/b] + Add the necessary form elements to create the first channel on the account registration page, and create it + (possibly following email validation or administrator approval). This precludes the ability to import a channel + from another site as the first channel created on this site for a new account. + Use with system.default_permissions_role to streamline registration. + [b]system.default_permissions_role[/b] + If set to a valid permissions role name, use that role for + the first channel created by a new account and don't ask for the "Channel Type" on + the channel creation form. Examples of valid names are: 'social', 'social_restricted', 'social_private', + 'forum', 'forum_restricted' and 'forum_private'. + Read more about permissions roles [zrl=[baseurl]/help/roles]here[/zrl]. + [b]system.workflow_channel_next[/b] The page to direct users to immediately after creating a channel. - [b]system > max_daily_registrations[/b] + [b]system.max_daily_registrations[/b] Set the maximum number of new registrations allowed on any day. Useful to prevent oversubscription after a bout of publicity for the project. - [b]system > tos_url[/b] + [b]system.tos_url[/b] Set an alternative link for the ToS location. - [b]system > block_public_search[/b] + [b]system.block_public_search[/b] Similar to block_public, except only blocks public access to search features. Useful for sites that want to be public, but keep getting hammered by search engines. - [b]system > paranoia[/b] + [b]system.proc_run_use_exec + If 1, use the exec system call in proc_run to run background tasks. By default + we use proc_open and proc_close. On some (currently rare) systems this does not work well. + [b]system.paranoia[/b] As the pconfig, but on a site-wide basis. Can be overwritten by member settings. - [b]system > openssl_conf_file[/b] + [b]system.openssl_conf_file[/b] Specify a file containing OpenSSL configuration. Read the code first. If you can't read the code, don't play with it. - [b]system > optimize_items[/b] + [b]system.optimize_items[/b] Runs optimise_table during some tasks to keep your database nice and defragmented. This comes at a performance cost while the operations are running, but also keeps things a bit faster while it's not. There also exist CLI utilities for performing this operation, which you may prefer, especially if you're a large site. - [b]system > expire_limit + [b]system.expire_limit Don't expire any more than this number of posts per channel per expiration run to keep from exhausting memory. Default 5000. - [b]system > dlogfile[/b] + [b]system.dlogfile[/b] Logfile to use for logging development errors. Exactly the same as logger otherwise. This isn't magic, and requires your own logging statements. Developer tool. - [b]system > authlog[/b] + [b]system.authlog[/b] Logfile to use for logging auth errors. Used to plug in to server side software such as fail2ban. Auth failures are still logged to the main logs as well. - [b]system > hide_in_statistics[/b] + [b]system.hide_in_statistics[/b] Tell the red statistics servers to completely hide this hub in hub lists. - [b]system > reserved_channels[/b] + [b]system.reserved_channels[/b] Don't allow members to register channels with this comma separated list of names (no spaces) - [b]system > auto_follow[/b] + [b]system.auto_follow[/b] Make the first channel of an account auto-follow channels listed here - comma separated list of webbies (member@hub addresses). - [b]system > admin_email[/b] + [b]system.admin_email[/b] Specifies the administrator's email for this site. This is initially set during install. - [b]system > cron_hour[/b] + [b]system.cron_hour[/b] Specify an hour in which to run cron_daily. By default with no config, this will run at midnight UTC. - [b]system > minimum_feedcheck_minutes[/b] + [b]system.minimum_feedcheck_minutes[/b] The minimum interval between polling RSS feeds. If this is lower than the cron interval, feeds will be polled with each cronjob. Defaults to 60 if not set. The site setting can also be over-ridden on a channel by channel basis by a service class setting aptly named 'minimum_feedcheck_minutes'. - [b]system > blacklisted_sites[/b] + [b]system.blacklisted_sites[/b] An array of specific hubs to block from this hub completely. - [b]system > ignore_imagick[/b] + [b]system.ignore_imagick[/b] Ignore imagick and use GD, even if imagick is installed on the server. Prevents some issues with PNG files in older versions of imagick. - [b]system > no_age_restriction[/b] + [b]system.no_age_restriction[/b] Do not restrict registration to people over the age of 13. This carries legal responsibilities in many countries to require that age be provided and to block all personal information from minors, so please check your local laws before changing. - [b]system > override_poll_lockfile[/b] + [b]system.override_poll_lockfile[/b] Ignore the lock file in the poller process to allow more than one process to run at a time. - [b]system > projecthome[/b] + [b]system.projecthome[/b] Display the project page on your home page for logged out viewers. - [b]system > sellpage[/b] + [b]system.sellpage[/b] A URL shown in the public sites list to sell your hub - display service classes, etc. - [b]randprofile > check[/b] + [b]randprofile.check[/b] When requesting a random profile, check that it actually exists first - [b]randprofile > retry[/b] + [b]randprofile.retry[/b] Number of times to retry getting a random profile - [b]system > photo_cache_time[/b] + [b]system.photo_cache_time[/b] How long to cache photos, in seconds. Default is 86400 (1 day). Longer time increases performance, but it also means it takes longer for changed permissions to apply. - [b]system > poco_rating_enable[/b] + [b]system.poco_rating_enable[/b] Distributed reputation reporting and data collection may be disabled. If your site does not participate in distributed reputation you will also not be able to make use of the data from your connections on other sites. By default and in the absence of any setting it is enabled. Individual members can opt out by restricting who can see their connections or by not providing any reputation information for their connections. - [b]system > register_link[/b] + [b]system.register_link[/b] path to direct to from the "register" link on the login form. On closed sites this will direct to 'pubsites'. For open sites it will normally redirect to 'register' but you may change this to a custom site page offering subscriptions or whatever. - [b]system > max_import_size[/b] + [b]system.max_import_size[/b] If configured, the maximum length of an imported text message. This is normally left at 200Kbytes or more to accomodate Friendica private photos, which are embedded. - [b]system > tempdir[/b] - Place to store temporary files, default is defined in the PHP configuration - [b]system > uploaddir[/b] - Location to upload files (default is system.tempdir) - [b]system > disable_discover_tab[/b] + [b]system.tempdir[/b] + Place to store temporary files (currently unused), default is defined in the PHP configuration + [b]system.uploaddir[/b] + Location to upload files (default is system.tempdir, currently used only by js_upload plugin) + [b]system.disable_discover_tab[/b] This allows you to completely disable the ability to discover public content from external sites. - [b]system > sys_expire_days[/b] + [b]system.sys_expire_days[/b] How many days to keep discovered public content from other sites - [b]system > openssl_encrypt[/b] + [b]system.openssl_encrypt[/b] Use openssl encryption engine, default is false (uses mcrypt for AES encryption) - [b]system > max_tagged_forums[/b] + [b]system.max_tagged_forums[/b] Spam prevention. Limits the number of tagged forums which are recognised in any post. Default is 2. Only the first 'n' tags will be delivered as forums, the others will not cause any delivery. - [b]system > openssl_conf_file[/b] + [b]system.openssl_conf_file[/b] Needed in some Windows installations to locate the openssl configuration file on the system. - [b]system > hide_help[/b] + [b]system.hide_help[/b] Don't display help documentation link in nav bar - [b]system > expire_delivery_reports[/b] - Expiration in days for delivery reports - default 30 + [b]system.expire_delivery_reports[/b] + Expiration in days for delivery reports - default 10 + [b]system.platform_name[/b] * + What to report as the platform name in webpages and statistics. (*) Must be set in .htconfig.php + [b]system.hide_version[/b] * + If true, do not report the software version on webpages and tools. (*) Must be set in .htconfig.php + [b]system.hidden_version_siteinfo[/b] + If true, do not report the software version on siteinfo pages (system.hide_version also hides the version on these pages, this setting *only* hides the version on siteinfo pages). + [b]system.email_notify_icon_url[/b] + URL of image (32x32) to display in email notifications (HTML bodies). [b]Directory config[/b] [b]Directory search defaults[/b] - [b]directory > safemode[/b] + [b]directory.safemode[/b] 0 or 1. - [b]directory > globaldir[/b] + [b]directory.globaldir[/b] 0 or 1. Default 0. If you visit the directory on a site you'll just see the members of that site by default. You have to go through an extra step to see the people in the rest of the network; and by doing so there's a clear delineation that these people *aren't* members of that site but of a larger network. - [b]directory > pubforums[/b] + [b]directory.pubforums[/b] 0 or 1. Public forums *should* be default 0. [b]Directory server configuration (see [zrl=[baseurl]/help/directories]help/directories[/zrl])[/b] - [b]system > directory_server[/b] - [b]system > directory_primary[/b] - [b]system > directory_realm[/b] - [b]system > realm_token[/b] - [b]system > directory_mode[/b] + [b]system.directory_server[/b] + [b]system.directory_primary[/b] + [b]system.directory_realm[/b] + [b]system.realm_token[/b] + [b]system.directory_mode[/b] diff --git a/doc/roles.md b/doc/roles.md index 5d8d07113..a7608ff90 100644 --- a/doc/roles.md +++ b/doc/roles.md @@ -11,11 +11,11 @@ The channel is a typical social networking profile. By default posts and publish **Restricted** -By default all posts and published items are sent to your 'Friends' collection and not made public. New friends are added to this collection. You can over-ride this and create a public post or published item if you desire. You are listed in the directory. Your online presence (for chat) and your connections (friends) are visible to your profile viewers. +By default all posts and published items are sent to your 'Friends' privacy group and not made public. New friends are added to this privacy group. You can over-ride this and create a public post or published item if you desire. You are listed in the directory. Your online presence (for chat) and your connections (friends) are visible to your profile viewers. **Private** -By default all posts and published items are sent to your 'Friends' collection. New friends are added to this collection. You can over-ride this and create a public post or public item if you desire. You are NOT listed in the directory. Only your connections can see your other connections. Your online presence is hidden. +By default all posts and published items are sent to your 'Friends' privacy group. New friends are added to this privacy group. You can over-ride this and create a public post or public item if you desire. You are NOT listed in the directory. Only your connections can see your other connections. Your online presence is hidden. ##Forum @@ -27,11 +27,11 @@ The channel is a typical forum. By default posts and published items are public. **Restricted** -By default all posts and published items are sent to the channel's 'Friends' collection. New friends are added to this collection. Members may post by @mention+ or wall-to-wall post, but posts and replies may also be seen by other receipients of the top-level post who are not members. The channel is visible in the directory. Members must be manually added by the forum owner. +By default all posts and published items are sent to the channel's 'Friends' privacy group. New friends are added to this privacy group. Members may post by @mention+ or wall-to-wall post, but posts and replies may also be seen by other receipients of the top-level post who are not members. The channel is visible in the directory. Members must be manually added by the forum owner. **Private** -By default all posts and published items are sent to your 'Friends' collection. New friends are added to this collection. The owner can over-ride this and create a public post or public item if desired. Members cannot. You are NOT listed in the directory. Only your connections can see your other connections. Your online presence is hidden. Members must be manually added by the forum owner. Posting by @mention+ is disabled. Posts can only be made via wall-to-wall posts, and sent to members of the 'Friends' collection. They are not publicly visible. +By default all posts and published items are sent to your 'Friends' privacy group. New friends are added to this privacy group. The owner can over-ride this and create a public post or public item if desired. Members cannot. You are NOT listed in the directory. Only your connections can see your other connections. Your online presence is hidden. Members must be manually added by the forum owner. Posting by @mention+ is disabled. Posts can only be made via wall-to-wall posts, and sent to members of the 'Friends' privacy group. They are not publicly visible. ##Feed @@ -44,7 +44,7 @@ Similiar to Social - Mostly Public, but tailored for RSS feed sources. Items may **Restricted** -Not listed in directory. Online presence is meaningless, therefore hidden. Feed is published only to members of the 'Friends' collection. New connections are automatically added to this collections. Members must be manually approved by the channel owner. +Not listed in directory. Online presence is meaningless, therefore hidden. Feed is published only to members of the 'Friends' privacy group. New connections are automatically added to this privacy group. Members must be manually approved by the channel owner. ##Special diff --git a/doc/tags_and_mentions.bb b/doc/tags_and_mentions.bb index d638492bb..29dfe0fbe 100644 --- a/doc/tags_and_mentions.bb +++ b/doc/tags_and_mentions.bb @@ -31,9 +31,9 @@ Some connections in the mention auto-complete box behave differently than others [b]Private Mentions[/b]
-If you wish to restrict a post to a single person or a number of people, you can do this by selecting channels or collections from the privacy tool. You can also just tag them with a privacy tag. A privacy tag is a name preceded by the two characters @! - and in addition to tagging these channels, will also change the privacy permissions of the post to only include them. You can have more than one privacy tag, for instance @!bob and @!linda will send the post only to Bob and Linda. This mechanism over-rides the privacy selector.
+If you wish to restrict a post to a single person or a number of people, you can do this by selecting channels or privacy groups from the privacy tool. You can also just tag them with a privacy tag. A privacy tag is a name preceded by the two characters @! - and in addition to tagging these channels, will also change the privacy permissions of the post to only include them. You can have more than one privacy tag, for instance @!bob and @!linda will send the post only to Bob and Linda. This mechanism over-rides the privacy selector.
-You may also tag public collections. When you create or edit a collection, there is a checkbox to allow the group members to be seen by others. If this box is checked for a collection and you tag (for instance) @!Friends - the post will be restricted to the Friends collection. Check that the collection is public before doing this - as there is no way to take back a post except to delete it. The collection name will appear in the post and will alert members of that collection that they are members of it.
+You may also tag privacy groups which are "public". When you create or edit a privacy group, there is a checkbox to allow the group members to be seen by others. If this box is checked for a group and you tag (for instance) @!Friends - the post will be restricted to the Friends group. Check that the group is public before doing this - as there is no way to take back a post except to delete it. The group name will appear in the post and will alert members of that group that they are members of it.
[b]Mentions and Comments[/b]
diff --git a/doc/to_do_code.bb b/doc/to_do_code.bb index 57f4b2e01..85c5997cb 100644 --- a/doc/to_do_code.bb +++ b/doc/to_do_code.bb @@ -8,7 +8,6 @@ We need much more than this, but here are areas where developers can help. Pleas [li]SAML 2.0 and OpenID Connect provider functionality[/li]
[li]Create bug tracker module[/li]
[li]Filing posts - provide a dropdown menu integrated with the 'post actions menu'[/li]
-[li]integrate Mozilla Persona (possibly via plugin) https://github.com/mozilla/id-specs/blob/prod/browserid/index.md and become an idP[/li]
[li]translation plugins - moses or apertium[/li]
[li]plugins - provide 'disable' which is softer than 'uninstall' for those plugins which create additional DB tables[/li]
[li]Infinite scroll improvements (i.e. embedded page links) see http://scrollsample.appspot.com/items [/li]
@@ -20,7 +19,6 @@ We need much more than this, but here are areas where developers can help. Pleas [li]Support comments on webpages[/li]
[li]implement oembed provider interface[/li]
[li]refactor the oembed client interface so that we can safely sandbox remote content[/li]
-[li]Many modern social apps now have both a profile photo and a "cover photo". Add support for this. [/li]
[li]Write more webpage layouts[/li]
[li]Write more webpage widgets[/li]
[li]restricted access OAuth clients[/li]
@@ -40,7 +38,6 @@ We need much more than this, but here are areas where developers can help. Pleas [li]App taxonomy[/li]
[li]Customisable App collection pages[/li]
[li]replace the tinymce visual editor and/or make the visual editor pluggable and responsive to different output formats. We probably want library/bbedit for bbcode. This needs a fair bit of work to catch up with our "enhanced bbcode", but start with images, links, bold and highlight and work from there.[/li]
-[li]Photos module - turn photos into normal conversations and fix tagging[/li]
[li]Create mobile clients for the top platforms - which involves extending the API so that we can do stuff far beyond the current crop of Twitter/Statusnet clients. Ditto for mobile themes. We can probably use something like the Friendica Android app as a base to start from.[/li]
[li](in progress Habeas Codice) Implement owned and exchangeable "things".[/li]
[li]Family Account creation - using service classes (an account holder can create a certain number of sub-accounts which are all tied to their subscription - if the subscription lapses they all go away).[/li]
|