CONFIGURE 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807
  1. Configuration options
  2. =====================
  3. The main configuration file for StatusNet (excepting configurations for
  4. dependency software) is config.php in your StatusNet directory. If you
  5. edit any other file in the directory, like lib/default.php (where most
  6. of the defaults are defined), you will lose your configuration options
  7. in any upgrade, and you will wish that you had been more careful.
  8. Starting with version 0.9.0, a Web based configuration panel has been
  9. added to StatusNet. The preferred method for changing config options is
  10. to use this panel.
  11. A command-line script, setconfig.php, can be used to set individual
  12. configuration options. It's in the scripts/ directory.
  13. Starting with version 0.7.1, you can put config files in the
  14. /etc/statusnet/ directory on your server, if it exists. Config files
  15. will be included in this order:
  16. * /etc/statusnet/statusnet.php - server-wide config
  17. * /etc/statusnet/<servername>.php - for a virtual host
  18. * /etc/statusnet/<servername>_<pathname>.php - for a path
  19. * INSTALLDIR/config.php - for a particular implementation
  20. Almost all configuration options are made through a two-dimensional
  21. associative array, cleverly named $config. A typical configuration
  22. line will be:
  23. $config['section']['option'] = value;
  24. For brevity, the following documentation describes each section and
  25. option.
  26. site
  27. ----
  28. This section is a catch-all for site-wide variables.
  29. name: the name of your site, like 'YourCompany Microblog'.
  30. server: the server part of your site's URLs, like 'example.net'.
  31. path: The path part of your site's URLs, like 'statusnet' or ''
  32. (installed in root).
  33. fancy: whether or not your site uses fancy URLs (see Fancy URLs
  34. section above). Default is false.
  35. logfile: full path to a file for StatusNet to save logging
  36. information to. You may want to use this if you don't have
  37. access to syslog.
  38. logdebug: whether to log additional debug info like backtraces on
  39. hard errors. Default false.
  40. locale_path: full path to the directory for locale data. Unless you
  41. store all your locale data in one place, you probably
  42. don't need to use this.
  43. language: default language for your site. Defaults to US English.
  44. Note that this is overridden if a user is logged in and has
  45. selected a different language. It is also overridden if the
  46. user is NOT logged in, but their browser requests a different
  47. langauge. Since pretty much everybody's browser requests a
  48. language, that means that changing this setting has little or
  49. no effect in practice.
  50. languages: A list of languages supported on your site. Typically you'd
  51. only change this if you wanted to disable support for one
  52. or another language:
  53. "unset($config['site']['languages']['de'])" will disable
  54. support for German.
  55. theme: Theme for your site (see Theme section). Two themes are
  56. provided by default: 'default' and 'stoica' (the one used by
  57. Identi.ca). It's appreciated if you don't use the 'stoica' theme
  58. except as the basis for your own.
  59. email: contact email address for your site. By default, it's extracted
  60. from your Web server environment; you may want to customize it.
  61. broughtbyurl: name of an organization or individual who provides the
  62. service. Each page will include a link to this name in the
  63. footer. A good way to link to the blog, forum, wiki,
  64. corporate portal, or whoever is making the service available.
  65. broughtby: text used for the "brought by" link.
  66. timezone: default timezone for message display. Users can set their
  67. own time zone. Defaults to 'UTC', which is a pretty good default.
  68. closed: If set to 'true', will disallow registration on your site.
  69. This is a cheap way to restrict accounts to only one
  70. individual or group; just register the accounts you want on
  71. the service, *then* set this variable to 'true'.
  72. inviteonly: If set to 'true', will only allow registration if the user
  73. was invited by an existing user.
  74. private: If set to 'true', anonymous users will be redirected to the
  75. 'login' page. Also, API methods that normally require no
  76. authentication will require it. Note that this does not turn
  77. off registration; use 'closed' or 'inviteonly' for the
  78. behaviour you want.
  79. notice: A plain string that will appear on every page. A good place
  80. to put introductory information about your service, or info about
  81. upgrades and outages, or other community info. Any HTML will
  82. be escaped.
  83. logo: URL of an image file to use as the logo for the site. Overrides
  84. the logo in the theme, if any.
  85. ssllogo: URL of an image file to use as the logo on SSL pages. If unset,
  86. theme logo is used instead.
  87. ssl: Whether to use SSL and https:// URLs for some or all pages.
  88. Possible values are 'always' (use it for all pages), 'never'
  89. (don't use it for any pages), or 'sometimes' (use it for
  90. sensitive pages that include passwords like login and registration,
  91. but not for regular pages). Default to 'never'.
  92. sslserver: use an alternate server name for SSL URLs, like
  93. 'secure.example.org'. You should be careful to set cookie
  94. parameters correctly so that both the SSL server and the
  95. "normal" server can access the session cookie and
  96. preferably other cookies as well.
  97. shorturllength: ignored. See 'url' section below.
  98. dupelimit: minimum time allowed for one person to say the same thing
  99. twice. Default 60s. Anything lower is considered a user
  100. or UI error.
  101. textlimit: default max size for texts in the site. Defaults to 0 (no limit).
  102. Can be fine-tuned for notices, messages, profile bios and group descriptions.
  103. db
  104. --
  105. This section is a reference to the configuration options for
  106. DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
  107. set are listed below for clarity.
  108. database: a DSN (Data Source Name) for your StatusNet database. This is
  109. in the format 'protocol://username:password@hostname/databasename',
  110. where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
  111. really know what you're doing), 'username' is the username,
  112. 'password' is the password, and etc.
  113. ini_yourdbname: if your database is not named 'statusnet', you'll need
  114. to set this to point to the location of the
  115. statusnet.ini file. Note that the real name of your database
  116. should go in there, not literally 'yourdbname'.
  117. db_driver: You can try changing this to 'MDB2' to use the other driver
  118. type for DB_DataObject, but note that it breaks the OpenID
  119. libraries, which only support PEAR::DB.
  120. debug: On a database error, you may get a message saying to set this
  121. value to 5 to see debug messages in the browser. This breaks
  122. just about all pages, and will also expose the username and
  123. password
  124. quote_identifiers: Set this to true if you're using postgresql.
  125. type: either 'mysql' or 'postgresql' (used for some bits of
  126. database-type-specific SQL in the code). Defaults to mysql.
  127. mirror: you can set this to an array of DSNs, like the above
  128. 'database' value. If it's set, certain read-only actions will
  129. use a random value out of this array for the database, rather
  130. than the one in 'database' (actually, 'database' is overwritten).
  131. You can offload a busy DB server by setting up MySQL replication
  132. and adding the slaves to this array. Note that if you want some
  133. requests to go to the 'database' (master) server, you'll need
  134. to include it in this array, too.
  135. utf8: whether to talk to the database in UTF-8 mode. This is the default
  136. with new installations, but older sites may want to turn it off
  137. until they get their databases fixed up. See "UTF-8 database"
  138. above for details.
  139. schemacheck: when to let plugins check the database schema to add
  140. tables or update them. Values can be 'runtime' (default)
  141. or 'script'. 'runtime' can be costly (plugins check the
  142. schema on every hit, adding potentially several db
  143. queries, some quite long), but not everyone knows how to
  144. run a script. If you can, set this to 'script' and run
  145. scripts/checkschema.php whenever you install or upgrade a
  146. plugin.
  147. syslog
  148. ------
  149. By default, StatusNet sites log error messages to the syslog facility.
  150. (You can override this using the 'logfile' parameter described above).
  151. appname: The name that StatusNet uses to log messages. By default it's
  152. "statusnet", but if you have more than one installation on the
  153. server, you may want to change the name for each instance so
  154. you can track log messages more easily.
  155. priority: level to log at. Currently ignored.
  156. facility: what syslog facility to used. Defaults to LOG_USER, only
  157. reset if you know what syslog is and have a good reason
  158. to change it.
  159. queue
  160. -----
  161. You can configure the software to queue time-consuming tasks, like
  162. sending out SMS email or XMPP messages, for off-line processing. See
  163. 'Queues and daemons' above for how to set this up.
  164. enabled: Whether to uses queues. Defaults to false.
  165. daemon: Wather to use queuedaemon. Defaults to false, which means
  166. you'll use OpportunisticQM plugin.
  167. subsystem: Which kind of queueserver to use. Values include "db" for
  168. our hacked-together database queuing (no other server
  169. required) and "stomp" for a stomp server.
  170. stomp_server: "broker URI" for stomp server. Something like
  171. "tcp://hostname:61613". More complicated ones are
  172. possible; see your stomp server's documentation for
  173. details.
  174. queue_basename: a root name to use for queues (stomp only). Typically
  175. something like '/queue/sitename/' makes sense. If running
  176. multiple instances on the same server, make sure that
  177. either this setting or $config['site']['nickname'] are
  178. unique for each site to keep them separate.
  179. stomp_username: username for connecting to the stomp server; defaults
  180. to null.
  181. stomp_password: password for connecting to the stomp server; defaults
  182. to null.
  183. stomp_persistent: keep items across queue server restart, if enabled.
  184. Under ActiveMQ, the server configuration determines if and how
  185. persistent storage is actually saved.
  186. If using a message queue server other than ActiveMQ, you may
  187. need to disable this if it does not support persistence.
  188. stomp_transactions: use transactions to aid in error detection.
  189. A broken transaction will be seen quickly, allowing a message
  190. to be redelivered immediately if a daemon crashes.
  191. If using a message queue server other than ActiveMQ, you may
  192. need to disable this if it does not support transactions.
  193. stomp_acks: send acknowledgements to aid in flow control.
  194. An acknowledgement of successful processing tells the server
  195. we're ready for more and can help keep things moving smoothly.
  196. This should *not* be turned off when running with ActiveMQ, but
  197. if using another message queue server that does not support
  198. acknowledgements you might need to disable this.
  199. softlimit: an absolute or relative "soft memory limit"; daemons will
  200. restart themselves gracefully when they find they've hit
  201. this amount of memory usage. Defaults to 90% of PHP's global
  202. memory_limit setting.
  203. inboxes: delivery of messages to receiver's inboxes can be delayed to
  204. queue time for best interactive performance on the sender.
  205. This may however be annoyingly slow when using the DB queues,
  206. so you can set this to false if it's causing trouble.
  207. breakout: for stomp, individual queues are by default grouped up for
  208. best scalability. If some need to be run by separate daemons,
  209. etc they can be manually adjusted here.
  210. Default will share all queues for all sites within each group.
  211. Specify as <group>/<queue> or <group>/<queue>/<site>,
  212. using nickname identifier as site.
  213. 'main/distrib' separate "distrib" queue covering all sites
  214. 'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
  215. max_retries: for stomp, drop messages after N failed attempts to process.
  216. Defaults to 10.
  217. dead_letter_dir: for stomp, optional directory to dump data on failed
  218. queue processing events after discarding them.
  219. stomp_no_transactions: for stomp, the server does not support transactions,
  220. so do not try to user them. This is needed for http://www.morbidq.com/.
  221. stomp_no_acks: for stomp, the server does not support acknowledgements.
  222. so do not try to user them. This is needed for http://www.morbidq.com/.
  223. license
  224. -------
  225. The default license to use for your users notices. The default is the
  226. Creative Commons Attribution 3.0 license, which is probably the right
  227. choice for any public site. Note that some other servers will not
  228. accept notices if you apply a stricter license than this.
  229. type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
  230. (default copyright), or 'private' (for private and confidential
  231. information).
  232. owner: for 'allrightsreserved' or 'private', an assigned copyright
  233. holder (for example, an employer for a private site). If
  234. not specified, will be attributed to 'contributors'.
  235. url: URL of the license, used for links.
  236. title: Title for the license, like 'Creative Commons Attribution 3.0'.
  237. image: A button shown on each page for the license.
  238. mail
  239. ----
  240. This is for configuring out-going email. We use PEAR's Mail module,
  241. see: http://pear.php.net/manual/en/package.mail.mail.factory.php
  242. backend: the backend to use for mail, one of 'mail', 'sendmail', and
  243. 'smtp'. Defaults to PEAR's default, 'mail'.
  244. params: if the mail backend requires any parameters, you can provide
  245. them in an associative array.
  246. nickname
  247. --------
  248. This is for configuring nicknames in the service.
  249. blacklist: an array of strings for usernames that may not be
  250. registered. A default array exists for strings that are
  251. used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
  252. but you may want to add others if you have other software
  253. installed in a subdirectory of StatusNet or if you just
  254. don't want certain words used as usernames.
  255. featured: an array of nicknames of 'featured' users of the site.
  256. Can be useful to draw attention to well-known users, or
  257. interesting people, or whatever.
  258. avatar
  259. ------
  260. For configuring avatar access.
  261. dir: Directory to look for avatar files and to put them into.
  262. Defaults to avatar subdirectory of install directory; if
  263. you change it, make sure to change path, too.
  264. path: Path to avatars. Defaults to path for avatar subdirectory,
  265. but you can change it if you wish. Note that this will
  266. be included with the avatar server, too.
  267. server: If set, defines another server where avatars are stored in the
  268. root directory. Note that the 'avatar' subdir still has to be
  269. writeable. You'd typically use this to split HTTP requests on
  270. the client to speed up page loading, either with another
  271. virtual server or with an NFS or SAMBA share. Clients
  272. typically only make 2 connections to a single server at a
  273. time <http://ur1.ca/6ih>, so this can parallelize the job.
  274. Defaults to null.
  275. ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
  276. to guess based on site-wide SSL settings.
  277. public
  278. ------
  279. For configuring the public stream.
  280. localonly: If set to true, only messages posted by users of this
  281. service (rather than other services, filtered through OStatus)
  282. are shown in the public stream. Default true.
  283. blacklist: An array of IDs of users to hide from the public stream.
  284. Useful if you have someone making excessive Twitterfeed posts
  285. to the site, other kinds of automated posts, testing bots, etc.
  286. autosource: Sources of notices that are from automatic posters, and thus
  287. should be kept off the public timeline. Default empty.
  288. theme
  289. -----
  290. server: Like avatars, you can speed up page loading by pointing the
  291. theme file lookup to another server (virtual or real).
  292. Defaults to NULL, meaning to use the site server.
  293. dir: Directory where theme files are stored. Used to determine
  294. whether to show parts of a theme file. Defaults to the theme
  295. subdirectory of the install directory.
  296. path: Path part of theme URLs, before the theme name. Relative to the
  297. theme server. It may make sense to change this path when upgrading,
  298. (using version numbers as the path) to make sure that all files are
  299. reloaded by caching clients or proxies. Defaults to null,
  300. which means to use the site path + '/theme'.
  301. ssl: Whether to use SSL for theme elements. Default is null, which means
  302. guess based on site SSL settings.
  303. sslserver: SSL server to use when page is HTTPS-encrypted. If
  304. unspecified, site ssl server and so on will be used.
  305. sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
  306. javascript
  307. ----------
  308. server: You can speed up page loading by pointing the
  309. theme file lookup to another server (virtual or real).
  310. Defaults to NULL, meaning to use the site server.
  311. path: Path part of Javascript URLs. Defaults to null,
  312. which means to use the site path + '/js/'.
  313. ssl: Whether to use SSL for JavaScript files. Default is null, which means
  314. guess based on site SSL settings.
  315. sslserver: SSL server to use when page is HTTPS-encrypted. If
  316. unspecified, site ssl server and so on will be used.
  317. sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
  318. bustframes: If true, all web pages will break out of framesets. If false,
  319. can comfortably live in a frame or iframe... probably. Default
  320. to true.
  321. xmpp
  322. ----
  323. For configuring the XMPP sub-system.
  324. enabled: Whether to accept and send messages by XMPP. Default false.
  325. server: server part of XMPP ID for update user.
  326. port: connection port for clients. Default 5222, which you probably
  327. shouldn't need to change.
  328. user: username for the client connection. Users will receive messages
  329. from 'user'@'server'.
  330. resource: a unique identifier for the connection to the server. This
  331. is actually used as a prefix for each XMPP component in the system.
  332. password: password for the user account.
  333. host: some XMPP domains are served by machines with a different
  334. hostname. (For example, @gmail.com GTalk users connect to
  335. talk.google.com). Set this to the correct hostname if that's the
  336. case with your server.
  337. encryption: Whether to encrypt the connection between StatusNet and the
  338. XMPP server. Defaults to true, but you can get
  339. considerably better performance turning it off if you're
  340. connecting to a server on the same machine or on a
  341. protected network.
  342. debug: if turned on, this will make the XMPP library blurt out all of
  343. the incoming and outgoing messages as XML stanzas. Use as a
  344. last resort, and never turn it on if you don't have queues
  345. enabled, since it will spit out sensitive data to the browser.
  346. public: an array of JIDs to send _all_ notices to. This is useful for
  347. participating in third-party search and archiving services.
  348. invite
  349. ------
  350. For configuring invites.
  351. enabled: Whether to allow users to send invites. Default true.
  352. tag
  353. ---
  354. Miscellaneous tagging stuff.
  355. dropoff: Decay factor for tag listing, in seconds.
  356. Defaults to exponential decay over ten days; you can twiddle
  357. with it to try and get better results for your site.
  358. popular
  359. -------
  360. Settings for the "popular" section of the site.
  361. dropoff: Decay factor for popularity listing, in seconds.
  362. Defaults to exponential decay over ten days; you can twiddle
  363. with it to try and get better results for your site.
  364. daemon
  365. ------
  366. For daemon processes.
  367. piddir: directory that daemon processes should write their PID file
  368. (process ID) to. Defaults to /var/run/, which is where this
  369. stuff should usually go on Unix-ish systems.
  370. user: If set, the daemons will try to change their effective user ID
  371. to this user before running. Probably a good idea, especially if
  372. you start the daemons as root. Note: user name, like 'daemon',
  373. not 1001.
  374. group: If set, the daemons will try to change their effective group ID
  375. to this named group. Again, a name, not a numerical ID.
  376. emailpost
  377. ---------
  378. For post-by-email.
  379. enabled: Whether to enable post-by-email. Defaults to true. You will
  380. also need to set up maildaemon.php.
  381. sms
  382. ---
  383. For SMS integration.
  384. enabled: Whether to enable SMS integration. Defaults to true. Queues
  385. should also be enabled.
  386. integration
  387. -----------
  388. A catch-all for integration with other systems.
  389. taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
  390. inboxes
  391. -------
  392. For notice inboxes.
  393. enabled: No longer used. If you set this to something other than true,
  394. StatusNet will no longer run.
  395. throttle
  396. --------
  397. For notice-posting throttles.
  398. enabled: Whether to throttle posting. Defaults to false.
  399. count: Each user can make this many posts in 'timespan' seconds. So, if count
  400. is 100 and timespan is 3600, then there can be only 100 posts
  401. from a user every hour.
  402. timespan: see 'count'.
  403. profile
  404. -------
  405. Profile management.
  406. biolimit: max character length of bio; 0 means no limit; null means to use
  407. the site text limit default.
  408. backup: whether users can backup their own profiles. Defaults to true.
  409. restore: whether users can restore their profiles from backup files. Defaults
  410. to true.
  411. delete: whether users can delete their own accounts. Defaults to false.
  412. move: whether users can move their accounts to another server. Defaults
  413. to true.
  414. newuser
  415. -------
  416. Options with new users.
  417. default: nickname of a user account to automatically subscribe new
  418. users to. Typically this would be system account for e.g.
  419. service updates or announcements. Users are able to unsub
  420. if they want. Default is null; no auto subscribe.
  421. welcome: nickname of a user account that sends welcome messages to new
  422. users. Can be the same as 'default' account, although on
  423. busy servers it may be a good idea to keep that one just for
  424. 'urgent' messages. Default is null; no message.
  425. If either of these special user accounts are specified, the users should
  426. be created before the configuration is updated.
  427. attachments
  428. -----------
  429. The software lets users upload files with their notices. You can configure
  430. the types of accepted files by mime types and a trio of quota options:
  431. per file, per user (total), per user per month.
  432. We suggest the use of the pecl file_info extension to handle mime type
  433. detection.
  434. supported: an array of mime types you accept to store and distribute,
  435. like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
  436. setup your server to properly recognize the types you want to
  437. support.
  438. uploads: false to disable uploading files with notices (true by default).
  439. For quotas, be sure you've set the upload_max_filesize and post_max_size
  440. in php.ini to be large enough to handle your upload. In httpd.conf
  441. (if you're using apache), check that the LimitRequestBody directive isn't
  442. set too low (it's optional, so it may not be there at all).
  443. process_links: follow redirects and save all available file information
  444. (mimetype, date, size, oembed, etc.). Defaults to true.
  445. file_quota: maximum size for a single file upload in bytes. A user can send
  446. any amount of notices with attachments as long as each attachment
  447. is smaller than file_quota.
  448. user_quota: total size in bytes a user can store on this server. Each user
  449. can store any number of files as long as their total size does
  450. not exceed the user_quota.
  451. monthly_quota: total size permitted in the current month. This is the total
  452. size in bytes that a user can upload each month.
  453. dir: directory accessible to the Web process where uploads should go.
  454. Defaults to the 'file' subdirectory of the install directory, which
  455. should be writeable by the Web user.
  456. server: server name to use when creating URLs for uploaded files.
  457. Defaults to null, meaning to use the default Web server. Using
  458. a virtual server here can speed up Web performance.
  459. path: URL path, relative to the server, to find files. Defaults to
  460. main path + '/file/'.
  461. ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
  462. guess based on other SSL settings.
  463. sslserver: if specified, this server will be used when creating HTTPS
  464. URLs. Otherwise, the site SSL server will be used, with /file/ path.
  465. sslpath: if this and the sslserver are specified, this path will be used
  466. when creating HTTPS URLs. Otherwise, the attachments|path value
  467. will be used.
  468. group
  469. -----
  470. Options for group functionality.
  471. maxaliases: maximum number of aliases a group can have. Default 3. Set
  472. to 0 or less to prevent aliases in a group.
  473. desclimit: maximum number of characters to allow in group descriptions.
  474. null (default) means to use the site-wide text limits. 0
  475. means no limit.
  476. addtag: Whether to add a tag for the group nickname for every group post
  477. (pre-1.0.x behaviour). Defaults to false.
  478. search
  479. ------
  480. Some stuff for search.
  481. type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
  482. be 'fulltext' or 'like' (default). The former is faster and more efficient
  483. but requires the lame old MyISAM engine for MySQL. The latter
  484. will work with InnoDB but could be miserably slow on large
  485. systems. We'll probably add another type sometime in the future,
  486. with our own indexing system (maybe like MediaWiki's).
  487. sessions
  488. --------
  489. Session handling.
  490. handle: boolean. Whether we should register our own PHP session-handling
  491. code (using the database and cache layers if enabled). Defaults to false.
  492. Setting this to true makes some sense on large or multi-server
  493. sites, but it probably won't hurt for smaller ones, either.
  494. debug: whether to output debugging info for session storage. Can help
  495. with weird session bugs, sometimes. Default false.
  496. background
  497. ----------
  498. Users can upload backgrounds for their pages; this section defines
  499. their use.
  500. server: the server to use for background. Using a separate (even
  501. virtual) server for this can speed up load times. Default is
  502. null; same as site server.
  503. dir: directory to write backgrounds too. Default is '/background/'
  504. subdir of install dir.
  505. path: path to backgrounds. Default is sub-path of install path; note
  506. that you may need to change this if you change site-path too.
  507. sslserver: SSL server to use when page is HTTPS-encrypted. If
  508. unspecified, site ssl server and so on will be used.
  509. sslpath: If sslserver if defined, path to use when page is HTTPS-encrypted.
  510. ping
  511. ----
  512. Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
  513. notify third-party servers of updates.
  514. notify: an array of URLs for ping endpoints. Default is the empty
  515. array (no notification).
  516. design
  517. ------
  518. Default design (colors and background) for the site. Actual appearance
  519. depends on the theme. Null values mean to use the theme defaults.
  520. backgroundcolor: Hex color of the site background.
  521. contentcolor: Hex color of the content area background.
  522. sidebarcolor: Hex color of the sidebar background.
  523. textcolor: Hex color of all non-link text.
  524. linkcolor: Hex color of all links.
  525. backgroundimage: Image to use for the background.
  526. disposition: Flags for whether or not to tile the background image.
  527. notice
  528. ------
  529. Configuration options specific to notices.
  530. contentlimit: max length of the plain-text content of a notice.
  531. Default is null, meaning to use the site-wide text limit.
  532. 0 means no limit.
  533. defaultscope: default scope for notices. If null, the default
  534. scope depends on site/private. It's 1 if the site is private,
  535. 0 otherwise. Set this value to override.
  536. message
  537. -------
  538. Configuration options specific to messages.
  539. contentlimit: max length of the plain-text content of a message.
  540. Default is null, meaning to use the site-wide text limit.
  541. 0 means no limit.
  542. logincommand
  543. ------------
  544. Configuration options for the login command.
  545. disabled: whether to enable this command. If enabled, users who send
  546. the text 'login' to the site through any channel will
  547. receive a link to login to the site automatically in return.
  548. Possibly useful for users who primarily use an XMPP or SMS
  549. interface and can't be bothered to remember their site
  550. password. Note that the security implications of this are
  551. pretty serious and have not been thoroughly tested. You
  552. should enable it only after you've convinced yourself that
  553. it is safe. Default is 'false'.
  554. singleuser
  555. ----------
  556. If an installation has only one user, this can simplify a lot of the
  557. interface. It also makes the user's profile the root URL.
  558. enabled: Whether to run in "single user mode". Default false.
  559. nickname: nickname of the single user. If no nickname is specified,
  560. the site owner account will be used (if present).
  561. robotstxt
  562. ---------
  563. We put out a default robots.txt file to guide the processing of
  564. Web crawlers. See http://www.robotstxt.org/ for more information
  565. on the format of this file.
  566. crawldelay: if non-empty, this value is provided as the Crawl-Delay:
  567. for the robots.txt file. see http://ur1.ca/l5a0
  568. for more information. Default is zero, no explicit delay.
  569. disallow: Array of (virtual) directories to disallow. Default is 'main',
  570. 'search', 'message', 'settings', 'admin'. Ignored when site
  571. is private, in which case the entire site ('/') is disallowed.
  572. api
  573. ---
  574. Options for the Twitter-like API.
  575. realm: HTTP Basic Auth realm (see http://tools.ietf.org/html/rfc2617
  576. for details). Some third-party tools like ping.fm want this to be
  577. 'Identi.ca API', so set it to that if you want to. default = null,
  578. meaning 'something based on the site name'.
  579. nofollow
  580. --------
  581. We optionally put 'rel="nofollow"' on some links in some pages. The
  582. following configuration settings let you fine-tune how or when things
  583. are nofollowed. See http://en.wikipedia.org/wiki/Nofollow for more
  584. information on what 'nofollow' means.
  585. subscribers: whether to nofollow links to subscribers on the profile
  586. and personal pages. Default is true.
  587. members: links to members on the group page. Default true.
  588. peopletag: links to people listed in the peopletag page. Default true.
  589. external: external links in notices. One of three values: 'sometimes',
  590. 'always', 'never'. If 'sometimes', then external links are not
  591. nofollowed on profile, notice, and favorites page. Default is
  592. 'sometimes'.
  593. url
  594. ---
  595. These are some options for fine-tuning how and when the server will
  596. shorten URLs.
  597. shortener: URL shortening service to use by default. Users can override
  598. individually. 'internal' by default.
  599. maxurllength: If an URL is strictly longer than this limit, it will be
  600. shortened. Note that the URL shortener service may return an
  601. URL longer than this limit. Defaults to 100. Users can
  602. override. If set to 0, all URLs will be shortened.
  603. maxnoticelength: If a notice is strictly longer than this limit, all
  604. URLs in the notice will be shortened. Users can override.
  605. -1 means the text limit for notices.
  606. router
  607. ------
  608. We use a router class for mapping URLs to code. This section controls
  609. how that router works.
  610. cache: whether to cache the router in cache layers. Defaults to true,
  611. but may be set to false for developers (who might be actively
  612. adding pages, so won't want the router cached) or others who see
  613. strange behavior. You're unlikely to need this unless developing..
  614. http
  615. ----
  616. Settings for the HTTP client.
  617. ssl_cafile: location of the CA file for SSL. If not set, won't verify
  618. SSL peers. Default unset.
  619. curl: Use cURL <http://curl.haxx.se/> for doing HTTP calls. You must
  620. have the PHP curl extension installed for this to work.
  621. proxy_host: Host to use for proxying HTTP requests. If unset, doesn't
  622. do any HTTP proxy stuff. Default unset.
  623. proxy_port: Port to use to connect to HTTP proxy host. Default null.
  624. proxy_user: Username to use for authenticating to the HTTP proxy. Default null.
  625. proxy_password: Password to use for authenticating to the HTTP proxy. Default null.
  626. proxy_auth_scheme: Scheme to use for authenticating to the HTTP proxy. Default null.
  627. plugins
  628. -------
  629. default: associative array mapping plugin name to array of arguments. To disable
  630. a default plugin, unset its value in this array.
  631. locale_path: path for finding plugin locale files. In the plugin's directory
  632. by default.
  633. server: Server to find static files for a plugin when the page is plain old HTTP.
  634. Defaults to site/server (same as pages). Use this to move plugin CSS and
  635. JS files to a CDN.
  636. sslserver: Server to find static files for a plugin when the page is HTTPS. Defaults
  637. to site/server (same as pages). Use this to move plugin CSS and JS files
  638. to a CDN.
  639. path: Path to the plugin files. defaults to site/path + '/plugins/'. Expects that
  640. each plugin will have a subdirectory at plugins/NameOfPlugin. Change this
  641. if you're using a CDN.
  642. sslpath: Path to use on the SSL server. Same as plugins/path.
  643. performance
  644. -----------
  645. high: if you need high performance, or if you're seeing bad
  646. performance, set this to true. It will turn off some high-intensity code from
  647. the site.
  648. oldschool
  649. ---------
  650. enabled: enable certain old-style user settings options, like stream-only mode,
  651. conversation trees, and nicknames in streams. Off by default, and
  652. may not be well supported in future versions.