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