diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/database.bb | 9 | ||||
| -rw-r--r-- | doc/hidden_configs.bb | 34 | ||||
| -rw-r--r-- | doc/hook/activity_decode_mapper.bb | 1 | ||||
| -rw-r--r-- | doc/hook/activity_mapper.bb | 1 | ||||
| -rw-r--r-- | doc/hook/activity_obj_decode_mapper.bb | 1 | ||||
| -rw-r--r-- | doc/hook/activity_obj_mapper.bb | 1 | ||||
| -rw-r--r-- | doc/hook/comments_are_now_closed.bb | 11 | ||||
| -rw-r--r-- | doc/hook/encode_object.bb | 1 | ||||
| -rw-r--r-- | doc/hook/fetch_and_store.bb | 1 | ||||
| -rw-r--r-- | doc/hooklist.bb | 21 | ||||
| -rw-r--r-- | doc/toc.html | 3 |
11 files changed, 75 insertions, 9 deletions
diff --git a/doc/database.bb b/doc/database.bb index a72081e4a..a0c1e8841 100644 --- a/doc/database.bb +++ b/doc/database.bb @@ -1,3 +1,12 @@ +[h2]Database updates[/h2] + +In the [observer.baseurl]/admin/dbsync page the administrator can check if any update was not successful and, if so, retry it. + +If an update has failed but doesn't register as failed for some reason, the administrator can attempt to re-execute the update. For example for DB update #1999, by visiting the webpage: + +https://hubzilla.com.bradmin/dbsync/1999 + + [h2]Database Tables[/h2][table border=1][tr][th]Table[/th][th]Description[/th][/tr] [tr][td][zrl=[baseurl]/help/database/db_abconfig]abconfig[/zrl][/td][td]arbitrary storage for connections of local channels[/td][/tr] [tr][td][zrl=[baseurl]/help/database/db_abook]abook[/zrl][/td][td]connections of local channels[/td][/tr] diff --git a/doc/hidden_configs.bb b/doc/hidden_configs.bb index dc3906df1..37c2a4cb6 100644 --- a/doc/hidden_configs.bb +++ b/doc/hidden_configs.bb @@ -1,7 +1,10 @@ [h1]Advanced Configurations for Administrators[/h1] -$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 web directory with the syntax +[i]This document assumes you're an administrator.[/i] + +$Projectname contains many configuration options hidden from the main admin panel. These are generally options considered too niche, advanced or prone do confusion. + +These settings can be modified through the shell, from the the top level web directory, with the syntax: [code]util/config cat key value[/code] for a site configuration, or @@ -9,8 +12,13 @@ for a site configuration, or [code]util/pconfig channel_id cat key value[/code] for a member configuration. -This document assumes you're an administrator. -[h2]pconfig[/h2][dl terms="mb"] +For a site configuration, another option is to add a line to .htconfig.php, with the syntax: +[code]App::$config['cat']['key'] = 'value';[/code] + + +[h2]Member configuration (pconfig)[/h2] + +[dl terms="mb"] [*= system.always_my_theme ] 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. [*= system.blocked ] 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. [*= system.default_cipher ] Set the default cipher used for E2EE items. @@ -31,7 +39,10 @@ Options are: [*= system.anonymous_comments ] By default or if set to 1, custom permissions can be set to allow anonymous (moderated) comments like WordPress, moderated by the channel owner. If set to 0, no member of your site can select or enable this. [*= system.user_scalable ] Determine if the app is scalable on touch screens. Defaults to on, to disable, set to zero - real zero, not just false. [/dl] -[h2]Site config[/h2][dl terms="mb"] + +[h2]Site configuration[/h2] + +[dl terms="mb"] [*= randprofile.check ] When requesting a random profile, check that it actually exists first [*= randprofile.retry ] Number of times to retry getting a random profile [*= system.admin_email ] Specifies the administrator's email for this site. This is initially set during install. @@ -62,6 +73,7 @@ Options are: [*= system.max_tagged_forums ] 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. [*= system.minimum_feedcheck_minutes ] 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'. [*= system.no_age_restriction ] 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. + [*= system.object_cache_days] Set how long is cached embedded content can be used without refetching. Default is 30 days. [*= system.openssl_conf_file ] Specify a file containing OpenSSL configuration. Needed in some Windows installations to locate the openssl configuration file on the system. Read the code first. If you can't read the code, don't play with it. [*= system.openssl_encrypt ] Use openssl encryption engine, default is false (uses mcrypt for AES encryption) [*= system.optimize_items ] 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. @@ -87,13 +99,19 @@ Options are: [*= system.workflow_channel_next ] The page to direct new members to immediately after creating a channel. [*= system.workflow_register_next ] The page to direct members to immediately after creating an account (only when auto_channel_create or UNO is enabled). [/dl] -[h2]Directory config[/h2] -[h3]Directory search defaults[/h3][dl terms="mb"] + + +[h3]Directory config[/h3] + +[h4]Directory search defaults[/h4] + +[dl terms="mb"] [*= directory.globaldir ] 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. [*= directory.pubforums ] 0 or 1. Public forums [i]should[/i] be default 0. [*= directory.safemode ] 0 or 1. [/dl] -[h3]Directory server configuration[/h3][i](see [zrl=[baseurl]/help/directories]help/directories[/zrl])[/i] + +[h4]Directory server configuration[/h4][i](see [zrl=[baseurl]/help/directories]help/directories[/zrl])[/i] [dl terms="mb"] [*= system.directory_mode ] diff --git a/doc/hook/activity_decode_mapper.bb b/doc/hook/activity_decode_mapper.bb new file mode 100644 index 000000000..43d08a136 --- /dev/null +++ b/doc/hook/activity_decode_mapper.bb @@ -0,0 +1 @@ +[h2]activity_decode_mapper[/h2] diff --git a/doc/hook/activity_mapper.bb b/doc/hook/activity_mapper.bb new file mode 100644 index 000000000..db65fadc4 --- /dev/null +++ b/doc/hook/activity_mapper.bb @@ -0,0 +1 @@ +[h2]activity_mapper[/h2] diff --git a/doc/hook/activity_obj_decode_mapper.bb b/doc/hook/activity_obj_decode_mapper.bb new file mode 100644 index 000000000..a96b32eee --- /dev/null +++ b/doc/hook/activity_obj_decode_mapper.bb @@ -0,0 +1 @@ +[h2]activity_obj_decode_mapper[/h2] diff --git a/doc/hook/activity_obj_mapper.bb b/doc/hook/activity_obj_mapper.bb new file mode 100644 index 000000000..7c14a1b81 --- /dev/null +++ b/doc/hook/activity_obj_mapper.bb @@ -0,0 +1 @@ +[h2]activity_obj_mapper[/h2] diff --git a/doc/hook/comments_are_now_closed.bb b/doc/hook/comments_are_now_closed.bb new file mode 100644 index 000000000..4d3baa95a --- /dev/null +++ b/doc/hook/comments_are_now_closed.bb @@ -0,0 +1,11 @@ +[h3]comments_are_now_closed[/h3] + +Called when deciding whether or not commenting is closed for an item. + + +Hook data (array): + item => posted item + closed => 'unset' + + +To over-ride the default behaviour, change closed to true or false diff --git a/doc/hook/encode_object.bb b/doc/hook/encode_object.bb new file mode 100644 index 000000000..0c8e86458 --- /dev/null +++ b/doc/hook/encode_object.bb @@ -0,0 +1 @@ +[h2]encode_object[/h2] diff --git a/doc/hook/fetch_and_store.bb b/doc/hook/fetch_and_store.bb new file mode 100644 index 000000000..afece11a6 --- /dev/null +++ b/doc/hook/fetch_and_store.bb @@ -0,0 +1 @@ +[h2]fetch_and_store[/h2] diff --git a/doc/hooklist.bb b/doc/hooklist.bb index 5a804c819..a923e7ae3 100644 --- a/doc/hooklist.bb +++ b/doc/hooklist.bb @@ -34,6 +34,18 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/activity_filter]activity_filter[/zrl] Called when generating the list of filters for the network page +[zrl=[baseurl]/help/hook/activity_filter]activity_mapper[/zrl] + Called when determining the activity type for transmission. + +[zrl=[baseurl]/help/hook/activity_filter]activity_decode_mapper[/zrl] + Called when determining the activity type for transmission. + +[zrl=[baseurl]/help/hook/activity_filter]activity_obj_mapper[/zrl] + Called when determining the object type for transmission. + +[zrl=[baseurl]/help/hook/activity_filter]activity_obj_decode_mapper[/zrl] + Called when determining the object type for transmission. + [zrl=[baseurl]/help/hook/activity_order]activity_order[/zrl] Called when generating the list of order options for the network page @@ -142,6 +154,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/comment_buttons]comment_buttons[/zrl] Called when rendering the edit buttons for comments +[zrl=[baseurl]/help/hook/comments_are_now_closed]comments_are_now_closed[/zrl] + Called when deciding whether or not to present a comment box for a post + [zrl=[baseurl]/help/hook/connect_premium]connect_premium[/zrl] Called when connecting to a premium channel @@ -232,6 +247,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/drop_item]drop_item[/zrl] called when an 'item' is removed +[zrl=[baseurl]/help/hook/encode_object]encode_object[/zrl] + called when encoding an object for transmission. + [zrl=[baseurl]/help/hook/enotify]enotify[/zrl] called before any notification @@ -262,6 +280,9 @@ Hooks allow plugins/addons to "hook into" the code at many points and alter the [zrl=[baseurl]/help/hook/feature_settings_post]feature_settings_post[/zrl] called from settings page when posting from 'addon/feature settings' +[zrl=[baseurl]/help/hook/fetch_and_store]fetch_and_store[/zrl] + called to allow filtering of 'decoded' items before storage. + [zrl=[baseurl]/help/hook/file_thumbnail]file_thumbnail[/zrl] called when generating thumbnail images for cloud page in 'view tiles' mode diff --git a/doc/toc.html b/doc/toc.html index 9c3d22ab8..d2f2654a1 100644 --- a/doc/toc.html +++ b/doc/toc.html @@ -37,7 +37,8 @@ <div class="flex-column"> <a class="nav-link" href="/help/admin/administrator_guide">Guide</a> <a class="nav-link" href="/help/admin/hub_snapshots">Hub Snapshots</a> - <a class="nav-link" href="/help/database">Database Tables</a> + <a class="nav-link" href="/help/database">Database</a> + <a class="nav-link" href="/help/hidden_configs">Extra configs</a> </div> </div> </div> |