CONFIGURE 32 KB

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