README

Open Microblogger -- Standards-based Microblog
Copyright (C) 2008-2012 Brian Hendrickson

This application is free software; you can redistribute it and/or
modify it under the terms of the MIT License.

This application is distributed in the hope that it will be useful,
but without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.

Author
 Brian Hendrickson - http://brianhendrickson.com
 
Project Manager
 Johannes Schirge - http://tiquer.me


Version 0.1, 1-Sep-2008
 initial release

Version 0.2, 22-Oct-2008
 sms, app store
 
Version 0.3, 10-July-2009
 admin, themes, intranet, search

Version 0.4, 12-Dec-2009
 wiki, twitter, facebook

Version 0.5, 1-Mar-2010
 rssCloud, rssWave

Version 0.6, 1-Mar-2012
 OStatus, new Login/Register


REQUIREMENTS

   - PHP > 4.2
   - MySQL or PostgreSQL


INSTALLATION

/////////////////////
// 7 steps to install
/////////////////////

1. obtain OpenMicroBlogger http://dbscript.net/omb.zip

2. unzip the files on your computer

3. copy the files to your Web server folder

4. open your Web browser and run
      yourdomain.com/install.php

5. follow the installation instructions

6. if installation succeeded, open your Web browser and browse to the installation folder

7. set in app/config/config.yml your 

      site_title: Your Site Title
      site_subtitle: Your Site Subtitle
      site_description: Your Site Description

 [[ that is it! ]]


/////////////////////////////////
// Facebook, Twitter, Zeep Mobile
/////////////////////////////////

Facebook:
  
  1. http://www.facebook.com/developers/apps.php
  2. click "Edit Settings"
  3. click "Connect"
your connect URL is
    http://yoursite.com/?email_login
get an infinite session key: 3 steps:
    http://www.facebook.com/code_gen.php?v=1.0&api_key=[api key]
    http://yoursite.com/permanent_facebook_key/[code from step 1]
    add to config.yml ->    facebookSession: [key from step 2] 
    
Twitter:
  
  1. http://twitter.com/oauth_clients
your callback URL is
    http://yoursite.com/?oauth_login   [or]
    http://yoursite.com/oauth_login (pretty URLs)
  
Zeep Mobile:
  
  1. https://secure.zeepmobile.com/account/create_app
your callback URL is
    http://yoursite.com/?mobile_event   [or]
    http://yoursite.com/mobile_event (pretty URLs)
your website URL is
    http://yoursite.com/?mobile_settings   [or]
    http://yoursite.com/mobile_settings (pretty URLs)

Google:

  1. https://www.google.com/accounts/ManageDomains


/////////////////////////////
// use pretty URLs (optional)
/////////////////////////////

To enable pretty URLs:

1) edit config.php (or config/config.php if you used Web installer)

2) change the 2 lines at the bottom of config.php

    // global $pretty_url_base;
    // $pretty_url_base = "http://openmicroblogger.com";

  [[ change the 2 lines like this ]]

    global $pretty_url_base;
    $pretty_url_base = "http://yoursite.com";
    
3) copy the file /resource/prettyurls/.htaccess to the top level folder

4) change these 2 lines in .htaccess

  RewriteCond %{HTTP_HOST} ^www.openmicroblogger.com$ [NC]
  RewriteRule ^(.*)$ http://openmicroblogger.com/$1 [R=301,L]
  
  [[ change the 2 lines like this ]]

  RewriteCond %{HTTP_HOST} ^www.yoursite.com$ [NC]
  RewriteRule ^(.*)$ http://yoursite.com/$1 [R=301,L]
  
5) if you need to use [www.]yoursite.com or [blog.]yoursite.com
  
  [[ use this 1 line instead of 2 in your.htaccess ]]
  
  RewriteRule ^(.*)$ http://blah.yoursite.com/$1 [R=301,L]

Notes:
   "AllowEncodedSlashes On" is required in the VirtualHost (Apache > 2.0.46)
      todo: add a test for this problem XXX


///////////////////////////////////////
// (optional) choose a file upload mode
///////////////////////////////////////

1) upload FILES to /uploads (do not create BLOBs) (default)

      set permissions on the /cache and /uploads folders
      
      next, edit app/config/config.yml
   
   look for
   
      collection_cache:
      - posts:
        duration : 0
        location : cache    // and change 'cache' to 'uploads'

2) upload as SQL BLOBs
      
      maximum upload size is 5MB or so, not that great for big MP3s, but maximizes privacy
      
      you must set the /cache folder permissions so the Flash uploader can put files there

3) upload as SQL BLOBs (WITH CACHING)

      first set up your /cache folder as described in option 2
      
      then, edit app/config/config.yml

   look for

      collection_cache:
      - posts:
        duration : 0        // and change this 0 to the number of seconds to cache
        location : cache

4) upload to Amazon S3 (do not create BLOBs)

      set permissions on the /cache folder
      
      then, edit app/config/config.yml
   
   look for
   
      collection_cache:
      - posts:
        duration : 0
        location : cache    // and change 'cache' to 'aws'

   look for

      awsAccessKey:         // and put your AWS login info here
      awsSecretKey: 
      awsBucket: 


UPDATING

/////////////////////////////
// use the /wp-content folder
/////////////////////////////

If you want to customize OpenMicroBlogger with your own theme and plugins:
  
1) copy /app/config/config.yml to /wp-content/config

2) duplicate a theme in /wp-content/themes

3) optionally, add plugins to /wp-content/plugins

    note: plugins in this folder override same-name plugins in /app/plugins


///////////////////////////
// get the latest build
///////////////////////////

you can grab the almost-nightly build from http://dbscript.net/omb.zip



//////////////////

OTHER DOCUMENTATION

1. changing the maximum number of tags shown in the sidebar

  The /app/omb/views/categories/_block.js file can be edited to change this setting.
  At the top of this file the $category_count variable is set to 10 by default.

2. login timeout can be set by changing "cookielife" in config.yml

3. creating a Contact Page/Impressum/About page: as an administrator you will have an app called "Pages"
   use this app to add new pages, links to these will appear in the footer of your P2-themed site

4. to change the allowed file-types for uploads, in config.yml is the "upload_types" list

5. configuring twitter-follow feature: in the site Admin panel is a new tab called 'Sources'
   choose from the full list of your site's OAuth-authenticated twitter users
   set "friends_timeline" on the users you want to import automatically
   here are the steps to set up the automatic twitter feed:
     1. see instructions above to set your "callback url" at Twitter and put key/secret in config.yml
     2. authenticate to the site as the Twitter user whose friends you want to import automatically
     3. set up a cron job to run db/library/remy-tweed/cron.php -- this example runs once a minute:
             0-59 * * * * /usr/bin/php /home/webuser/public_html/db/library/remy-tweed/cron.php 2>&1