Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 1608 lines (1292 sloc) 66.904 kb
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1 ------
2 README
3 ------
4
728a146 Evan Prodromou new codename for 0.8.2
evanp authored
5 StatusNet 0.8.2 ("Life and How to Live It")
cf199a9 Evan Prodromou updates to README
evanp authored
6 1 Nov 2009
fbe15ef big changes to the README, part 1
Evan Prodromou authored
7
03e0f73 Evan Prodromou add changelog to README
evanp authored
8 This is the README file for StatusNet (formerly Laconica), the Open
9 Source microblogging platform. It includes installation instructions,
10 descriptions of options you can set, warnings, tips, and general info
11 for administrators. Information on using StatusNet can be found in the
fbe15ef big changes to the README, part 1
Evan Prodromou authored
12 "doc" subdirectory or in the "help" section on-line.
13
14 About
15 =====
16
03e0f73 Evan Prodromou add changelog to README
evanp authored
17 StatusNet (formerly Laconica) is a Free and Open Source microblogging
18 platform. It helps people in a community, company or group to exchange
19 short (140 character) messages over the Web. Users can choose which
20 people to "follow" and receive only their friends' or colleagues'
21 status messages. It provides a similar service to sites like Twitter,
22 Jaiku, Yammer, and Plurk.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
23
24 With a little work, status messages can be sent to mobile phones,
25 instant messenger programs (GTalk/Jabber), and specially-designed
26 desktop clients that support the Twitter API.
27
2506207 update README file
Evan Prodromou authored
28 StatusNet supports an open standard called OpenMicroBlogging
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
29 <http://openmicroblogging.org/> that lets users on different Web sites
fbe15ef big changes to the README, part 1
Evan Prodromou authored
30 or in different companies subscribe to each others' notices. It
31 enables a distributed social network spread all across the Web.
32
2506207 update README file
Evan Prodromou authored
33 StatusNet was originally developed for the Open Software Service,
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
34 Identi.ca <http://identi.ca/>. It is shared with you in hope that you
fbe15ef big changes to the README, part 1
Evan Prodromou authored
35 too make an Open Software Service available to your users. To learn
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
36 more, please see the Open Software Service Definition 1.1:
fbe15ef big changes to the README, part 1
Evan Prodromou authored
37
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
38 http://www.opendefinition.org/ossd
fbe15ef big changes to the README, part 1
Evan Prodromou authored
39
82b0927 Evan Prodromou update version in README, add note about status.net
evanp authored
40 StatusNet, Inc. <http://status.net/> also offers this software as a
41 Web service, requiring no installation on your part. The software run
42 on status.net is identical to the software available for download, so
43 you can move back and forth between a hosted version or a version
44 installed on your own servers.
45
fbe15ef big changes to the README, part 1
Evan Prodromou authored
46 License
47 =======
48
49 This program is free software: you can redistribute it and/or modify
50 it under the terms of the GNU Affero General Public License as
51 published by the Free Software Foundation, either version 3 of the
52 License, or (at your option) any later version.
53
54 This program is distributed in the hope that it will be useful, but
55 WITHOUT ANY WARRANTY; without even the implied warranty of
56 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
57 Affero General Public License for more details.
58
59 You should have received a copy of the GNU Affero General Public
60 License along with this program, in the file "COPYING". If not, see
61 <http://www.gnu.org/licenses/>.
62
63 IMPORTANT NOTE: The GNU Affero General Public License (AGPL) has
64 *different requirements* from the "regular" GPL. In particular, if
2506207 update README file
Evan Prodromou authored
65 you make modifications to the StatusNet source code on your server,
fbe15ef big changes to the README, part 1
Evan Prodromou authored
66 you *MUST MAKE AVAILABLE* the modified version of the source code
67 to your users under the same license. This is a legal requirement
68 of using the software, and if you do not wish to share your
e3a5325 last scrub of Laconica -> StatusNet
Evan Prodromou authored
69 modifications, *YOU MAY NOT INSTALL STATUSNET*.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
70
a1434ee finish the README file
Evan Prodromou authored
71 Additional library software has been made available in the 'extlib'
72 directory. All of it is Free Software and can be distributed under
73 liberal terms, but those terms may differ in detail from the AGPL's
74 particulars. See each package's license file in the extlib directory
75 for additional terms.
76
77 New this version
78 ================
79
cf199a9 Evan Prodromou updates to README
evanp authored
80 This is a minor feature and bugfix release since version 0.8.1,
81 released Aug 26 2009. Notable changes this version:
82
83 - New script for deleting user accounts. Not particularly safe or
84 community-friendly. Better for deleting abusive accounts than for
85 users who are 'retiring'.
86 - Improved detection of URLs in notices, specifically for punctuation
87 chars like ~, :, $, _, -, +, !, @, and %.
88 - Removed some extra <dl> semantic HTML code.
89 - Correct error in status-network database ini file (having multiple
90 statusnet sites with a single codebase)
91 - Fixed error output for Twitter posting failures.
92 - Fixed bug in Twitter queue handler that requeued inapplicable
93 notices ad infinitum.
94 - Improve FOAF output for remote users.
95 - new commands to join and leave groups.
96 - Fixed bug in which you cannot turn off importing friends timelines
97 flag.
98 - Better error handling in Twitter posting.
99 - Show oEmbed data for XHTML files as well as plain HTML.
100 - Updated bug database link in README.
101 - add support for HTTP Basic Auth in PHP CGI or FastCGI (e.g. GoDaddy).
102 - autofocus input to selected entry elements depending on page.
103 - updated layout for filter-by-tag form.
104 - better layout for inbox and outbox pages.
105 - fix highlighting search terms in attributes of notice list elements.
106 - Correctly handle errors in linkback plugin.
107 - Updated biz theme.
108 - Updated cloudy theme.
109 - Don't match '::' as an IPv6 address.
110 - Use the same decision logic for deciding whether to mark an
111 attachment as an enclosure in RSS or as a paperclip item in Web
112 output.
113 - Fixed a bug in the Piwik plugin that hard-coded the site ID.
114 - Add a param, inreplyto, to notice/new to allow an explicit response
115 to another notice.
116 - Show username in subject of emails.
117 - Check if avatar exists before trying to delete it.
118 - Correctly add omb_version to response for request token in OMB.
119 - Add a few more SMS carriers.
120 - Add a few more notice sources.
121 - Vary: header.
122 - Improvements to the AutoCompletePlugin.
123 - Check for 'dl' before using it.
124 - Make it impossible to delete self-subscriptions via the API.
125 - Fix pagination of tagged user pages.
126 - Make PiwikAnalyticsPlugin work with addPlugin().
127 - Removed trailing single space in user nicknames in notice lists.
128 - Show context link if a notice starts a conversation.
129 - blacklist all files and directories in install dir.
130 - handle GoDaddy-style PATH_INFO, including script name.
131 - add home_timeline synonym for friends_timeline.
132 - Add a popup window for the realtime plugin.
133 - Add some more streams for the realtime plugin.
134 - Fix a bug that overwrote group creation timestamp on every edit.
135 - Moved HTTP error code strings to a class variable.
136 - The Twitter API now returns server errors in the correct format.
137 - Reset the doctype for HTML output.
138 - Fixed a number of notices.
139 - Don't show search suggestions for private sites.
140 - Some corrections to FBConnect nav overrides.
141 - Slightly less database-intensive session management.
142 - Updated name of software in installer script.
143 - Include long-form attachment URLs if url-shortener is disabled.
144 - Include updated localisations for Polish, Greek, Hebrew, Icelandic,
145 Norwegian, and Chinese.
146 - Include upstream fixes to gettext.php.
147 - Correct for regression in Facebook API for updates.
148 - Ignore "Sent from my iPhone" (and similar) in mail updates.
149 - Use the NICKNAME_FMT constant for detecting nicknames.
150 - Check for site servername config'd.
151 - Compatibility fix for empty status updates with Twitter API.
bed9422 Evan Prodromou Revert "remove mention of getfile"
evanp authored
152 - Option to show files privately (EXPERIMENTAL! Use with caution.)
f757ba3 Evan Prodromou notes about registeruser and makegroupadmin scripts
evanp authored
153 - a script to register a new user.
154 - a script to make a user admin of a group.
a1434ee finish the README file
Evan Prodromou authored
155
fbe15ef big changes to the README, part 1
Evan Prodromou authored
156 Prerequisites
157 =============
158
159 The following software packages are *required* for this software to
160 run correctly.
161
8894f95 Craig Andrews Require PHP 5.2.3 or later.
candrews authored
162 - PHP 5.2.3+. It may be possible to run this software on earlier
fbe15ef big changes to the README, part 1
Evan Prodromou authored
163 versions of PHP, but many of the functions used are only available
164 in PHP 5.2 or above.
2506207 update README file
Evan Prodromou authored
165 - MySQL 5.x. The StatusNet database is stored, by default, in a MySQL
fbe15ef big changes to the README, part 1
Evan Prodromou authored
166 server. It has been primarily tested on 5.x servers, although it may
167 be possible to install on earlier (or later!) versions. The server
168 *must* support the MyISAM storage engine -- the default for most
169 MySQL servers -- *and* the InnoDB storage engine.
170 - A Web server. Preferably, you should have Apache 2.2.x with the
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
171 mod_rewrite extension installed and enabled.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
172
173 Your PHP installation must include the following PHP extensions:
174
175 - Curl. This is for fetching files by HTTP.
176 - XMLWriter. This is for formatting XML and HTML output.
177 - MySQL. For accessing the database.
a1434ee finish the README file
Evan Prodromou authored
178 - GD. For scaling down avatar images.
d5bb9bd README - Added mbstring to the list of required PHP5 extensions
Zach Copley authored
179 - mbstring. For handling Unicode (UTF-8) encoded strings.
864aad7 add gettext as a prereq
Evan Prodromou authored
180 - gettext. For multiple languages. Default on many PHP installs.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
181
182 For some functionality, you will also need the following extensions:
183
184 - Memcache. A client for the memcached server, which caches database
185 information in volatile memory. This is important for adequate
186 performance on high-traffic sites. You will also need a memcached
187 server to store the data in.
188 - Mailparse. Efficient parsing of email requires this extension.
189 Submission by email or SMS-over-email uses this extension.
525b867 sphinx documentation and sample config file
millette authored
190 - Sphinx Search. A client for the sphinx server, an alternative
191 to MySQL or Postgresql fulltext search. You will also need a
192 Sphinx server to serve the search queries.
193
fbe15ef big changes to the README, part 1
Evan Prodromou authored
194 You will almost definitely get 2-3 times better performance from your
195 site if you install a PHP bytecode cache/accelerator. Some well-known
196 examples are: eaccelerator, Turck mmcache, xcache, apc. Zend Optimizer
197 is a proprietary accelerator installed on some hosting sites.
198
199 External libraries
200 ------------------
201
202 A number of external PHP libraries are used to provide basic
203 functionality and optional functionality for your system. For your
204 convenience, they are available in the "extlib" directory of this
205 package, and you do not have to download and install them. However,
206 you may want to keep them up-to-date with the latest upstream version,
207 and the URLs are listed here for your convenience.
5d1a6f0 Evan Prodromou add validation methods to classes
evanp authored
208
0cabc70 Evan Prodromou add doc action
evanp authored
209 - DB_DataObject http://pear.php.net/package/DB_DataObject
210 - Validate http://pear.php.net/package/Validate
fbe15ef big changes to the README, part 1
Evan Prodromou authored
211 - OpenID from OpenIDEnabled (not the PEAR version!). We decided
eecd611 Evan Prodromou tags and XRDS
evanp authored
212 to use the openidenabled.com version since it's more widely
fbe15ef big changes to the README, part 1
Evan Prodromou authored
213 implemented, and seems to be better supported.
c501b7b Evan Prodromou interim commit after pull from server
evanp authored
214 http://openidenabled.com/php-openid/
fbe15ef big changes to the README, part 1
Evan Prodromou authored
215 - PEAR DB. Although this is an older data access system (new
216 packages should probably use PHP DBO), the OpenID libraries
217 depend on PEAR DB so we use it here, too. DB_DataObject can
218 also use PEAR MDB2, which may give you better performance
219 but won't work with OpenID.
220 http://pear.php.net/package/DB
c501b7b Evan Prodromou interim commit after pull from server
evanp authored
221 - OAuth.php from http://oauth.googlecode.com/svn/code/php/
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
222 - markdown.php from http://michelf.com/projects/php-markdown/
025dcb9 Evan Prodromou some doc
evanp authored
223 - PEAR Mail, for sending out mail notifications
d1e55b3 jabber send and confirmation code
Evan Prodromou authored
224 http://pear.php.net/package/Mail
025dcb9 Evan Prodromou some doc
evanp authored
225 - PEAR Net_SMTP, if you use the SMTP factory for notifications
d1e55b3 jabber send and confirmation code
Evan Prodromou authored
226 http://pear.php.net/package/Net_SMTP
07086d1 Evan Prodromou update README
evanp authored
227 - PEAR Net_Socket, if you use the SMTP factory for notifications
228 http://pear.php.net/package/Net_Socket
fbe15ef big changes to the README, part 1
Evan Prodromou authored
229 - XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP
230 library available for PHP. http://xmpphp.googlecode.com/. Note that
231 as of this writing the version of this library that is available in
232 the extlib directory is *significantly different* from the upstream
233 version (patches have been submitted). Upgrading to the upstream
2506207 update README file
Evan Prodromou authored
234 version may render your StatusNet site unable to send or receive XMPP
fbe15ef big changes to the README, part 1
Evan Prodromou authored
235 messages.
fae7c08 update the README
Evan Prodromou authored
236 - Facebook library. Used for the Facebook application.
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
237 - PEAR Services_oEmbed. Used for some multimedia integration.
238 - PEAR HTTP_Request is an oEmbed dependency.
7845fe3 typos in README; dependencies
Evan Prodromou authored
239 - PEAR Validate is an oEmbed dependency.
240 - PEAR Net_URL2 is an oEmbed dependency.
10cc0e1 Revert "Revert "note about Console_Getopt""
Evan Prodromou authored
241 - Console_GetOpt for parsing command-line options.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
242
2506207 update README file
Evan Prodromou authored
243 A design goal of StatusNet is that the basic Web functionality should
fbe15ef big changes to the README, part 1
Evan Prodromou authored
244 work on even the most restrictive commercial hosting services.
245 However, additional functionality, such as receiving messages by
246 Jabber/GTalk, require that you be able to run long-running processes
247 on your account. In addition, posting by email or from SMS require
248 that you be able to install a mail filter in your mail server.
249
250 Installation
251 ============
252
2506207 update README file
Evan Prodromou authored
253 Installing the basic StatusNet Web component is relatively easy,
fbe15ef big changes to the README, part 1
Evan Prodromou authored
254 especially if you've previously installed PHP/MySQL packages.
255
256 1. Unpack the tarball you downloaded on your Web server. Usually a
257 command like this will work:
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
258
cf199a9 Evan Prodromou updates to README
evanp authored
259 tar zxf statusnet-0.8.2.tar.gz
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
260
cf199a9 Evan Prodromou updates to README
evanp authored
261 ...which will make a statusnet-0.8.2 subdirectory in your current
fbe15ef big changes to the README, part 1
Evan Prodromou authored
262 directory. (If you don't have shell access on your Web server, you
263 may have to unpack the tarball on your local computer and FTP the
264 files to the server.)
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
265
fbe15ef big changes to the README, part 1
Evan Prodromou authored
266 2. Move the tarball to a directory of your choosing in your Web root
267 directory. Usually something like this will work:
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
268
cf199a9 Evan Prodromou updates to README
evanp authored
269 mv statusnet-0.8.2 /var/www/mublog
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
270
2506207 update README file
Evan Prodromou authored
271 This will make your StatusNet instance available in the mublog path of
fbe15ef big changes to the README, part 1
Evan Prodromou authored
272 your server, like "http://example.net/mublog". "microblog" or
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
273 "statusnet" might also be good path names. If you know how to
fbe15ef big changes to the README, part 1
Evan Prodromou authored
274 configure virtual hosts on your web server, you can try setting up
275 "http://micro.example.net/" or the like.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
276
09ebc96 update README with new install instructions
Evan Prodromou authored
277 3. Make your target directory writeable by the Web server.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
278
09ebc96 update README with new install instructions
Evan Prodromou authored
279 chmod a+w /var/www/mublog/
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
280
fbe15ef big changes to the README, part 1
Evan Prodromou authored
281 On some systems, this will probably work:
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
282
09ebc96 update README with new install instructions
Evan Prodromou authored
283 chgrp www-data /var/www/mublog/
284 chmod g+w /var/www/mublog/
fbe15ef big changes to the README, part 1
Evan Prodromou authored
285
286 If your Web server runs as another user besides "www-data", try
287 that user's default group instead. As a last resort, you can create
09ebc96 update README with new install instructions
Evan Prodromou authored
288 a new group like "mublog" and add the Web server's user to the group.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
289
2246653 Craig Andrews Fixed: The installer checks if the avatar and background directories are...
candrews authored
290 4. You should also take this moment to make your avatar, background, and
291 file subdirectories writeable by the Web server. An insecure way to do
292 this is:
09ebc96 update README with new install instructions
Evan Prodromou authored
293
294 chmod a+w /var/www/mublog/avatar
2246653 Craig Andrews Fixed: The installer checks if the avatar and background directories are...
candrews authored
295 chmod a+w /var/www/mublog/background
296 chmod a+w /var/www/mublog/file
09ebc96 update README with new install instructions
Evan Prodromou authored
297
2246653 Craig Andrews Fixed: The installer checks if the avatar and background directories are...
candrews authored
298 You can also make the avatar, background, and file directories
299 writeable by the Web server group, as noted above.
09ebc96 update README with new install instructions
Evan Prodromou authored
300
301 5. Create a database to hold your microblog data. Something like this
fbe15ef big changes to the README, part 1
Evan Prodromou authored
302 should work:
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
303
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
304 mysqladmin -u "username" --password="password" create statusnet
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
305
2506207 update README file
Evan Prodromou authored
306 Note that StatusNet must have its own database; you can't share the
fbe15ef big changes to the README, part 1
Evan Prodromou authored
307 database with another program. You can name it whatever you want,
308 though.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
309
fbe15ef big changes to the README, part 1
Evan Prodromou authored
310 (If you don't have shell access to your server, you may need to use
311 a tool like PHPAdmin to create a database. Check your hosting
312 service's documentation for how to create a new MySQL database.)
313
2506207 update README file
Evan Prodromou authored
314 6. Create a new database account that StatusNet will use to access the
fbe15ef big changes to the README, part 1
Evan Prodromou authored
315 database. If you have shell access, this will probably work from the
316 MySQL shell:
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
317
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
318 GRANT ALL on statusnet.*
fbe15ef big changes to the README, part 1
Evan Prodromou authored
319 TO 'lacuser'@'localhost'
320 IDENTIFIED BY 'lacpassword';
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
321
fbe15ef big changes to the README, part 1
Evan Prodromou authored
322 You should change 'lacuser' and 'lacpassword' to your preferred new
09ebc96 update README with new install instructions
Evan Prodromou authored
323 username and password. You may want to test logging in to MySQL as
324 this new user.
325
2506207 update README file
Evan Prodromou authored
326 7. In a browser, navigate to the StatusNet install script; something like:
09ebc96 update README with new install instructions
Evan Prodromou authored
327
328 http://yourserver.example.com/mublog/install.php
329
330 Enter the database connection information and your site name. The
331 install program will configure your site and install the initial,
332 almost-empty database.
333
334 8. You should now be able to navigate to your microblog's main directory
335 and see the "Public Timeline", which will be empty. If not, magic
336 has happened! You can now register a new user, post some notices,
337 edit your profile, etc. However, you may want to wait to do that stuff
338 if you think you can set up "fancy URLs" (see below), since some
339 URLs are stored in the database.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
340
fbe15ef big changes to the README, part 1
Evan Prodromou authored
341 Fancy URLs
342 ----------
343
2506207 update README file
Evan Prodromou authored
344 By default, StatusNet will use URLs that include the main PHP program's
09ebc96 update README with new install instructions
Evan Prodromou authored
345 name in them. For example, a user's home profile might be
fbe15ef big changes to the README, part 1
Evan Prodromou authored
346 found at:
347
09ebc96 update README with new install instructions
Evan Prodromou authored
348 http://example.org/mublog/index.php/mublog/fred
349
350 On certain systems that don't support this kind of syntax, they'll
351 look like this:
352
353 http://example.org/mublog/index.php?p=mublog/fred
fbe15ef big changes to the README, part 1
Evan Prodromou authored
354
355 It's possible to configure the software so it looks like this instead:
356
357 http://example.org/mublog/fred
358
359 These "fancy URLs" are more readable and memorable for users. To use
09ebc96 update README with new install instructions
Evan Prodromou authored
360 fancy URLs, you must either have Apache 2.x with .htaccess enabled and
e99e66e Evan Prodromou give some trouble-shooting info for fancy URLs
evanp authored
361 mod_rewrite enabled, -OR- know how to configure "url redirection" in
09ebc96 update README with new install instructions
Evan Prodromou authored
362 your server.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
363
2506207 update README file
Evan Prodromou authored
364 1. Copy the htaccess.sample file to .htaccess in your StatusNet
fbe15ef big changes to the README, part 1
Evan Prodromou authored
365 directory. Note: if you have control of your server's httpd.conf or
366 similar configuration files, it can greatly improve performance to
367 import the .htaccess file into your conf file instead. If you're
368 not sure how to do it, you may save yourself a lot of headache by
369 just leaving the .htaccess file.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
370
fbe15ef big changes to the README, part 1
Evan Prodromou authored
371 2. Change the "RewriteBase" in the new .htaccess file to be the URL path
2506207 update README file
Evan Prodromou authored
372 to your StatusNet installation on your server. Typically this will
373 be the path to your StatusNet directory relative to your Web root.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
374
375 3. Add or uncomment or change a line in your config.php file so it says:
376
377 $config['site']['fancy'] = true;
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
378
fbe15ef big changes to the README, part 1
Evan Prodromou authored
379 You should now be able to navigate to a "fancy" URL on your server,
380 like:
381
382 http://example.net/mublog/main/register
383
384 If you changed your HTTP server configuration, you may need to restart
385 the server first.
386
e99e66e Evan Prodromou give some trouble-shooting info for fancy URLs
evanp authored
387 If it doesn't work, double-check that AllowOverride for the StatusNet
388 directory is 'All' in your Apache configuration file. This is usually
389 /etc/httpd.conf, /etc/apache/httpd.conf, or (on Debian and Ubuntu)
390 /etc/apache2/sites-available/default. See the Apache documentation for
391 .htaccess files for more details:
392
393 http://httpd.apache.org/docs/2.2/howto/htaccess.html
394
395 Also, check that mod_rewrite is installed and enabled:
396
397 http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
398
3a9ef2c sphinx documentation for the provided scripts
millette authored
399 Sphinx
400 ------
401
53c86c4 Brion Vibber Bringing Sphinx search support up to code: broken out to a plugin, now s...
brion authored
402 To use a Sphinx server to search users and notices, you'll need to
403 enable the SphinxSearch plugin. Add to your config.php:
3a9ef2c sphinx documentation for the provided scripts
millette authored
404
53c86c4 Brion Vibber Bringing Sphinx search support up to code: broken out to a plugin, now s...
brion authored
405 addPlugin('SphinxSearch');
406 $config['sphinx']['server'] = 'searchhost.local';
3a9ef2c sphinx documentation for the provided scripts
millette authored
407
53c86c4 Brion Vibber Bringing Sphinx search support up to code: broken out to a plugin, now s...
brion authored
408 You also need to install, compile and enable the sphinx pecl extension for
409 php on the client side, which itself depends on the sphinx development files.
410
411 See plugins/SphinxSearch/README for more details and server setup.
3a9ef2c sphinx documentation for the provided scripts
millette authored
412
fbe15ef big changes to the README, part 1
Evan Prodromou authored
413 SMS
414 ---
415
2506207 update README file
Evan Prodromou authored
416 StatusNet supports a cheap-and-dirty system for sending update messages
fbe15ef big changes to the README, part 1
Evan Prodromou authored
417 to mobile phones and for receiving updates from the mobile. Instead of
418 sending through the SMS network itself, which is costly and requires
419 buy-in from the wireless carriers, it simply piggybacks on the email
420 gateways that many carriers provide to their customers. So, SMS
421 configuration is essentially email configuration.
422
423 Each user sends to a made-up email address, which they keep a secret.
424 Incoming email that is "From" the user's SMS email address, and "To"
425 the users' secret email address on the site's domain, will be
fae7c08 update the README
Evan Prodromou authored
426 converted to a notice and stored in the DB.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
427
428 For this to work, there *must* be a domain or sub-domain for which all
429 (or most) incoming email can pass through the incoming mail filter.
430
2506207 update README file
Evan Prodromou authored
431 1. Run the SQL script carrier.sql in your StatusNet database. This will
fbe15ef big changes to the README, part 1
Evan Prodromou authored
432 usually work:
433
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
434 mysql -u "lacuser" --password="lacpassword" statusnet < db/carrier.sql
fbe15ef big changes to the README, part 1
Evan Prodromou authored
435
436 This will populate your database with a list of wireless carriers
437 that support email SMS gateways.
438
439 2. Make sure the maildaemon.php file is executable:
440
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
441 chmod +x scripts/maildaemon.php
442
fbe15ef big changes to the README, part 1
Evan Prodromou authored
443 Note that "daemon" is kind of a misnomer here; the script is more
444 of a filter than a daemon.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
445
fbe15ef big changes to the README, part 1
Evan Prodromou authored
446 2. Edit /etc/aliases on your mail server and add the following line:
447
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
448 *: /path/to/statusnet/scripts/maildaemon.php
fbe15ef big changes to the README, part 1
Evan Prodromou authored
449
450 3. Run whatever code you need to to update your aliases database. For
451 many mail servers (Postfix, Exim, Sendmail), this should work:
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
452
fbe15ef big changes to the README, part 1
Evan Prodromou authored
453 newaliases
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
454
fbe15ef big changes to the README, part 1
Evan Prodromou authored
455 You may need to restart your mail server for the new database to
456 take effect.
457
458 4. Set the following in your config.php file:
459
460 $config['mail']['domain'] = 'yourdomain.example.net';
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
461
fbe15ef big changes to the README, part 1
Evan Prodromou authored
462 At this point, post-by-email and post-by-SMS-gateway should work. Note
463 that if your mail server is on a different computer from your email
2506207 update README file
Evan Prodromou authored
464 server, you'll need to have a full installation of StatusNet, a working
465 config.php, and access to the StatusNet database from the mail server.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
466
467 XMPP
468 ----
469
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
470 XMPP (eXtended Message and Presence Protocol, <http://xmpp.org/>) is the
fbe15ef big changes to the README, part 1
Evan Prodromou authored
471 instant-messenger protocol that drives Jabber and GTalk IM. You can
472 distribute messages via XMPP using the system below; however, you
473 need to run the XMPP incoming daemon to allow incoming messages as
474 well.
475
476 1. You may want to strongly consider setting up your own XMPP server.
477 Ejabberd, OpenFire, and JabberD are all Open Source servers.
478 Jabber, Inc. provides a high-performance commercial server.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
479
fbe15ef big changes to the README, part 1
Evan Prodromou authored
480 2. You must register a Jabber ID (JID) with your new server. It helps
481 to choose a name like "update@example.com" or "notice" or something
482 similar. Alternately, your "update JID" can be registered on a
483 publicly-available XMPP service, like jabber.org or GTalk.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
484
2506207 update README file
Evan Prodromou authored
485 StatusNet will not register the JID with your chosen XMPP server;
fbe15ef big changes to the README, part 1
Evan Prodromou authored
486 you need to do this manually, with an XMPP client like Gajim,
487 Telepathy, or Pidgin.im.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
488
fbe15ef big changes to the README, part 1
Evan Prodromou authored
489 3. Configure your site's XMPP variables, as described below in the
490 configuration section.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
491
fbe15ef big changes to the README, part 1
Evan Prodromou authored
492 On a default installation, your site can broadcast messages using
493 XMPP. Users won't be able to post messages using XMPP unless you've
494 got the XMPP daemon running. See 'Queues and daemons' below for how
495 to set that up. Also, once you have a sizable number of users, sending
496 a lot of SMS, OMB, and XMPP messages whenever someone posts a message
497 can really slow down your site; it may cause posting to timeout.
498
70f8844 note about stream_select() bug in PHP 5.2.x
Evan Prodromou authored
499 NOTE: stream_select(), a crucial function for network programming, is
500 broken on PHP 5.2.x less than 5.2.6 on amd64-based servers. We don't
2506207 update README file
Evan Prodromou authored
501 work around this bug in StatusNet; current recommendation is to move
70f8844 note about stream_select() bug in PHP 5.2.x
Evan Prodromou authored
502 off of amd64 to another server.
503
fbe15ef big changes to the README, part 1
Evan Prodromou authored
504 Public feed
505 -----------
506
507 You can send *all* messages from your microblogging site to a
508 third-party service using XMPP. This can be useful for providing
509 search, indexing, bridging, or other cool services.
510
511 To configure a downstream site to receive your public stream, add
512 their "JID" (Jabber ID) to your config.php as follows:
513
514 $config['xmpp']['public'][] = 'downstream@example.net';
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
515
fbe15ef big changes to the README, part 1
Evan Prodromou authored
516 (Don't miss those square brackets at the end.) Note that your XMPP
517 broadcasting must be configured as mentioned above. Although you can
518 send out messages at "Web time", high-volume sites should strongly
519 consider setting up queues and daemons.
520
521 Queues and daemons
522 ------------------
523
2506207 update README file
Evan Prodromou authored
524 Some activities that StatusNet needs to do, like broadcast OMB, SMS,
fbe15ef big changes to the README, part 1
Evan Prodromou authored
525 and XMPP messages, can be 'queued' and done by off-line bots instead.
526 For this to work, you must be able to run long-running offline
527 processes, either on your main Web server or on another server you
528 control. (Your other server will still need all the above
529 prerequisites, with the exception of Apache.) Installing on a separate
530 server is probably a good idea for high-volume sites.
531
532 1. You'll need the "CLI" (command-line interface) version of PHP
533 installed on whatever server you use.
534
2506207 update README file
Evan Prodromou authored
535 2. If you're using a separate server for queues, install StatusNet
fbe15ef big changes to the README, part 1
Evan Prodromou authored
536 somewhere on the server. You don't need to worry about the
537 .htaccess file, but make sure that your config.php file is close
538 to, or identical to, your Web server's version.
539
540 3. In your config.php files (both the Web server and the queues
541 server!), set the following variable:
542
543 $config['queue']['enabled'] = true;
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
544
545 You may also want to look at the 'daemon' section of this file for
546 more daemon options. Note that if you set the 'user' and/or 'group'
547 options, you'll need to create that user and/or group by hand.
548 They're not created automatically.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
549
fbe15ef big changes to the README, part 1
Evan Prodromou authored
550 4. On the queues server, run the command scripts/startdaemons.sh. It
551 needs as a parameter the install path; if you run it from the
2506207 update README file
Evan Prodromou authored
552 StatusNet dir, "." should suffice.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
553
ab3c5d6 Updated README with section about installing the Facebook app, and added...
Zach Copley authored
554 This will run eight (for now) queue handlers:
fbe15ef big changes to the README, part 1
Evan Prodromou authored
555
556 * xmppdaemon.php - listens for new XMPP messages from users and stores
557 them as notices in the database.
558 * jabberqueuehandler.php - sends queued notices in the database to
559 registered users who should receive them.
560 * publicqueuehandler.php - sends queued notices in the database to
561 public feed listeners.
562 * ombqueuehandler.php - sends queued notices to OpenMicroBlogging
563 recipients on foreign servers.
564 * smsqueuehandler.php - sends queued notices to SMS-over-email addresses
565 of registered users.
566 * xmppconfirmhandler.php - sends confirmation messages to registered
567 users.
568
569 Note that these queue daemons are pretty raw, and need your care. In
570 particular, they leak memory, and you may want to restart them on a
571 regular (daily or so) basis with a cron job. Also, if they lose
572 the connection to the XMPP server for too long, they'll simply die. It
573 may be a good idea to use a daemon-monitoring service, like 'monit',
574 to check their status and keep them running.
575
576 All the daemons write their process IDs (pids) to /var/run/ by
577 default. This can be useful for starting, stopping, and monitoring the
578 daemons.
579
82b0927 Evan Prodromou update version in README, add note about status.net
evanp authored
580 Since version 0.8.0, it's now possible to use a STOMP server instead of
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
581 our kind of hacky home-grown DB-based queue solution. See the "queues"
582 config section below for how to configure to use STOMP. As of this
583 writing, the software has been tested with ActiveMQ (
584
fbe15ef big changes to the README, part 1
Evan Prodromou authored
585 Sitemaps
586 --------
587
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
588 Sitemap files <http://sitemaps.org/> are a very nice way of telling
fbe15ef big changes to the README, part 1
Evan Prodromou authored
589 search engines and other interested bots what's available on your site
590 and what's changed recently. You can generate sitemap files for your
2506207 update README file
Evan Prodromou authored
591 StatusNet instance.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
592
2506207 update README file
Evan Prodromou authored
593 1. Choose your sitemap URL layout. StatusNet creates a number of
fbe15ef big changes to the README, part 1
Evan Prodromou authored
594 sitemap XML files for different parts of your site. You may want to
2506207 update README file
Evan Prodromou authored
595 put these in a sub-directory of your StatusNet directory to avoid
fbe15ef big changes to the README, part 1
Evan Prodromou authored
596 clutter. The sitemap index file tells the search engines and other
597 bots where to find all the sitemap files; it *must* be in the main
598 installation directory or higher. Both types of file must be
599 available through HTTP.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
600
fbe15ef big changes to the README, part 1
Evan Prodromou authored
601 2. To generate your sitemaps, run the following command on your server:
602
603 php scripts/sitemap.php -f index-file-path -d sitemap-directory -u URL-prefix-for-sitemaps
604
605 Here, index-file-path is the full path to the sitemap index file,
606 like './sitemapindex.xml'. sitemap-directory is the directory where
607 you want the sitemaps stored, like './sitemaps/' (make sure the dir
608 exists). URL-prefix-for-sitemaps is the full URL for the sitemap dir,
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
609 typically something like <http://example.net/mublog/sitemaps/>.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
610
fbe15ef big changes to the README, part 1
Evan Prodromou authored
611 You can use several methods for submitting your sitemap index to
612 search engines to get your site indexed. One is to add a line like the
613 following to your robots.txt file:
614
615 Sitemap: /mublog/sitemapindex.xml
616
617 This is a good idea for letting *all* Web spiders know about your
618 sitemap. You can also submit sitemap files to major search engines
619 using their respective "Webmaster centres"; see sitemaps.org for links
620 to these resources.
621
622 Themes
623 ------
624
2506207 update README file
Evan Prodromou authored
625 There are two themes shipped with this version of StatusNet: "identica",
a1434ee finish the README file
Evan Prodromou authored
626 which is what the Identi.ca site uses, and "default", which is a good
627 basis for other sites.
628
629 As of right now, your ability to change the theme is site-wide; users
630 can't choose their own theme. Additionally, the only thing you can
631 change in the theme is CSS stylesheets and some image files; you can't
632 change the HTML output, like adding or removing menu items.
633
634 You can choose a theme using the $config['site']['theme'] element in
635 the config.php file. See below for details.
636
637 You can add your own theme by making a sub-directory of the 'theme'
638 subdirectory with the name of your theme. Each theme can have the
639 following files:
640
641 display.css: a CSS2 file for "default" styling for all browsers.
642 ie6.css: a CSS2 file for override styling for fixing up Internet
643 Explorer 6.
644 ie7.css: a CSS2 file for override styling for fixing up Internet
645 Explorer 7.
646 logo.png: a logo image for the site.
647 default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
648 users who don't upload their own.
649 default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
650 default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
651 listing on profile pages.
652
653 You may want to start by copying the files from the default theme to
654 your own directory.
655
2506207 update README file
Evan Prodromou authored
656 NOTE: the HTML generated by StatusNet changed *radically* between
fae7c08 update the README
Evan Prodromou authored
657 version 0.6.x and 0.7.x. Older themes will need signification
658 modification to use the new output format.
659
fbe15ef big changes to the README, part 1
Evan Prodromou authored
660 Translation
661 -----------
662
2506207 update README file
Evan Prodromou authored
663 Translations in StatusNet use the gettext system <http://www.gnu.org/software/gettext/>.
a1434ee finish the README file
Evan Prodromou authored
664 Theoretically, you can add your own sub-directory to the locale/
665 subdirectory to add a new language to your system. You'll need to
666 compile the ".po" files into ".mo" files, however.
667
2506207 update README file
Evan Prodromou authored
668 Contributions of translation information to StatusNet are very easy:
669 you can use the Web interface at http://status.net/pootle/ to add one
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
670 or a few or lots of new translations -- or even new languages. You can
671 also download more up-to-date .po files there, if you so desire.
672
673 Backups
674 -------
675
2506207 update README file
Evan Prodromou authored
676 There is no built-in system for doing backups in StatusNet. You can make
677 backups of a working StatusNet system by backing up the database and
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
678 the Web directory. To backup the database use mysqldump <http://ur1.ca/7xo>
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
679 and to backup the Web directory, try tar.
680
203bc45 Evan Prodromou documentation and version number
evanp authored
681 Private
682 -------
683
684 The administrator can set the "private" flag for a site so that it's
685 not visible to non-logged-in users. This might be useful for
686 workgroups who want to share a microblogging site for project
687 management, but host it on a public server.
688
689 Note that this is an experimental feature; total privacy is not
690 guaranteed or ensured. Also, privacy is all-or-nothing for a site; you
691 can't have some accounts or notices private, and others public.
692 Finally, the interaction of private sites with OpenMicroBlogging is
693 undefined. Remote users won't be able to subscribe to users on a
694 private site, but users of the private site may be able to subscribe
695 to users on a remote site. (Or not... it's not well tested.) The
696 "proper behaviour" hasn't been defined here, so handle with care.
697
f36162b Evan Prodromou Revert "Revert "Added bit about being incompatible with file attachment ...
evanp authored
698 If fancy URLs is enabled, access to file attachments can also be
699 restricted to logged-in users only. Uncomment the appropriate rewrite
65cbf05 Evan Prodromou Revert "Revert "Added some explanatory text to README""
evanp authored
700 <<<<<<< HEAD:README
f36162b Evan Prodromou Revert "Revert "Added bit about being incompatible with file attachment ...
evanp authored
701 rule in .htaccess or your server's httpd.conf. (This most likely will
702 not work if you are using a virtual server for attachments, so consider
703 the performance/security tradeoff.)
65cbf05 Evan Prodromou Revert "Revert "Added some explanatory text to README""
evanp authored
704 =======
705 rule in .htaccess or your server's httpd.conf.
706 >>>>>>> 446de62... Revert "Added some explanatory text to README":README
f36162b Evan Prodromou Revert "Revert "Added bit about being incompatible with file attachment ...
evanp authored
707
fbe15ef big changes to the README, part 1
Evan Prodromou authored
708 Upgrading
709 =========
710
2506207 update README file
Evan Prodromou authored
711 IMPORTANT NOTE: StatusNet 0.7.4 introduced a fix for some
121cb6a document utf8 problems and solutions
Evan Prodromou authored
712 incorrectly-stored international characters ("UTF-8"). For new
713 installations, it will now store non-ASCII characters correctly.
714 However, older installations will have the incorrect storage, and will
715 consequently show up "wrong" in browsers. See below for how to deal
716 with this situation.
717
2506207 update README file
Evan Prodromou authored
718 If you've been using StatusNet 0.7, 0.6, 0.5 or lower, or if you've
8bdb7dc update the README with new information
Evan Prodromou authored
719 been tracking the "git" version of the software, you will probably
720 want to upgrade and keep your existing data. There is no automated
cf199a9 Evan Prodromou updates to README
evanp authored
721 upgrade procedure in StatusNet 0.8.2. Try these step-by-step
8bdb7dc update the README with new information
Evan Prodromou authored
722 instructions; read to the end first before trying them.
a1434ee finish the README file
Evan Prodromou authored
723
2506207 update README file
Evan Prodromou authored
724 0. Download StatusNet and set up all the prerequisites as if you were
a1434ee finish the README file
Evan Prodromou authored
725 doing a new install.
726 1. Make backups of both your database and your Web directory. UNDER NO
727 CIRCUMSTANCES should you try to do an upgrade without a known-good
728 backup. You have been warned.
729 2. Shut down Web access to your site, either by turning off your Web
730 server or by redirecting all pages to a "sorry, under maintenance"
731 page.
732 3. Shut down XMPP access to your site, typically by shutting down the
733 xmppdaemon.php process and all other daemons that you're running.
734 If you've got "monit" or "cron" automatically restarting your
735 daemons, make sure to turn that off, too.
736 4. Shut down SMS and email access to your site. The easy way to do
737 this is to comment out the line piping incoming email to your
738 maildaemon.php file, and running something like "newaliases".
739 5. Once all writing processes to your site are turned off, make a
740 final backup of the Web directory and database.
2506207 update README file
Evan Prodromou authored
741 6. Move your StatusNet directory to a backup spot, like "mublog.bak".
cf199a9 Evan Prodromou updates to README
evanp authored
742 7. Unpack your StatusNet 0.8.2 tarball and move it to "mublog" or
a1434ee finish the README file
Evan Prodromou authored
743 wherever your code used to be.
744 8. Copy the config.php file and avatar directory from your old
745 directory to your new directory.
746 9. Copy htaccess.sample to .htaccess in the new directory. Change the
747 RewriteBase to use the correct path.
82b0927 Evan Prodromou update version in README, add note about status.net
evanp authored
748 10. Rebuild the database. (You can safely skip this step and go to #12
749 if you're upgrading from another 0.8.x version).
750
751 NOTE: this step is destructive and cannot be
8bdb7dc update the README with new information
Evan Prodromou authored
752 reversed. YOU CAN EASILY DESTROY YOUR SITE WITH THIS STEP. Don't
753 do it without a known-good backup!
754
755 If your database is at version 0.7.4, you can run a special upgrade
756 script:
757
758 mysql -u<rootuser> -p<rootpassword> <database> db/074to080.sql
759
2506207 update README file
Evan Prodromou authored
760 Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
8bdb7dc update the README with new information
Evan Prodromou authored
761 BACKUP run the rebuilddb.sh script like this:
a89d7ce Ciaran Gultnieks PostgreSQL - added equivalent of the MySQL-specific rebuilddb.sh script,...
CiaranG authored
762
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
763 ./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
a89d7ce Ciaran Gultnieks PostgreSQL - added equivalent of the MySQL-specific rebuilddb.sh script,...
CiaranG authored
764
765 Here, rootuser and rootpassword are the username and password for a
766 user who can drop and create databases as well as tables; typically
2506207 update README file
Evan Prodromou authored
767 that's _not_ the user StatusNet runs as. Note that rebuilddb.sh drops
8bdb7dc update the README with new information
Evan Prodromou authored
768 your database and rebuilds it; if there is an error you have no
769 database. Make sure you have a backup.
a89d7ce Ciaran Gultnieks PostgreSQL - added equivalent of the MySQL-specific rebuilddb.sh script,...
CiaranG authored
770 For PostgreSQL databases there is an equivalent, rebuilddb_psql.sh,
771 which operates slightly differently. Read the documentation in that
772 script before running it.
773 11. Use mysql or psql client to log into your database and make sure that
774 the notice, user, profile, subscription etc. tables are non-empty.
a1434ee finish the README file
Evan Prodromou authored
775 12. Turn back on the Web server, and check that things still work.
776 13. Turn back on XMPP bots and email maildaemon. Note that the XMPP
777 bots have changed since version 0.5; see above for details.
778
779 If you're upgrading from very old versions, you may want to look at
780 the fixup_* scripts in the scripts directories. These will store some
169b3e0 Evan Prodromou add documentation on notice inboxes
evanp authored
781 precooked data in the DB. All upgraders should check out the inboxes
782 options below.
a1434ee finish the README file
Evan Prodromou authored
783
82b0927 Evan Prodromou update version in README, add note about status.net
evanp authored
784 NOTE: the database definition file, laconica.ini, has been renamed to
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
785 statusnet.ini (since this is the recommended database name). If you
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
786 have a line in your config.php pointing to the old name, you'll need
787 to update it.
788
169b3e0 Evan Prodromou add documentation on notice inboxes
evanp authored
789 Notice inboxes
790 --------------
791
4f5badd Evan Prodromou remove inboxes option
evanp authored
792 Notice inboxes are now required. If you don't have inboxes enabled,
793 StatusNet will no longer run.
8bdb7dc update the README with new information
Evan Prodromou authored
794
121cb6a document utf8 problems and solutions
Evan Prodromou authored
795 UTF-8 Database
796 --------------
797
2506207 update README file
Evan Prodromou authored
798 StatusNet 0.7.4 introduced a fix for some incorrectly-stored
121cb6a document utf8 problems and solutions
Evan Prodromou authored
799 international characters ("UTF-8"). This fix is not
800 backwards-compatible; installations from before 0.7.4 will show
801 non-ASCII characters of old notices incorrectly. This section explains
802 what to do.
803
804 0. You can disable the new behaviour by setting the 'db''utf8' config
805 option to "false". You should only do this until you're ready to
806 convert your DB to the new format.
807 1. When you're ready to convert, you can run the fixup_utf8.php script
808 in the scripts/ subdirectory. If you've had the "new behaviour"
809 enabled (probably a good idea), you can give the ID of the first
810 "new" notice as a parameter, and only notices before that one will
811 be converted. Notices are converted in reverse chronological order,
812 so the most recent (and visible) ones will be converted first. The
813 script should work whether or not you have the 'db''utf8' config
814 option enabled.
815 2. When you're ready, set $config['db']['utf8'] to true, so that
816 new notices will be stored correctly.
817
fbe15ef big changes to the README, part 1
Evan Prodromou authored
818 Configuration options
819 =====================
820
2506207 update README file
Evan Prodromou authored
821 The main configuration file for StatusNet (excepting configurations for
822 dependency software) is config.php in your StatusNet directory. If you
fbe15ef big changes to the README, part 1
Evan Prodromou authored
823 edit any other file in the directory, like lib/common.php (where most
824 of the defaults are defined), you will lose your configuration options
825 in any upgrade, and you will wish that you had been more careful.
826
74bf2bf Enable configuration files in /etc/laconica/
Evan Prodromou authored
827 Starting with version 0.7.1, you can put config files in the
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
828 /etc/statusnet/ directory on your server, if it exists. Config files
74bf2bf Enable configuration files in /etc/laconica/
Evan Prodromou authored
829 will be included in this order:
830
e3a5325 last scrub of Laconica -> StatusNet
Evan Prodromou authored
831 * /etc/statusnet/statusnet.php - server-wide config
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
832 * /etc/statusnet/<servername>.php - for a virtual host
833 * /etc/statusnet/<servername>_<pathname>.php - for a path
74bf2bf Enable configuration files in /etc/laconica/
Evan Prodromou authored
834 * INSTALLDIR/config.php - for a particular implementation
835
fbe15ef big changes to the README, part 1
Evan Prodromou authored
836 Almost all configuration options are made through a two-dimensional
837 associative array, cleverly named $config. A typical configuration
838 line will be:
839
840 $config['section']['option'] = value;
841
842 For brevity, the following documentation describes each section and
843 option.
844
845 site
846 ----
847
848 This section is a catch-all for site-wide variables.
849
850 name: the name of your site, like 'YourCompany Microblog'.
851 server: the server part of your site's URLs, like 'example.net'.
78519c4 Ciaran Gultnieks Fixed an error in the README - path setting for installed in root is '',...
CiaranG authored
852 path: The path part of your site's URLs, like 'mublog' or ''
fbe15ef big changes to the README, part 1
Evan Prodromou authored
853 (installed in root).
854 fancy: whether or not your site uses fancy URLs (see Fancy URLs
855 section above). Default is false.
2506207 update README file
Evan Prodromou authored
856 logfile: full path to a file for StatusNet to save logging
fbe15ef big changes to the README, part 1
Evan Prodromou authored
857 information to. You may want to use this if you don't have
858 access to syslog.
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
859 logdebug: whether to log additional debug info like backtraces on
860 hard errors. Default false.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
861 locale_path: full path to the directory for locale data. Unless you
862 store all your locale data in one place, you probably
863 don't need to use this.
864 language: default language for your site. Defaults to US English.
908deed Ciaran Gultnieks Added documentation in the README for what the 'language' setting actual...
CiaranG authored
865 Note that this is overridden if a user is logged in and has
866 selected a different language. It is also overridden if the
867 user is NOT logged in, but their browser requests a different
868 langauge. Since pretty much everybody's browser requests a
869 language, that means that changing this setting has little or
870 no effect in practice.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
871 languages: A list of languages supported on your site. Typically you'd
872 only change this if you wanted to disable support for one
873 or another language:
874 "unset($config['site']['languages']['de'])" will disable
875 support for German.
876 theme: Theme for your site (see Theme section). Two themes are
877 provided by default: 'default' and 'stoica' (the one used by
878 Identi.ca). It's appreciated if you don't use the 'stoica' theme
879 except as the basis for your own.
880 email: contact email address for your site. By default, it's extracted
881 from your Web server environment; you may want to customize it.
882 broughtbyurl: name of an organization or individual who provides the
883 service. Each page will include a link to this name in the
884 footer. A good way to link to the blog, forum, wiki,
885 corporate portal, or whoever is making the service available.
886 broughtby: text used for the "brought by" link.
887 timezone: default timezone for message display. Users can set their
888 own time zone. Defaults to 'UTC', which is a pretty good default.
889 closed: If set to 'true', will disallow registration on your site.
890 This is a cheap way to restrict accounts to only one
891 individual or group; just register the accounts you want on
892 the service, *then* set this variable to 'true'.
3a246c1 add 'invite-only' mode for registration
Evan Prodromou authored
893 inviteonly: If set to 'true', will only allow registration if the user
894 was invited by an existing user.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
895 private: If set to 'true', anonymous users will be redirected to the
896 'login' page. Also, API methods that normally require no
203bc45 Evan Prodromou documentation and version number
evanp authored
897 authentication will require it. Note that this does not turn
898 off registration; use 'closed' or 'inviteonly' for the
899 behaviour you want.
65bfda3 Documented the site notice option.
Evan Prodromou authored
900 notice: A plain string that will appear on every page. A good place
901 to put introductory information about your service, or info about
902 upgrades and outages, or other community info. Any HTML will
903 be escaped.
70d5fc4 Document the site-logo configuration option
Evan Prodromou authored
904 logo: URL of an image file to use as the logo for the site. Overrides
905 the logo in the theme, if any.
07eae0c Support SSL for some, all, or no pages
Evan Prodromou authored
906 ssl: Whether to use SSL and https:// URLs for some or all pages.
907 Possible values are 'always' (use it for all pages), 'never'
908 (don't use it for any pages), or 'sometimes' (use it for
909 sensitive pages that include passwords like login and registration,
910 but not for regular pages). Default to 'never'.
911 sslserver: use an alternate server name for SSL URLs, like
912 'secure.example.org'. You should be careful to set cookie
913 parameters correctly so that both the SSL server and the
914 "normal" server can access the session cookie and
915 preferably other cookies as well.
b416df9 Jeff Mitchell Add site-wide option to change the length at which URLs are auto-shorten...
jefferai authored
916 shorturllength: Length of URL at which URLs in a message exceeding 140
917 characters will be sent to the user's chosen
918 shortening service.
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
919 dupelimit: minimum time allowed for one person to say the same thing
920 twice. Default 60s. Anything lower is considered a user
921 or UI error.
9828c64 0 means no limit for text (distinct from null)
Evan Prodromou authored
922 textlimit: default max size for texts in the site. Defaults to 140.
923 0 means no limit. Can be fine-tuned for notices, messages,
a28bbdf configuration options for text limits
Evan Prodromou authored
924 profile bios and group descriptions.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
925
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
926 db
927 --
928
929 This section is a reference to the configuration options for
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
930 DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
931 set are listed below for clarity.
932
2506207 update README file
Evan Prodromou authored
933 database: a DSN (Data Source Name) for your StatusNet database. This is
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
934 in the format 'protocol://username:password@hostname/databasename',
203bc45 Evan Prodromou documentation and version number
evanp authored
935 where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
936 really know what you're doing), 'username' is the username,
937 'password' is the password, and etc.
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
938 ini_yourdbname: if your database is not named 'statusnet', you'll need
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
939 to set this to point to the location of the
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
940 statusnet.ini file. Note that the real name of your database
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
941 should go in there, not literally 'yourdbname'.
942 db_driver: You can try changing this to 'MDB2' to use the other driver
943 type for DB_DataObject, but note that it breaks the OpenID
944 libraries, which only support PEAR::DB.
945 debug: On a database error, you may get a message saying to set this
946 value to 5 to see debug messages in the browser. This breaks
947 just about all pages, and will also expose the username and
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
948 password
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
949 quote_identifiers: Set this to true if you're using postgresql.
950 type: either 'mysql' or 'postgresql' (used for some bits of
951 database-type-specific SQL in the code). Defaults to mysql.
952 mirror: you can set this to an array of DSNs, like the above
953 'database' value. If it's set, certain read-only actions will
954 use a random value out of this array for the database, rather
955 than the one in 'database' (actually, 'database' is overwritten).
956 You can offload a busy DB server by setting up MySQL replication
957 and adding the slaves to this array. Note that if you want some
958 requests to go to the 'database' (master) server, you'll need
959 to include it in this array, too.
d068680 optionally use SET NAMES for utf8 to DB
Evan Prodromou authored
960 utf8: whether to talk to the database in UTF-8 mode. This is the default
961 with new installations, but older sites may want to turn it off
962 until they get their databases fixed up. See "UTF-8 database"
963 above for details.
d103522 Evan Prodromou check the schema
evanp authored
964 schemacheck: when to let plugins check the database schema to add
965 tables or update them. Values can be 'runtime' (default)
966 or 'script'. 'runtime' can be costly (plugins check the
967 schema on every hit, adding potentially several db
968 queries, some quite long), but not everyone knows how to
969 run a script. If you can, set this to 'script' and run
970 scripts/checkschema.php whenever you install or upgrade a
971 plugin.
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
972
fbe15ef big changes to the README, part 1
Evan Prodromou authored
973 syslog
974 ------
975
2506207 update README file
Evan Prodromou authored
976 By default, StatusNet sites log error messages to the syslog facility.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
977 (You can override this using the 'logfile' parameter described above).
978
2506207 update README file
Evan Prodromou authored
979 appname: The name that StatusNet uses to log messages. By default it's
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
980 "statusnet", but if you have more than one installation on the
fbe15ef big changes to the README, part 1
Evan Prodromou authored
981 server, you may want to change the name for each instance so
982 you can track log messages more easily.
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
983 priority: level to log at. Currently ignored.
984 facility: what syslog facility to used. Defaults to LOG_USER, only
985 reset if you know what syslog is and have a good reason
986 to change it.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
987
988 queue
989 -----
990
991 You can configure the software to queue time-consuming tasks, like
992 sending out SMS email or XMPP messages, for off-line processing. See
993 'Queues and daemons' above for how to set this up.
994
a1434ee finish the README file
Evan Prodromou authored
995 enabled: Whether to uses queues. Defaults to false.
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
996 subsystem: Which kind of queueserver to use. Values include "db" for
997 our hacked-together database queuing (no other server
998 required) and "stomp" for a stomp server.
999 stomp_server: "broker URI" for stomp server. Something like
1000 "tcp://hostname:61613". More complicated ones are
1001 possible; see your stomp server's documentation for
1002 details.
1003 queue_basename: a root name to use for queues (stomp only). Typically
1004 something like '/queue/sitename/' makes sense.
1005 stomp_username: username for connecting to the stomp server; defaults
1006 to null.
1007 stomp_password: password for connecting to the stomp server; defaults
1008 to null.
a1434ee finish the README file
Evan Prodromou authored
1009 license
1010 -------
1011
1012 The default license to use for your users notices. The default is the
1013 Creative Commons Attribution 3.0 license, which is probably the right
1014 choice for any public site. Note that some other servers will not
1015 accept notices if you apply a stricter license than this.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1016
a1434ee finish the README file
Evan Prodromou authored
1017 url: URL of the license, used for links.
1018 title: Title for the license, like 'Creative Commons Attribution 3.0'.
1019 image: A button shown on each page for the license.
1020
1021 mail
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1022 ----
1023
a1434ee finish the README file
Evan Prodromou authored
1024 This is for configuring out-going email. We use PEAR's Mail module,
1025 see: http://pear.php.net/manual/en/package.mail.mail.factory.php
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1026
a1434ee finish the README file
Evan Prodromou authored
1027 backend: the backend to use for mail, one of 'mail', 'sendmail', and
1028 'smtp'. Defaults to PEAR's default, 'mail'.
1029 params: if the mail backend requires any parameters, you can provide
1030 them in an associative array.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
1031
a1434ee finish the README file
Evan Prodromou authored
1032 nickname
1033 --------
1034
1035 This is for configuring nicknames in the service.
1036
1037 blacklist: an array of strings for usernames that may not be
1038 registered. A default array exists for strings that are
2506207 update README file
Evan Prodromou authored
1039 used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
a1434ee finish the README file
Evan Prodromou authored
1040 but you may want to add others if you have other software
2506207 update README file
Evan Prodromou authored
1041 installed in a subdirectory of StatusNet or if you just
a1434ee finish the README file
Evan Prodromou authored
1042 don't want certain words used as usernames.
7557079 Evan Prodromou add new config variables
evanp authored
1043 featured: an array of nicknames of 'featured' users of the site.
1044 Can be useful to draw attention to well-known users, or
1045 interesting people, or whatever.
a1434ee finish the README file
Evan Prodromou authored
1046
1047 avatar
1048 ------
1049
1050 For configuring avatar access.
1051
c077ad0 Configurable avatar directory
Evan Prodromou authored
1052 dir: Directory to look for avatar files and to put them into.
1053 Defaults to avatar subdirectory of install directory; if
1054 you change it, make sure to change path, too.
1055 path: Path to avatars. Defaults to path for avatar subdirectory,
1056 but you can change it if you wish. Note that this will
1057 be included with the avatar server, too.
a1434ee finish the README file
Evan Prodromou authored
1058 server: If set, defines another server where avatars are stored in the
1059 root directory. Note that the 'avatar' subdir still has to be
1060 writeable. You'd typically use this to split HTTP requests on
1061 the client to speed up page loading, either with another
1062 virtual server or with an NFS or SAMBA share. Clients
1063 typically only make 2 connections to a single server at a
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
1064 time <http://ur1.ca/6ih>, so this can parallelize the job.
a1434ee finish the README file
Evan Prodromou authored
1065 Defaults to null.
1066
1067 public
1068 ------
1069
1070 For configuring the public stream.
1071
1072 localonly: If set to true, only messages posted by users of this
1073 service (rather than other services, filtered through OMB)
1074 are shown in the public stream. Default true.
7557079 Evan Prodromou add new config variables
evanp authored
1075 blacklist: An array of IDs of users to hide from the public stream.
1076 Useful if you have someone making excessive Twitterfeed posts
1077 to the site, other kinds of automated posts, testing bots, etc.
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
1078 autosource: Sources of notices that are from automatic posters, and thus
1079 should be kept off the public timeline. Default empty.
a1434ee finish the README file
Evan Prodromou authored
1080
1081 theme
1082 -----
1083
1084 server: Like avatars, you can speed up page loading by pointing the
7cf0a4c theme dir, path configurable
Evan Prodromou authored
1085 theme file lookup to another server (virtual or real).
1086 Defaults to NULL, meaning to use the site server.
1087 dir: Directory where theme files are stored. Used to determine
1088 whether to show parts of a theme file. Defaults to the theme
1089 subdirectory of the install directory.
1090 path: Path part of theme URLs, before the theme name. Relative to the
1091 theme server. It may make sense to change this path when upgrading,
1092 (using version numbers as the path) to make sure that all files are
1093 reloaded by caching clients or proxies. Defaults to null,
1094 which means to use the site path + '/theme'.
a1434ee finish the README file
Evan Prodromou authored
1095
1096 xmpp
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1097 ----
1098
a1434ee finish the README file
Evan Prodromou authored
1099 For configuring the XMPP sub-system.
1100
1101 enabled: Whether to accept and send messages by XMPP. Default false.
1102 server: server part of XMPP ID for update user.
1103 port: connection port for clients. Default 5222, which you probably
1104 shouldn't need to change.
1105 user: username for the client connection. Users will receive messages
1106 from 'user'@'server'.
1107 resource: a unique identifier for the connection to the server. This
1108 is actually used as a prefix for each XMPP component in the system.
1109 password: password for the user account.
1110 host: some XMPP domains are served by machines with a different
1111 hostname. (For example, @gmail.com GTalk users connect to
1112 talk.google.com). Set this to the correct hostname if that's the
1113 case with your server.
2506207 update README file
Evan Prodromou authored
1114 encryption: Whether to encrypt the connection between StatusNet and the
a1434ee finish the README file
Evan Prodromou authored
1115 XMPP server. Defaults to true, but you can get
1116 considerably better performance turning it off if you're
1117 connecting to a server on the same machine or on a
1118 protected network.
1119 debug: if turned on, this will make the XMPP library blurt out all of
1120 the incoming and outgoing messages as XML stanzas. Use as a
1121 last resort, and never turn it on if you don't have queues
1122 enabled, since it will spit out sensitive data to the browser.
1123 public: an array of JIDs to send _all_ notices to. This is useful for
1124 participating in third-party search and archiving services.
1125
6d308f6 Jeffery To Adds $config['invite']['enabled'] to enable/disable invites.
jefferyto authored
1126 invite
1127 ------
1128
1129 For configuring invites.
1130
1131 enabled: Whether to allow users to send invites. Default true.
1132
a1434ee finish the README file
Evan Prodromou authored
1133 tag
1134 ---
1135
1136 Miscellaneous tagging stuff.
1137
1138 dropoff: Decay factor for tag listing, in seconds.
1139 Defaults to exponential decay over ten days; you can twiddle
1140 with it to try and get better results for your site.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
1141
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
1142 popular
1143 -------
1144
1145 Settings for the "popular" section of the site.
1146
1147 dropoff: Decay factor for popularity listing, in seconds.
1148 Defaults to exponential decay over ten days; you can twiddle
1149 with it to try and get better results for your site.
1150
a1434ee finish the README file
Evan Prodromou authored
1151 daemon
1152 ------
1153
1154 For daemon processes.
1155
1156 piddir: directory that daemon processes should write their PID file
1157 (process ID) to. Defaults to /var/run/, which is where this
1158 stuff should usually go on Unix-ish systems.
1159 user: If set, the daemons will try to change their effective user ID
1160 to this user before running. Probably a good idea, especially if
1161 you start the daemons as root. Note: user name, like 'daemon',
1162 not 1001.
1163 group: If set, the daemons will try to change their effective group ID
1164 to this named group. Again, a name, not a numerical ID.
1165
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
1166 memcached
1167 ---------
1168
1169 You can get a significant boost in performance by caching some
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
1170 database data in memcached <http://www.danga.com/memcached/>.
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
1171
1172 enabled: Set to true to enable. Default false.
1173 server: a string with the hostname of the memcached server. Can also
1174 be an array of hostnames, if you've got more than one server.
fd290fc allow a configured base for cache keys
Evan Prodromou authored
1175 base: memcached uses key-value pairs to store data. We build long,
1176 funny-looking keys to make sure we don't have any conflicts. The
1177 base of the key is usually a simplified version of the site name
1178 (like "Identi.ca" => "identica"), but you can overwrite this if
1179 you need to. You can safely ignore it if you only have one
2506207 update README file
Evan Prodromou authored
1180 StatusNet site using your memcached server.
fd290fc allow a configured base for cache keys
Evan Prodromou authored
1181 port: Port to connect to; defaults to 11211.
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
1182
5f293f0 Jeffery To Added configuration option to disable post-by-email.
jefferyto authored
1183 emailpost
1184 ---------
1185
1186 For post-by-email.
1187
1188 enabled: Whether to enable post-by-email. Defaults to true. You will
1189 also need to set up maildaemon.php.
1190
93f5854 Jeffery To Added configuration options to enable/disable SMS and Twitter integratio...
jefferyto authored
1191 sms
1192 ---
1193
1194 For SMS integration.
1195
1196 enabled: Whether to enable SMS integration. Defaults to true. Queues
1197 should also be enabled.
1198
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
1199 integration
1200 -----------
1201
1202 A catch-all for integration with other systems.
1203
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
1204 taguri: base for tag:// URIs. Defaults to site-server + ',2009'.
728f6f2 update README with info about 0.6.1 plus some forgotten stuff
Evan Prodromou authored
1205
169b3e0 Evan Prodromou add documentation on notice inboxes
evanp authored
1206 inboxes
1207 -------
1208
1209 For notice inboxes.
1210
4f5badd Evan Prodromou remove inboxes option
evanp authored
1211 enabled: No longer used. If you set this to something other than true,
1212 StatusNet will no longer run.
169b3e0 Evan Prodromou add documentation on notice inboxes
evanp authored
1213
203bc45 Evan Prodromou documentation and version number
evanp authored
1214 throttle
1215 --------
1216
1217 For notice-posting throttles.
1218
1219 enabled: Whether to throttle posting. Defaults to false.
1220 count: Each user can make this many posts in 'timespan' seconds. So, if count
1221 is 100 and timespan is 3600, then there can be only 100 posts
1222 from a user every hour.
1223 timespan: see 'count'.
1224
1225 profile
1226 -------
1227
1228 Profile management.
1229
1230 banned: an array of usernames and/or profile IDs of 'banned' profiles.
1231 The site will reject any notices by these users -- they will
1232 not be accepted at all. (Compare with blacklisted users above,
1233 whose posts just won't show up in the public stream.)
9828c64 0 means no limit for text (distinct from null)
Evan Prodromou authored
1234 biolimit: max character length of bio; 0 means no limit; null means to use
1235 the site text limit default.
203bc45 Evan Prodromou documentation and version number
evanp authored
1236
fe426a3 welcome notice, default sub for new users
Evan Prodromou authored
1237 newuser
1238 -------
1239
1240 Options with new users.
1241
e00508d correct setting for default user
Evan Prodromou authored
1242 default: nickname of a user account to automatically subscribe new
1243 users to. Typically this would be system account for e.g.
1244 service updates or announcements. Users are able to unsub
1245 if they want. Default is null; no auto subscribe.
fe426a3 welcome notice, default sub for new users
Evan Prodromou authored
1246 welcome: nickname of a user account that sends welcome messages to new
6afda46 Ciaran Gultnieks Corrected error in README relating to ['newuser']['welcome']
CiaranG authored
1247 users. Can be the same as 'default' account, although on
fe426a3 welcome notice, default sub for new users
Evan Prodromou authored
1248 busy servers it may be a good idea to keep that one just for
1249 'urgent' messages. Default is null; no message.
1250
3e3fec3 Ciaran Gultnieks Clarification in README regarding welcome/default users, as it has tripp...
CiaranG authored
1251 If either of these special user accounts are specified, the users should
1252 be created before the configuration is updated.
1253
b233e7b document snapshot options
Evan Prodromou authored
1254 snapshot
1255 --------
1256
1257 The software will, by default, send statistical snapshots about the
2506207 update README file
Evan Prodromou authored
1258 local installation to a stats server on the status.net Web site. This
b233e7b document snapshot options
Evan Prodromou authored
1259 data is used by the developers to prioritize development decisions. No
1260 identifying data about users or organizations is collected. The data
1261 is available to the public for review. Participating in this survey
2506207 update README file
Evan Prodromou authored
1262 helps StatusNet developers take your needs into account when updating
b233e7b document snapshot options
Evan Prodromou authored
1263 the software.
1264
1265 run: string indicating when to run the statistics. Values can be 'web'
1266 (run occasionally at Web time), 'cron' (run from a cron script),
1267 or 'never' (don't ever run). If you set it to 'cron', remember to
1268 schedule the script to run on a regular basis.
1269 frequency: if run value is 'web', how often to report statistics.
1270 Measured in Web hits; depends on how active your site is.
1271 Default is 10000 -- that is, one report every 10000 Web hits,
1272 on average.
2506207 update README file
Evan Prodromou authored
1273 reporturl: URL to post statistics to. Defaults to StatusNet developers'
b233e7b document snapshot options
Evan Prodromou authored
1274 report system, but if they go evil or disappear you may
1275 need to update this to another value. Note: if you
1276 don't want to report stats, it's much better to
1277 set 'run' to 'never' than to set this value to something
1278 nonsensical.
1279
ebeb5f7 Merge branch '0.8.x' of git@gitorious.org:+laconica-developers/laconica/...
Robin Millette authored
1280 attachments
1281 -----------
1282
1283 The software lets users upload files with their notices. You can configure
1284 the types of accepted files by mime types and a trio of quota options:
1285 per file, per user (total), per user per month.
1286
abe68f4 Added attachments config descriptions to README.
Robin Millette authored
1287 We suggest the use of the pecl file_info extension to handle mime type
1288 detection.
1289
ebeb5f7 Merge branch '0.8.x' of git@gitorious.org:+laconica-developers/laconica/...
Robin Millette authored
1290 supported: an array of mime types you accept to store and distribute,
abe68f4 Added attachments config descriptions to README.
Robin Millette authored
1291 like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
1292 setup your server to properly recognize the types you want to
abe68f4 Added attachments config descriptions to README.
Robin Millette authored
1293 support.
b58dc5e Added config option to enable or disable file uploads with notices.
Robin Millette authored
1294 uploads: false to disable uploading files with notices (true by default).
7bcaa85 make file command configurable
Evan Prodromou authored
1295 filecommand: The required MIME_Type library may need to use the 'file'
1296 command. It tries the one in the Web server's path, but if
1297 you're having problems with uploads, try setting this to the
1298 correct value. Note: 'file' must accept '-b' and '-i' options.
abe68f4 Added attachments config descriptions to README.
Robin Millette authored
1299
1300 For quotas, be sure you've set the upload_max_filesize and post_max_size
1301 in php.ini to be large enough to handle your upload. In httpd.conf
1302 (if you're using apache), check that the LimitRequestBody directive isn't
1303 set too low (it's optional, so it may not be there at all).
1304
1305 file_quota: maximum size for a single file upload in bytes. A user can send
1306 any amount of notices with attachments as long as each attachment
1307 is smaller than file_quota.
1308 user_quota: total size in bytes a user can store on this server. Each user
1309 can store any number of files as long as their total size does
1310 not exceed the user_quota.
1311 monthly_quota: total size permitted in the current month. This is the total
1312 size in bytes that a user can upload each month.
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
1313 dir: directory accessible to the Web process where uploads should go.
1314 Defaults to the 'file' subdirectory of the install directory, which
1315 should be writeable by the Web user.
1316 server: server name to use when creating URLs for uploaded files.
1317 Defaults to null, meaning to use the default Web server. Using
1318 a virtual server here can speed up Web performance.
1319 path: URL path, relative to the server, to find files. Defaults to
1320 main path + '/file/'.
1321 filecommand: command to use for determining the type of a file. May be
1322 skipped if fileinfo extension is installed. Defaults to
1323 '/usr/bin/file'.
ebeb5f7 Merge branch '0.8.x' of git@gitorious.org:+laconica-developers/laconica/...
Robin Millette authored
1324
ecbd771 Code for adding and saving group aliases
Evan Prodromou authored
1325 group
1326 -----
1327
1328 Options for group functionality.
1329
1330 maxaliases: maximum number of aliases a group can have. Default 3. Set
1331 to 0 or less to prevent aliases in a group.
a28bbdf configuration options for text limits
Evan Prodromou authored
1332 desclimit: maximum number of characters to allow in group descriptions.
9828c64 0 means no limit for text (distinct from null)
Evan Prodromou authored
1333 null (default) means to use the site-wide text limits. 0
1334 means no limit.
ebeb5f7 Merge branch '0.8.x' of git@gitorious.org:+laconica-developers/laconica/...
Robin Millette authored
1335
28d02ec Make oohembed endpoint configurable.
Robin Millette authored
1336 oohembed
1337 --------
1338
1339 oEmbed endpoint for multimedia attachments (links in posts).
1340
1341 endpoint: oohembed endpoint using http://oohembed.com/ software.
1342
876ab05 Add like for search
Evan Prodromou authored
1343 search
1344 ------
1345
1346 Some stuff for search.
1347
1348 type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
1349 be 'fulltext' (default) or 'like'. The former is faster and more efficient
1350 but requires the lame old MyISAM engine for MySQL. The latter
1351 will work with InnoDB but could be miserably slow on large
1352 systems. We'll probably add another type sometime in the future,
1353 with our own indexing system (maybe like MediaWiki's).
1354
71dad1f use the session class to store sessions
Evan Prodromou authored
1355 sessions
1356 --------
1357
1358 Session handling.
1359
1360 handle: boolean. Whether we should register our own PHP session-handling
1361 code (using the database and memcache if enabled). Defaults to false.
1362 Setting this to true makes some sense on large or multi-server
1363 sites, but it probably won't hurt for smaller ones, either.
871f598 debug flag for sessions
Evan Prodromou authored
1364 debug: whether to output debugging info for session storage. Can help
1365 with weird session bugs, sometimes. Default false.
71dad1f use the session class to store sessions
Evan Prodromou authored
1366
f2b12c6 update the README for 0.8.0
Evan Prodromou authored
1367 background
1368 ----------
1369
1370 Users can upload backgrounds for their pages; this section defines
1371 their use.
1372
1373 server: the server to use for background. Using a separate (even
1374 virtual) server for this can speed up load times. Default is
1375 null; same as site server.
1376 dir: directory to write backgrounds too. Default is '/background/'
1377 subdir of install dir.
1378 path: path to backgrounds. Default is sub-path of install path; note
1379 that you may need to change this if you change site-path too.
1380
1381 ping
1382 ----
1383
1384 Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
1385 notify third-party servers of updates.
1386
1387 notify: an array of URLs for ping endpoints. Default is the empty
1388 array (no notification).
1389
ae81d36 Site-wide design configuration
Evan Prodromou authored
1390 design
1391 ------
1392
1393 Default design (colors and background) for the site. Actual appearance
1394 depends on the theme. Null values mean to use the theme defaults.
1395
1396 backgroundcolor: Hex color of the site background.
1397 contentcolor: Hex color of the content area background.
1398 sidebarcolor: Hex color of the sidebar background.
1399 textcolor: Hex color of all non-link text.
1400 linkcolor: Hex color of all links.
1401 backgroundimage: Image to use for the background.
1402 disposition: Flags for whether or not to tile the background image.
1403
a28bbdf configuration options for text limits
Evan Prodromou authored
1404 notice
1405 ------
1406
1407 Configuration options specific to notices.
1408
1409 contentlimit: max length of the plain-text content of a notice.
1410 Default is null, meaning to use the site-wide text limit.
9828c64 0 means no limit for text (distinct from null)
Evan Prodromou authored
1411 0 means no limit.
a28bbdf configuration options for text limits
Evan Prodromou authored
1412
1413 message
1414 -------
1415
1416 Configuration options specific to messages.
1417
1418 contentlimit: max length of the plain-text content of a message.
1419 Default is null, meaning to use the site-wide text limit.
9828c64 0 means no limit for text (distinct from null)
Evan Prodromou authored
1420 0 means no limit.
a28bbdf configuration options for text limits
Evan Prodromou authored
1421
1aae7f3 Evan Prodromou document logincommand/disabled in README
evanp authored
1422 logincommand
1423 ------------
1424
1425 Configuration options for the login command.
1426
1427 disabled: whether to enable this command. If enabled, users who send
1428 the text 'login' to the site through any channel will
1429 receive a link to login to the site automatically in return.
1430 Possibly useful for users who primarily use an XMPP or SMS
1431 interface and can't be bothered to remember their site
1432 password. Note that the security implications of this are
1433 pretty serious and have not been thoroughly tested. You
1434 should enable it only after you've convinced yourself that
1435 it is safe. Default is 'false'.
1436
488befd add some info about plugins
Evan Prodromou authored
1437 Plugins
1438 =======
1439
2506207 update README file
Evan Prodromou authored
1440 Beginning with the 0.7.x branch, StatusNet has supported a simple but
488befd add some info about plugins
Evan Prodromou authored
1441 powerful plugin architecture. Important events in the code are named,
1442 like 'StartNoticeSave', and other software can register interest
1443 in those events. When the events happen, the other software is called
1444 and has a choice of accepting or rejecting the events.
1445
1446 In the simplest case, you can add a function to config.php and use the
1447 Event::addHandler() function to hook an event:
1448
1449 function AddGoogleLink($action)
1450 {
1451 $action->menuItem('http://www.google.com/', _('Google'), _('Search engine'));
1452 return true;
1453 }
1454
1455 Event::addHandler('EndPrimaryNav', 'AddGoogleLink');
1456
1457 This adds a menu item to the end of the main navigation menu. You can
1458 see the list of existing events, and parameters that handlers must
1459 implement, in EVENTS.txt.
1460
1461 The Plugin class in lib/plugin.php makes it easier to write more
1462 complex plugins. Sub-classes can just create methods named
1463 'onEventName', where 'EventName' is the name of the event (case
1464 matters!). These methods will be automatically registered as event
1465 handlers by the Plugin constructor (which you must call from your own
1466 class's constructor).
1467
1468 Several example plugins are included in the plugins/ directory. You
1469 can enable a plugin with the following line in config.php:
1470
1471 addPlugin('Example', array('param1' => 'value1',
1472 'param2' => 'value2'));
1473
1474 This will look for and load files named 'ExamplePlugin.php' or
1475 'Example/ExamplePlugin.php' either in the plugins/ directory (for
2506207 update README file
Evan Prodromou authored
1476 plugins that ship with StatusNet) or in the local/ directory (for
488befd add some info about plugins
Evan Prodromou authored
1477 plugins you write yourself or that you get from somewhere else) or
1478 local/plugins/.
1479
1480 Plugins are documented in their own directories.
1481
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1482 Troubleshooting
1483 ===============
1484
2506207 update README file
Evan Prodromou authored
1485 The primary output for StatusNet is syslog, unless you configured a
a1434ee finish the README file
Evan Prodromou authored
1486 separate logfile. This is probably the first place to look if you're
2506207 update README file
Evan Prodromou authored
1487 getting weird behaviour from StatusNet.
a1434ee finish the README file
Evan Prodromou authored
1488
2506207 update README file
Evan Prodromou authored
1489 If you're tracking the unstable version of StatusNet in the git
a1434ee finish the README file
Evan Prodromou authored
1490 repository (see below), and you get a compilation error ("unexpected
1491 T_STRING") in the browser, check to see that you don't have any
1492 conflicts in your code.
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1493
cf199a9 Evan Prodromou updates to README
evanp authored
1494 If you upgraded to StatusNet 0.8.2 without reading the "Notice
82b0927 Evan Prodromou update version in README, add note about status.net
evanp authored
1495 inboxes" section above, and all your users' 'Personal' tabs are empty,
1496 read the "Notice inboxes" section above.
07086d1 Evan Prodromou update README
evanp authored
1497
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1498 Myths
1499 =====
1500
2506207 update README file
Evan Prodromou authored
1501 These are some myths you may see on the Web about StatusNet.
1502 Documentation from the core team about StatusNet has been pretty
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1503 sparse, so some backtracking and guesswork resulted in some incorrect
1504 assumptions.
1505
1506 - "Set $config['db']['debug'] = 5 to debug the database." This is an
1507 extremely bad idea. It's a tool built into DB_DataObject that will
1508 emit oodles of print lines directly to the browser of your users.
1509 Among these lines will be your database username and password. Do
1510 not enable this option on a production Web site for any reason.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
1511
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1512 - "Edit dataobject.ini with the following settings..." dataobject.ini
1513 is a development file for the DB_DataObject framework and is not
2506207 update README file
Evan Prodromou authored
1514 used by the running software. It was removed from the StatusNet
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1515 distribution because its presence was confusing. Do not bother
1516 configuring dataobject.ini, and do not put your database username
1517 and password into the file on a production Web server; unscrupulous
1518 persons may try to read it to get your passwords.
1519
a1434ee finish the README file
Evan Prodromou authored
1520 Unstable version
1521 ================
1522
1523 If you're adventurous or impatient, you may want to install the
2506207 update README file
Evan Prodromou authored
1524 development version of StatusNet. To get it, use the git version
a5a7c50 Added PEAR Services/oEmbed and its dependencies for multimedia integrati...
Robin Millette authored
1525 control tool <http://git-scm.com/> like so:
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1526
82b0927 Evan Prodromou update version in README, add note about status.net
evanp authored
1527 git clone git@gitorious.org:statusnet/mainline.git
1528
1529 This is the version of the software that runs on Identi.ca and the
1530 status.net hosted service. Using it is a mixed bag. On the positive
1531 side, it usually includes the latest security and bug fix patches. On
1532 the downside, it may also include changes that require admin
1533 intervention (like running a script or even raw SQL!) that may not be
1534 documented yet. It may be a good idea to test this version before
1535 installing it on your production machines.
8c10b0a fine-tuning the privacy flag
Evan Prodromou authored
1536
2a58260 Ori Avtalion Update README to refer to the git repository
salty-horse authored
1537 To keep it up-to-date, use 'git pull'. Watch for conflicts!
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1538
a1434ee finish the README file
Evan Prodromou authored
1539 Further information
1540 ===================
1541
2506207 update README file
Evan Prodromou authored
1542 There are several ways to get more information about StatusNet.
a1434ee finish the README file
Evan Prodromou authored
1543
2506207 update README file
Evan Prodromou authored
1544 * There is a mailing list for StatusNet developers and admins at
3567b9d global search and replace for laconica -> statusnet
Evan Prodromou authored
1545 http://mail.status.net/mailman/listinfo/statusnet-dev
1546 * The #statusnet IRC channel on freenode.net <http://www.freenode.net/>.
82b0927 Evan Prodromou update version in README, add note about status.net
evanp authored
1547 * The StatusNet wiki, http://status.net/wiki/
1548 * The StatusNet blog, http://status.net/blog/
1549 * The StatusNet status update, <http://status.status.net/status> (!)
a1434ee finish the README file
Evan Prodromou authored
1550
1551 Feedback
1552 ========
1553
1554 * Microblogging messages to http://identi.ca/evan are very welcome.
2506207 update README file
Evan Prodromou authored
1555 * StatusNet's Trac server has a bug tracker for any defects you may find,
1556 or ideas for making things better. http://status.net/trac/
82b0927 Evan Prodromou update version in README, add note about status.net
evanp authored
1557 * e-mail to evan@status.net will usually be read and responded to very
a1434ee finish the README file
Evan Prodromou authored
1558 quickly, unless the question is really hard.
025dcb9 Evan Prodromou some doc
evanp authored
1559
fbe15ef big changes to the README, part 1
Evan Prodromou authored
1560 Credits
1561 =======
a1434ee finish the README file
Evan Prodromou authored
1562
1563 The following is an incomplete list of developers who've worked on
e3a5325 last scrub of Laconica -> StatusNet
Evan Prodromou authored
1564 StatusNet. Apologies for any oversight; please let evan@status.net know
a1434ee finish the README file
Evan Prodromou authored
1565 if anyone's been overlooked in error.
1566
e3a5325 last scrub of Laconica -> StatusNet
Evan Prodromou authored
1567 * Evan Prodromou, founder and lead developer, StatusNet, Inc.
1568 * Zach Copley, StatusNet, Inc.
1569 * Earle Martin, StatusNet, Inc.
1570 * Marie-Claude Doyon, designer, StatusNet, Inc.
1571 * Sarven Capadisli, StatusNet, Inc.
1572 * Robin Millette, StatusNet, Inc.
a1434ee finish the README file
Evan Prodromou authored
1573 * Ciaran Gultnieks
1574 * Michael Landers
1575 * Ori Avtalion
1576 * Garret Buell
1577 * Mike Cochrane
1578 * Matthew Gregg
1579 * Florian Biree
1580 * Erik Stambaugh
1581 * 'drry'
1582 * Gina Haeussge
07086d1 Evan Prodromou update README
evanp authored
1583 * Tryggvi Björgvinsson
fae7c08 update the README
Evan Prodromou authored
1584 * Adrian Lang
1585 * Ori Avtalion
1586 * Meitar Moscovitz
1587 * Ken Sheppardson (Trac server, man-about-town)
8bdb7dc update the README with new information
Evan Prodromou authored
1588 * Tiago 'gouki' Faria (i18n manager)
60f737d Update README and version number
Evan Prodromou authored
1589 * Sean Murphy
254e5e5 Update README and version number
Evan Prodromou authored
1590 * Leslie Michael Orchard
1591 * Eric Helgeson
1592 * Ken Sedgwick
8f40a1a Update README and common for new version
Evan Prodromou authored
1593 * Brian Hendrickson
1594 * Tobias Diekershoff
f66e996 Update version number to 0.7.4
Evan Prodromou authored
1595 * Dan Moore
1596 * Fil
8bdb7dc update the README with new information
Evan Prodromou authored
1597 * Jeff Mitchell
1598 * Brenda Wallace
1599 * Jeffery To
1600 * Federico Marani
36d2c66 Add Craig Andrews to the credits list
Zach Copley authored
1601 * Craig Andrews
cf199a9 Evan Prodromou updates to README
evanp authored
1602 * mEDI
a1434ee finish the README file
Evan Prodromou authored
1603
07086d1 Evan Prodromou update README
evanp authored
1604 Thanks also to the developers of our upstream library code and to the
e3a5325 last scrub of Laconica -> StatusNet
Evan Prodromou authored
1605 thousands of people who have tried out Identi.ca, installed StatusNet,
07086d1 Evan Prodromou update README
evanp authored
1606 told their friends, and built the Open Microblogging network to what
1607 it is today.
Something went wrong with that request. Please try again.