From c8cb12b54fbfbd91cd6e13c135a4f85fddb48e22 Mon Sep 17 00:00:00 2001 From: tszynalski Date: Wed, 22 Jun 2011 15:45:53 -0700 Subject: Edited askbot/doc/source/initial-configuration.rst via GitHub --- askbot/doc/source/initial-configuration.rst | 47 +++++++++++++++++++++-------- 1 file changed, 34 insertions(+), 13 deletions(-) diff --git a/askbot/doc/source/initial-configuration.rst b/askbot/doc/source/initial-configuration.rst index cb871a7e..56997467 100644 --- a/askbot/doc/source/initial-configuration.rst +++ b/askbot/doc/source/initial-configuration.rst @@ -6,34 +6,55 @@ Initial Configuration of Askbot While most configuration settings for askbot can be done at any time :ref:`through the web-interface `, some manipulations on the server are still necessary. -When you are installing askbot the first time you will need to initialize the site setup files by typing:: + +Installing Askbot as a new Django project (standalone app) +========================================================== + +When installing Askbot for the first time, you will need to initialize the site setup files by typing:: startforum -and answering the questions. +and answering the questions. The `startforum` script will ask you where to deploy Askbot. If you are in +the directory where the Askbot project resides, you can answer `.` (the `.` refers to the current directory). +There may be an error message; ignore it. + +.. note:: + + All Django sites have four project-wide files: + + settings.py - the main settings configuration file + urls.py - main url configuration + __init__.py - often empty but needed for Python + manage.py - the hook allowing to run management commands + + `startforum` adds those files to the directory you select (and some more things specific to Askbot). + +Note that if you already have a Django site you will not want to use `startforum`, because you don't want to just overwrite your existing settings.py. See below for instructions. -The startforum script will attempt to create necessary directories and copy files. +Another thing you have to do if you are creating a brand new Django project is edit the file `settings.py`_. At the very minimum, you will need to provide the correct values to:: -If you are creating a brand new Django project, then you will need to edit file `settings.py`_ + DATABASE_ENGINE = '' #e.g. 'mysql' + DATABASE_NAME = '' #name of the database you created, e.g. 'askbot'. + DATABASE_USER = '' #name of the database user, e.g. 'askbotuser'. + DATABASE_PASSWORD = '' #password to the database + CSRF_COOKIE_DOMAIN = ''#e.g. 'example.com' or 'askbot.example.com' (localhost/IP address for tests) -In the case you are adding askbot to an existing Django project, you will need to -merge askbot files settings.py_ and urls.py_ into your project files manually. +All values must be enclosed in single quotes, as shown above. .. note:: - Files settings.py_ and urls.py_ may also need to be touched up + The files settings.py_ and urls.py_ may also need to be touched up when you upgrate the software, because new versions may bring new dependencies and add new site urls. -Within settings.py, at the very minimum you will need to provide correct values to:: +Adding Askbot to an existing Django project +=========================================== - DATABASE_NAME = '' - DATABASE_USER = '' - DATABASE_PASSWORD = '' - CSRF_COOKIE_DOMAIN = ''#e.g. example.com (localhost/IP address for tests) +If you are adding askbot to an existing Django project, you will need to +merge settings.py_ and urls.py_ into your project manually. The templates to be used can be found +in the `askbot/setup_templates` subdirectory. -within single quotes - login credentials to your database. .. _urls.py: http://github.com/ASKBOT/askbot-devel/blob/master/askbot/setup_templates/urls.py .. _settings.py: http://github.com/ASKBOT/askbot-devel/blob/master/askbot/setup_templates/settings.py -- cgit v1.2.3-1-g7c22