fixed up INSTALL, settings_local.py.dist and replaced strings osqa->askbot everywhere, except main README file

Author: evgenyfadeev

.project

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <projectDescription>
-	<name>osqa</name>
+	<name>askbot</name>
 	<comment></comment>
 	<projects>
 	</projects>

.pydevproject

@@ -5,6 +5,6 @@
 <pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property>
 <pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.6</pydev_property>
 <pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH">
-<path>/osqa</path>
+<path>/askbot</path>
 </pydev_pathproperty>
 </pydev_project>

HOW_TO_DEBUG

@@ -18,17 +18,17 @@ logging.debug('') #this will add time, line number, function and file record
 #etc - take a look at http://docs.python.org/library/logging.html
 -------------------------------
 
-in OSQA logging is currently set up in settings_local.py.dist
+in Askbot logging is currently set up in settings_local.py.dist
 please update it if you need - in older revs logging strings have less info
 
 messages of interest can be grepped out of the log file by module/file/function name
 e.g. to take out all django_authopenid logs run: 
->grep 'osqa\/django_authopenid' log/django.osqa.log | sed 's/^.*MSG: //'
+>grep 'askbot\/django_authopenid' log/django.askbot.log | sed 's/^.*MSG: //'
 in the example above 'sed' call truncates out a long prefix
 and makes output look more meaningful
 
 2) DJANGO DEBUG TOOLBAR
-osqa works with django debug toolbar
+askbot works with django debug toolbar
 if debugging under apache server, check 
 that debug toolbar media is loaded correctly
 if toolbar is enabled but you do not see it, possibly some Alias statement

INSTALL

@@ -4,7 +4,7 @@ A. PREREQUISITES
 B. INSTALLATION
    1. Settings file
    2. Database
-   3. Running OSQA in the development server
+   3. Running Askbot in the development server
    4. Installation under Apache/WSGI
    5. Full text search
    6. Email subscriptions
@@ -56,22 +56,28 @@ Notice that you will need to register with recaptcha.net and receive
 recaptcha public and private keys that need to be saved in your
 settings_local.py file
 
-NOTES: django_authopenid is included into OSQA code
+NOTES: django_authopenid is included into Askbot code
 and is significantly modified.  http://code.google.com/p/django-authopenid/
 no need to install this library
 
 B. INSTALLATION
 -----------------------------------------------
 0. Make sure you have all above python libraries installed.
 
-   make osqa installation server-readable on Linux command might be:
-   chown -R yourlogin:apache /path/to/OSQA
+   DO NOT name the main directory 'askbot' - this name is reserved
+   for the future name of the app file itself.
 
-   directories templates/upfiles and log must be server writable
+   make askbot installation server-readable on Linux command might be:
+   chown -R yourlogin:apache /path/to/askbot-site
+
+   directories: 
+    /path/to/askbot-site/forum/upfiles
+    /path/to/askbot-site/log
+   must be server writable
 
    on Linux type chmod
-   chmod -R g+w /path/to/OSQA/upfiles
-   chmod -R g+w /path/to/log
+   chmod -R g+w /path/to/askbot-site/forum/upfiles
+   chmod -R g+w /path/to/askbot-site/log
 
    above it is assumed that webserver runs under group named "apache"
 
@@ -82,16 +88,32 @@ update all your settings. Check settings.py and update
 it as well if necessory.
 Section C explains configuration paramaters.
 
+Minimally required modification of settings_local.py are
+DATABASE_NAME
+DATABASE_USER
+DATABASE_PASSWORD
+DATABASE_ENGINE
+
+If you set these up, and your database is ready (see section 2),
+run:
+
+python manage.py syncdb
+python manage.py runserver `hostname -i`:8000
+(choose another port number if you wish)
+
+and askbot should be running - if you have any issues at this point (or later:)
+please post them at http://askbot.org/meta
+
 2. Database
 
 Prepare your database by using the same database/account
 configuration from above.
 e.g,
-create database osqa DEFAULT CHARACTER SET UTF8 COLLATE utf8_general_ci;
-grant all on osqa.* to 'osqa'@'localhost';
+create database askbot DEFAULT CHARACTER SET UTF8 COLLATE utf8_general_ci;
+grant all on askbot.* to 'askbot'@'localhost';
 And then run "python manage.py syncdb" to synchronize your database.
 
