clones/friendica
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improved doc formatting

This commit is contained in:
Hypolite Petovan 2016-10-24 11:57:25 -04:00
parent d0b95e642f
commit 8da5a23267
1 changed files with 13 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/htconfig.md
View File

@ -1,20 +1,19 @@
Config values that can only be set in .htconfig.php Config values that can only be set in .htconfig.php
=================================================== ===================================================
There are some config values that haven't found their way into the administration page. This has several reasons. Maybe they are part of a There are some config values that haven't found their way into the administration page.
current development that isn't considered stable and will be added later in the administration page when it is considered safe. Or it triggers This has several reasons.
something that isn't expected to be of public interest. Or it is for testing purposes only. Maybe they are part of a current development that isn't considered stable and will be added later in the administration page when it is considered safe.
Or it triggers something that isn't expected to be of public interest. Or it is for testing purposes only.
**Attention:** Please be warned that you shouldn't use one of these values without the knowledge what it could trigger. Especially don't do that with **Attention:** Please be warned that you shouldn't use one of these values without the knowledge what it could trigger.
undocumented values. Especially don't do that with undocumented values.
The header of the section describes the category, the value is the parameter. Example: To set the directory value please add this The header of the section describes the category, the value is the parameter.
line to your .htconfig.php: Example: To set the directory value please add this line to your .htconfig.php:
$a->config['system']['directory'] = 'http://dir.friendi.ca'; $a->config['system']['directory'] = 'http://dir.friendi.ca';
## Jabber ## ## Jabber ##
* debug (Boolean) - Enable debug level for the jabber account synchronisation. * debug (Boolean) - Enable debug level for the jabber account synchronisation.
* logfile - Logfile for the jabber account synchronisation. * logfile - Logfile for the jabber account synchronisation.
@ -48,7 +47,7 @@ line to your .htconfig.php:
* ostatus_poll_timeframe - Defines how old an item can be to try to complete the conversation with it. * ostatus_poll_timeframe - Defines how old an item can be to try to complete the conversation with it.
* paranoia (Boolean) - Log out users if their IP address changed. * paranoia (Boolean) - Log out users if their IP address changed.
* permit_crawling (Boolean) - Restricts the search for not logged in users to one search per minute. * permit_crawling (Boolean) - Restricts the search for not logged in users to one search per minute.
* profiler (Boolean) - Enable internal timings to help optimize code. Default is false. * profiler (Boolean) - Enable internal timings to help optimize code. Needed for "rendertime" addon. Default is false.
* free_crawls - Number of "free" searches when "permit_crawling" is activated (Default value is 10) * free_crawls - Number of "free" searches when "permit_crawling" is activated (Default value is 10)
* crawl_permit_period - Period in seconds between allowed searches when the number of free searches is reached and "permit_crawling" is activated (Default value is 60) * crawl_permit_period - Period in seconds between allowed searches when the number of free searches is reached and "permit_crawling" is activated (Default value is 60)
* png_quality - Default value is 8. * png_quality - Default value is 8.
@ -85,19 +84,15 @@ line to your .htconfig.php:
# Administrator Options # # Administrator Options #
Enabling the admin panel for an account, and thus making the account holder Enabling the admin panel for an account, and thus making the account holder admin of the node, is done by setting the variable
admin of the node, is done by setting the variable
$a->config['admin_email'] = "someone@example.com"; $a->config['admin_email'] = "someone@example.com";
where you have to match the email address used for the account with the one you Where you have to match the email address used for the account with the one you enter to the .htconfig file.
enter to the .htconfig file. If more then one account should be able to access If more then one account should be able to access the admin panel, seperate the email addresses with a comma.
the admin panel, seperate the email addresses with a comma.
$a->config['admin_email'] = "someone@example.com,someonelese@example.com"; $a->config['admin_email'] = "someone@example.com,someonelese@example.com";
If you want to have a more personalized closing line for the notification If you want to have a more personalized closing line for the notification emails you can set a variable for the admin_name.
emails you can set a variable for the admin_name.
$a->config['admin_name'] = "Marvin"; $a->config['admin_name'] = "Marvin";