doc/Settings.md

   1 Settings
   2 ===
   3 Here are some of the built-in features which don't have an exposed interface or are otherwise undocumented.
   4 Configuration settings are stored in the file ".htconfig.php".
   5 Edit this file with a text editor to make the desired changes.
   6 Several system settings are already documented in that file and will not be covered here.
   7
   8 Hot Keys
   9 ---
  10
  11 Friendica traps the following keyboard events:
  12
  13 * [Pause] - Pauses "Ajax" update activity. This is the process that provides updates without reloading the page. You may wish to pause it to reduce network usage and/or as a debugging aid for javascript developers. A pause indicator will appear at the lower right hand corner of the page. Hit the [pause] key once again to resume.
  14 * [F8] - Displays a language selector
  15
  16
  17 Birthday Notifications
  18 ---
  19
  20 Birthday events are published on your Home page for any friends having a birthday in the coming 6 days.
  21 In order for your birthday to be discoverable by all of your friends, you must set your birthday (at least the month and day) in your default profile.
  22 You are not required to provide the year.
  23
  24 System settings
  25 ---
  26
  27 ###Language
  28
  29 Please see util/README for information on creating language translations.
  30
  31 Config:
  32
  33         $a->config['system']['language'] = 'name';
  34
  35 ###System Theme
  36
  37 Choose a theme to be the default system theme. This can be over-ridden by user profiles.
  38 Default theme is "default".
  39
  40 Config:
  41
  42         $a->config['system']['theme'] = 'theme-name';
  43
  44 ###Proxy Configuration Settings
  45
  46 If your site uses a proxy to connect to the internet, you may use these settings to communicate with the outside world.
  47 The outside world still needs to be able to see your website, or this will not be very useful.
  48
  49 Config:
  50
  51         $a->config['system']['proxy'] = "http://proxyserver.domain:port";
  52         $a->config['system']['proxyuser'] = "username:password";
  53
  54 ###Network Timeout
  55
  56 How long to wait on a network communication before timing out.
  57 Value is in seconds.
  58 Default is 60 seconds.
  59 Set to 0 for unlimited (not recommended).
  60
  61 Config:
  62
  63         $a->config['system']['curl_timeout'] = 60;
  64
  65 ###Banner/Logo
  66
  67 Set the content for the site banner.
  68 The default logo is the Friendica logo and name.
  69 You may wish to provide HTML/CSS to style and/or position this content, as it may not be themed by default.
  70
  71 Config:
  72
  73         $a->config['system']['banner'] = '<span id="logo-text">My Great Website</span>';
  74
  75 ###Maximum Image Size
  76
  77 Maximum size in bytes of uploaded images.
  78 The default is set to 0, which means no limits.
  79
  80 Config:
  81
  82         $a->config['system']['maximagesize'] = 1000000;
  83
  84 ###UTF-8 Regular Expressions
  85
  86 During registrations, full names are checked using UTF-8 regular expressions.
  87 This requires PHP to have been compiled with a special setting to allow UTF-8 expressions.
  88 If you are completely unable to register accounts, set no_utf to true.
  89 The default is set to false (meaning UTF8 regular expressions are supported and working).
  90
  91 Config:
  92
  93         $a->config['system']['no_utf'] = true;
  94
  95 ###Check Full Names
  96
  97 You may find a lot of spammers trying to register on your site.
  98 During testing we discovered that since these registrations were automatic, the "Full Name" field was often set to just an account name with no space between first and last name.
  99 If you would like to support people with only one name as their full name, you may change this setting to true.
 100 Default is false.
 101
 102 Config:
 103
 104         $a->config['system']['no_regfullname'] = true;
 105
 106 ###OpenID
 107
 108 By default, OpenID may be used for both registration and logins.
 109 If you do not wish to make OpenID facilities available on your system (at all), set 'no_openid' to true.
 110 Default is false.
 111
 112 Config:
 113
 114         $a->config['system']['no_openid'] = true;
 115
 116 ###Multiple Registrations
 117
 118 The ability to create "Pages" requires a person to register more than once.
 119 Your site configuration can block registration (or require approval to register).
 120 By default, logged in users can register additional accounts for use as pages.
 121 These will still require approval if REGISTER_APPROVE is selected.
 122 You may prohibit logged in users from creating additional accounts by setting 'block_extended_register' to true.
 123 Default is false.
 124
 125 Config:
 126
 127         $a->config['system']['block_extended_register'] = true;
 128
 129 Security settings
 130 ---
 131
 132 ###Verify SSL Certitificates
 133
 134 By default Friendica allows SSL communication between websites that have "self-signed" SSL certificates.
 135 For the widest compatibility with browsers and other networks we do not recommend using self-signed certificates, but we will not prevent you from using them.
 136 SSL encrypts all the data transmitted between sites (and to your browser). This allows you to have completely encrypted communications, and also protect your login session from hijacking.
 137 Self-signed certificates can be generated for free, without paying top-dollar for a website SSL certificate.
 138 However these aren't looked upon favourably in the security community because they can be subject to so-called "man-in-the-middle" attacks.
 139 If you wish, you can turn on strict certificate checking.
 140 This will mean you cannot connect (at all) to self-signed SSL sites.
 141
 142 Config:
 143
 144         $a->config['system']['verifyssl'] = true;
 145
 146 Corporate/Edu enhancements
 147 ---
 148
 149 ###Allowed Friend Domains
 150
 151 Comma separated list of domains which are allowed to establish friendships with this site.
 152 Wildcards are accepted.
 153 (Wildcard support on Windows platforms requires PHP5.3).
 154 By default, any (valid) domain may establish friendships with this site.
 155
 156 Config:
 157
 158         $a->config['system']['allowed_sites'] = "sitea.com, *siteb.com";
 159
 160 ###Allowed Email Domains
 161
 162 Comma separated list of domains which are allowed in email addresses for registrations to this site.
 163 This can lockout those who are not part of this organisation from registering here.
 164 Wildcards are accepted.
 165 (Wildcard support on Windows platforms requires PHP5.3).
 166 By default, any (valid) email address is allowed in registrations.
 167
 168 Config:
 169
 170         $a->config['system']['allowed_email'] = "sitea.com, *siteb.com";
 171
 172 ###Block Public
 173
 174 Set to true to block public access to all otherwise public personal pages on this site unless you are currently logged in.
 175 This blocks the viewing of profiles, friends, photos, the site directory and search pages to unauthorised persons.
 176 A side effect is that entries from this site will not appear in the global directory.
 177 We recommend specifically disabling that also (setting is described elsewhere on this page).
 178 Note: this is specifically for sites that desire to be "standalone" and do not wish to be connected to any other Friendica sites.
 179 Unauthorised persons will also not be able to request friendship with site members.
 180 Default is false.
 181 Available in version 2.2 or greater.
 182
 183 Config:
 184
 185         $a->config['system']['block_public'] = true;
 186
 187 ###Force Publish
 188
 189 By default, each user can choose on their Settings page whether or not to have their profile published in the site directory.
 190 This setting forces all profiles on this site to be listed in the site directory and there is no option provided to the user to change it.
 191 Default is false.
 192
 193 Config:
 194
 195         $a->config['system']['publish_all'] = true;
 196
 197 ###Global Directory
 198
 199 This configures the URL to update the global directory, and is supplied in the default configuration.
 200 The undocumented part is that if this is not set, the global directory is completely unavailable to the application.
 201 This allows a private community to be completely isolated from the global network.
 202
 203         $a->config['system']['directory'] = 'http://dir.friendi.ca';
 204
 205 Developer Settings
 206 ---
 207
 208 ### Debugging
 209 Most useful when debugging protocol exchanges and tracking down other communications issues.
 210
 211 Config:
 212
 213         $a->config['system']['debugging'] = true;
 214         $a->config['system']['logfile'] = 'logfile.out';
 215         $a->config['system']['loglevel'] = LOGGER_DEBUG;
 216
 217 Turns on detailed debugging logs which will be stored in 'logfile.out' (which must be writeable by the webserver).
 218 LOGGER_DEBUG will show a good deal of information about system activity but will not include detailed data.
 219 You may also select LOGGER_ALL but due to the volume of information we recommend only enabling this when you are tracking down a specific problem.
 220 Other log levels are possible but are not being used at the present time.
 221
 222
 223 ###PHP error logging
 224
 225 Use the following settings to redirect PHP errors to a file.
 226
 227 Config:
 228
 229         error_reporting(E_ERROR | E_WARNING | E_PARSE );
 230         ini_set('error_log','php.out');
 231         ini_set('log_errors','1');
 232         ini_set('display_errors', '0');
 233
 234 This will put all PHP errors in the file php.out (which must be writeable by the webserver).
 235 Undeclared variables are occasionally referenced in the program and therefore we do not recommend using E_NOTICE or E_ALL.
 236 The vast majority of issues reported at these levels are completely harmless.
 237 Please report to the developers any errors you encounter in the logs using the recommended settings above.
 238 They generally indicate issues which need to be resolved.
 239
 240 If you encounter a blank (white) page when using the application, view the PHP logs - as this almost always indicates an error has occurred.