-3. Running OSQA on the development server
+3. Running Askbot on the development server
 
 Run "python manage.py runserver" to startup django
 development environment.
@@ -112,8 +134,8 @@ import os
 import sys
 
 sys.path.insert(0,'/one/level/above') #insert to make sure that forum will be found
-sys.path.append('/one/level/above/OSQA') #maybe this is not necessary
-os.environ['DJANGO_SETTINGS_MODULE'] = 'OSQA.settings'
+sys.path.append('/one/level/above/askbot-site') #maybe this is not necessary
+os.environ['DJANGO_SETTINGS_MODULE'] = 'askbot-site.settings'
 import django.core.handlers.wsgi
 application = django.core.handlers.wsgi.WSGIHandler()
 -----------
@@ -138,26 +160,26 @@ WSGIPythonEggs /var/python/eggs #must be readable and writable by apache
 #this allows "rooting" forum at http://example.com/forum, if you like
 <VirtualHost ...your ip...:80>
     ServerAdmin [email protected]
-    DocumentRoot /path/to/osqa-site
+    DocumentRoot /path/to/askbot-site
     ServerName example.com
 
     #run mod_wsgi process for django in daemon mode
     #this allows avoiding confused timezone settings when
     #another application runs in the same virtual host
-    WSGIDaemonProcess OSQA
-    WSGIProcessGroup OSQA
+    WSGIDaemonProcess askbot
+    WSGIProcessGroup askbot
 
     #force all content to be served as static files
     #otherwise django will be crunching images through itself wasting time
-    Alias /m/ /path/to/osqa-site/forum/skins/
-    Alias /upfiles/ /path/to/osqa-site/forum/upfiles/
-    <Directory /path/to/osqa-site/forum/skins>
+    Alias /m/ /path/to/askbot-site/forum/skins/
+    Alias /upfiles/ /path/to/askbot-site/forum/upfiles/
+    <Directory /path/to/askbot-site/forum/skins>
         Order deny,allow
         Allow from all
     </Directory>
 
     #this is your wsgi script described in the prev section
-    WSGIScriptAlias / /path/to/osqa-site/osqa.wsgi
+    WSGIScriptAlias / /path/to/askbot-site/askbot.wsgi
 
     #this will force admin interface to work only
     #through https (optional)
@@ -166,20 +188,20 @@ WSGIPythonEggs /var/python/eggs #must be readable and writable by apache
         RewriteEngine on
         RewriteRule /nimda(.*)$ https://example.com/nimda$1 [L,R=301]
     </Location>
-    CustomLog /var/log/httpd/OSQA/access_log common
-    ErrorLog /var/log/httpd/OSQA/error_log
+    CustomLog /var/log/httpd/askbot/access_log common
+    ErrorLog /var/log/httpd/askbot/error_log
 </VirtualHost>
 #(optional) run admin interface under https
 <VirtualHost ..your ip..:443>
     ServerAdmin [email protected]
-    DocumentRoot /path/to/osqa-site
+    DocumentRoot /path/to/askbot-site
     ServerName example.com
     SSLEngine on
     SSLCertificateFile /path/to/ssl-certificate/server.crt
     SSLCertificateKeyFile /path/to/ssl-certificate/server.key
-    WSGIScriptAlias / /path/to/osqa-site/osqa.wsgi
-    CustomLog /var/log/httpd/OSQA/access_log common
-    ErrorLog /var/log/httpd/OSQA/error_log
+    WSGIScriptAlias / /path/to/askbot-site/askbot.wsgi
+    CustomLog /var/log/httpd/askbot/access_log common
+    ErrorLog /var/log/httpd/askbot/error_log
     DirectoryIndex index.html
 </VirtualHost>
 -------------
@@ -196,9 +218,9 @@ WSGIPythonEggs /var/python/eggs #must be readable and writable by apache
    configure sphinx, sample configuration can be found in
    sphinx/sphinx.conf file usually goes somewhere in /etc tree
 
-   build osqa index first time manually
+   build askbot index first time manually
 
-   % indexer --config /path/to/sphinx.conf --index osqa
+   % indexer --config /path/to/sphinx.conf --index askbot
 
    setup cron job to rebuild index periodically with command
    your crontab entry may be something like
@@ -246,69 +268,10 @@ There are some demo scripts under sql_scripts folder,
 including badges and test accounts for CNProg.com. You
 don't need them to run your sample.
 
