diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/addons.bb | 19 | ||||
| -rw-r--r-- | doc/hidden_configs.bb | 151 | ||||
| -rw-r--r-- | doc/to_do_code.bb | 3 |
3 files changed, 100 insertions, 73 deletions
diff --git a/doc/addons.bb b/doc/addons.bb index a6d2cfc2f..6152089f9 100644 --- a/doc/addons.bb +++ b/doc/addons.bb @@ -1,19 +1,23 @@ [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 +30,15 @@ [*] 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 +[*] 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/hidden_configs.bb b/doc/hidden_configs.bb index b3ad91aa9..c07d6ca01 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,157 +26,172 @@ 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] + [b]system.directorytags[/b] Set the number of keyword tags displayed on the directory page. - [b]system > disable_dreport[/b] + [b]system.disable_dreport[/b] If '1', don't store or link to delivery reports - [b]system > startpage[/b] + [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 > default_permissions_role[/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 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.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] + [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/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]
|