From 4c9dc2530be50ab721cbee7054b4c4839a3565a2 Mon Sep 17 00:00:00 2001 From: Evan Prodromou Date: Tue, 20 Sep 2011 16:05:00 -0400 Subject: [PATCH] Update documentation for 1.0.0rc1 --- INSTALL | 31 ++++++------- README | 114 +++++++++++++++++++++++----------------------- lib/framework.php | 2 +- 3 files changed, 73 insertions(+), 74 deletions(-) diff --git a/INSTALL b/INSTALL index db7aba017f..f40594d260 100644 --- a/INSTALL +++ b/INSTALL @@ -106,9 +106,9 @@ especially if you've previously installed PHP/MySQL packages. 1. Unpack the tarball you downloaded on your Web server. Usually a command like this will work: - tar zxf statusnet-0.9.9.tar.gz + tar zxf statusnet-1.0.0rc1.tar.gz - ...which will make a statusnet-0.9.9 subdirectory in your current + ...which will make a statusnet-1.0.0rc1 subdirectory in your current directory. (If you don't have shell access on your Web server, you may have to unpack the tarball on your local computer and FTP the files to the server.) @@ -116,7 +116,7 @@ especially if you've previously installed PHP/MySQL packages. 2. Move the tarball to a directory of your choosing in your Web root directory. Usually something like this will work: - mv statusnet-0.9.9 /var/www/statusnet + mv statusnet-1.0.0rc1 /var/www/statusnet This will make your StatusNet instance available in the statusnet path of your server, like "http://example.net/statusnet". "microblog" or @@ -431,9 +431,9 @@ As of this writing, the software has been tested with ActiveMQ 5.3. Themes ------ -There are two themes shipped with this version of StatusNet: "identica", -which is what the Identi.ca site uses, and "default", which is a good -basis for other sites. +Older themes (version 0.9.x and below) no longer work with StatusNet +1.0.x, due to major changes in the site layout. We ship with three new +themes for this version, 'neo', 'neo-blue' and 'neo-light'. As of right now, your ability to change the theme is site-wide; users can't choose their own theme. Additionally, the only thing you can @@ -462,10 +462,6 @@ default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions You may want to start by copying the files from the default theme to your own directory. -NOTE: the HTML generated by StatusNet changed *radically* between -version 0.6.x and 0.7.x. Older themes will need signification -modification to use the new output format. - Translation ----------- @@ -493,16 +489,17 @@ Private ------- The administrator can set the "private" flag for a site so that it's -not visible to non-logged-in users. This might be useful for -workgroups who want to share a social networking site for project -management, but host it on a public server. +not visible to non-logged-in users. (This is the default for new installs of version 1.0!) -Total privacy is not guaranteed or ensured. Also, privacy is -all-or-nothing for a site; you can't have some accounts or notices -private, and others public. The interaction of private sites -with OStatus is undefined. +This might be useful for workgroups who want to share a social +networking site for project management, but host it on a public +server. + +Total privacy is attempted but not guaranteed or ensured. Private sites +currently don't work well with OStatus federation. Access to file attachments can also be restricted to logged-in users only. + 1. Add a directory outside the web root where your file uploads will be stored. Usually a command like this will work: diff --git a/README b/README index bfb94cb9e3..07537a7c1d 100644 --- a/README +++ b/README @@ -2,24 +2,35 @@ README ------ -StatusNet 1.0.0beta4 -16 September 2011 +StatusNet 1.0.0rc1 +20 September 2011 This is the README file for StatusNet, the Open Source social -networking platform. It includes installation instructions, -descriptions of options you can set, warnings, tips, and general info -for administrators. Information on using StatusNet can be found in the -"doc" subdirectory or in the "help" section on-line. +networking platform. It includes general information about the +software and the project. + +Some other files to review: + +- INSTALL: instructions on how to install the software. +- UPGRADE: upgrading from earlier versions +- CONFIGURE: configuration options in gruesome detail. +- PLUGINS.txt: how to install and configure plugins. +- EVENTS.txt: events supported by the plugin system +- COPYING: full text of the software license + +Information on using StatusNet can be found in the "doc" subdirectory +or in the "help" section on-line. About ===== -StatusNet is a Free and Open Source social networking platform. It helps -people in a community, company or group to exchange short (140 -characters, by default) messages over the Web. Users can choose which -people to "follow" and receive only their friends' or colleagues' -status messages. It provides a similar service to sites like Twitter, -Google Buzz, or Yammer. +StatusNet is a Free and Open Source social networking platform. It +helps people in a community, company or group to exchange short status +updates, do polls, announce events, or other social activities (and +you can add more!). Users can choose which people to "follow" and +receive only their friends' or colleagues' status messages. It +provides a similar service to sites like Twitter, Google+, Facebook or +Yammer, but is much more awesome. With a little work, status messages can be sent to mobile phones, instant messenger programs (GTalk/Jabber), and specially-designed @@ -96,27 +107,44 @@ for additional terms. New this version ================ -This is a security release since version 0.9.7 released on 11 March -2011. It fixes security bug #3260. All sites running version 0.9.7 or -below are recommended to upgrade to 0.9.9 immediately. +This is a major feature release since 0.9.9, released 2 August +2011. It is the first release of the new branch of StatusNet, and the +first release in the 1.x timeline. Notable changes this version: -- Fix bug #3260, a cross-site scripting (XSS) bug that allows an - attacker to inject JavaScript into a page with a carefully structured URL. -- Updated code for Google Analytics to reflect new API. -- Various fixes for Bookmark plugin. -- Updates to reCAPTCHA plugin based on changes to API. -- New plugin to move the site notice to the sidebar. -- Add rss.me to notice source list. -- Updates to data backup/restore. -- Correct use of "likes" in Facebook plugin. -- Ignore failures in Twitter plugin. +- Support for private updates, including private-to-groups, private + within a site, and private to followers only. +- Conversation mode in streams; notices appear along with all replies. +- Microapps -- post different types of activities to timelines, with + interaction. Events, bookmarks, Q&A, and polls included by default. +- New 3-column layout in 'neo' theme by default. Older, 2-column layout + themes have been removed. +- Alphabetical, searchable user directory. +- Alphabetical, searchable group directory. +- Groups can require all posts to be private ('private groups'), and + limit members to the group. +- Users can make all posts private to their followers ('private stream'), + and require authorization to follow. +- General plugin for IM support; added AIM, IRC and MSN to existing + XMPP code. +- Support for Twitter-like lists, to follow other users without + interfering with the home timeline. +- Subscription to searches. +- Subscription to tags. +- Drupal-style schema system ("schemax") allows in-place database + upgrades from various software versions. +- Fine-grained control of URL shortening, and an internal URL shortener + available. +- Extended profile for private, enterprise sites. +- sites are private by default. +- Blog plugin for extended posts. +- Plugin to restrict all users of a site to a single email domain. +- Plugin to send a daily email summary to site users. +- Deeper integration with Activity Streams (http://activitystrea.ms) format. +- Automated upgrade script. -A full changelog is available at http://status.net/wiki/StatusNet_0.9.9. - -NOTE: The short-lived StatusNet 0.9.8 ("Letter Never Sent") did not -adequately fix bug #3260 as originally thought; thus this new release. +A full changelog is available at http://status.net/wiki/StatusNet_1.0.0. Troubleshooting =============== @@ -130,32 +158,6 @@ repository (see below), and you get a compilation error ("unexpected T_STRING") in the browser, check to see that you don't have any conflicts in your code. -If you upgraded to StatusNet 0.9.x without reading the "Notice -inboxes" section above, and all your users' 'Personal' tabs are empty, -read the "Notice inboxes" section above. - -Myths -===== - -These are some myths you may see on the Web about StatusNet. -Documentation from the core team about StatusNet has been pretty -sparse, so some backtracking and guesswork resulted in some incorrect -assumptions. - -- "Set $config['db']['debug'] = 5 to debug the database." This is an - extremely bad idea. It's a tool built into DB_DataObject that will - emit oodles of print lines directly to the browser of your users. - Among these lines will be your database username and password. Do - not enable this option on a production Web site for any reason. - -- "Edit dataobject.ini with the following settings..." dataobject.ini - is a development file for the DB_DataObject framework and is not - used by the running software. It was removed from the StatusNet - distribution because its presence was confusing. Do not bother - configuring dataobject.ini, and do not put your database username - and password into the file on a production Web server; unscrupulous - persons may try to read it to get your passwords. - Unstable version ================ @@ -194,7 +196,7 @@ Feedback * The group http://identi.ca/group/statusnet is a good place to discuss the software. * StatusNet has a bug tracker for any defects you may find, or ideas for - making things better. http://status.net/bugs + making things better. http://status.net/open-source/issues Credits ======= diff --git a/lib/framework.php b/lib/framework.php index 5c7ca6c476..642617564c 100644 --- a/lib/framework.php +++ b/lib/framework.php @@ -20,7 +20,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } define('STATUSNET_BASE_VERSION', '1.0.0'); -define('STATUSNET_LIFECYCLE', 'beta4'); // 'dev', 'alpha[0-9]+', 'beta[0-9]+', 'rc[0-9]+', 'release' +define('STATUSNET_LIFECYCLE', 'rc1'); // 'dev', 'alpha[0-9]+', 'beta[0-9]+', 'rc[0-9]+', 'release' define('STATUSNET_VERSION', STATUSNET_BASE_VERSION . STATUSNET_LIFECYCLE); define('LACONICA_VERSION', STATUSNET_VERSION); // compatibility