-C. CONFIGURATION PARAMETERS
-
-#the only parameter that needs to be touched in settings.py is
-DEBUG=False #set to True to enable debug mode
-
-#all forum parameters are set in file settings_local.py
-
-LOG_FILENAME = 'osqa.log' #where logging messages should go
-DATABASE_NAME = 'osqa'    # Or path to database file if using sqlite3.
-DATABASE_USER = ''          # Not used with sqlite3.
-DATABASE_PASSWORD = ''      # Not used with sqlite3.
-DATABASE_ENGINE = 'mysql'   #mysql, etc
-SERVER_EMAIL = ''
-DEFAULT_FROM_EMAIL = ''
-EMAIL_HOST_USER = ''
-EMAIL_HOST_PASSWORD = ''    #not necessary if mailserver is run on local machine
-EMAIL_SUBJECT_PREFIX = '[OSQA] '
-EMAIL_HOST='osqa.com'
-EMAIL_PORT='25'
-EMAIL_USE_TLS=False
-TIME_ZONE = 'America/Tijuana'
-APP_TITLE = u'OSQA Q&A Forum' #title of your forum
-APP_KEYWORDS = u'OSQA,forum,community' #keywords for search engines
-APP_DESCRIPTION = u'Ask and answer questions.' #site description for searche engines
-APP_INTRO = u'<p>Ask and answer questions, make the world better!</p>' #slogan that goes to front page in logged out mode
-APP_COPYRIGHT = '' #copyright message
-
-#if you set FORUM_SCRIPT_ALIAS= 'forum/'
-#then OSQA will run at url http://example.com/forum
-#FORUM_SCRIPT_ALIAS cannot have leading slash, otherwise it can be set to anything
-FORUM_SCRIPT_ALIAS = '' #no leading slash, default = '' empty string
-
-LANGUAGE_CODE = 'en' #forum language (see language instructions on the wiki)
-EMAIL_VALIDATION = 'off' #string - on|off
-MIN_USERNAME_LENGTH = 1
-EMAIL_UNIQUE = False    #if True, email addresses must be unique in all accounts
-APP_URL = 'http://osqa.com' #used by email notif system and RSS
-GOOGLE_SITEMAP_CODE = '' #code for google site crawler (look up google webmaster tools)
-GOOGLE_ANALYTICS_KEY = '' #key to enable google analytics on this site
-BOOKS_ON = False  #if True - books tab will be on
-WIKI_ON = True  #if False - community wiki feature is disabled
-
-#experimental - allow password login through external site
-#must implement django_authopenid/external_login.py
-#included prototype external_login works with Mediawiki
-USE_EXTERNAL_LEGACY_LOGIN = True #if false OSQA uses it's own login/password
-EXTERNAL_LEGACY_LOGIN_HOST = 'login.osqa.com'
-EXTERNAL_LEGACY_LOGIN_PORT = 80
-EXTERNAL_LEGACY_LOGIN_PROVIDER_NAME = '<span class="orange">OSQA</span>'
-
-FEEDBACK_SITE_URL = None #None or url
-LOGIN_URL = '/%s%s%s' % (FORUM_SCRIPT_ALIAS,'account/','signin/')
-
-DJANGO_VERSION = 1.1 #must be either 1.0 or 1.1
-RESOURCE_REVISION=4 #increment when you update media files - clients will be forced to load new version
-
-D. Customization
+C. Customization
 
 Other than settings_local.py the following will most likely need customization:
 * locale/*/django.po - language files that may also contain your site-specific messages
   if you want to start with english messages file - look for words like "forum" and
-  "OSQA" in the msgstr lines
-* templates/header.html and templates/footer.html may contain extra links
-* templates/about.html - a place to explain for is your forum for
-* templates/faq.html - put answers to users frequent questions
-* templates/content/style/style.css - modify style sheet to add disctinctive look to your forum
+  "Askbot" in the msgstr lines
+* skins

INSTALL.pip

@@ -12,7 +12,7 @@
     git://github.com/johnl/deb-sphinx-search.git
 
 * Install a virtual environment OUTSIDE of this directory:
-    pip install -E ~/env -r osqa-requirements.txt 
+    pip install -E ~/env -r askbot-requirements.txt 
 [there is discussion on the pinax forums about what it should be outside
 the source directory]