Commits

Arnaud Grausem committed bdf22b4

First version of Thot installation instructions

Comments (0)

Files changed (1)

+#------------------------------------------------------------------------------#
+# INSTALLATION INSTRUCTIONS                                                    #
+#------------------------------------------------------------------------------#
+#                                                                              # 
+# This file will change shortly because a setup.py will soon be added          #
+# Check the next releases of the application                                   #
+#                                                                              #
+#------------------------------------------------------------------------------#
+
+
+0. DEPENDENCIES
+--------------------------------------------------------------------------------
+
+a. Requirements
+    - Don't forget to install the right python library to manage your database.
+        * python-psycopg2 for PostgreSQL
+        * python-mysql for MySQL
+        * python-sqlite for sqlite
+
+    - Don't forget to install the python-setuptools library
+
+b. Django 1.1.2
+    - Get the tarball: http://www.djangoproject.com/download/1.1.2/tarball/
+    - Unpack it
+    - Run python setup.py install
+
+c. Ajax libraries for Django
+    - easy_install django-dajaxice
+    - easy_install django-dajax
+
+d. Extend commands, models and forms for Django
+    - easy_install django-extensions
+
+e. TinyMCE
+    - easy_install django-tinymce
+    - Get the TinyMCE latest release: 
+        wget http://downloads.sourceforge.net/project/tinymce/TinyMCE/3.3.9/tinymce_3_3_9.zip?r=http%3A%2F%2Ftinymce.moxiecode.com%2Fdownload.php&ts=1284756620&use_mirror=freefr
+    - Unpack it
+    - Install it in the thot project: 
+        cp -r tinymce/jscripts/tiny_mce /path/to/thot/root/media/js/tinymce
+
+f. Options
+    - Adding a CAS authentication
+        * easy_install django_cas
+    - Populating database with users "on the fly" with an LDAP Server and CAS
+      authentication:
+      	* Install the package for your distribution
+        * python-ldap or py-ldap
+
+2. PREPARING FILES FOR CONFIGURATION
+--------------------------------------------------------------------------------
+
+Rename the local settings file:
+
+    cd /path/to/thot/root/thot/
+    cp local_settings.py.dist local_settings.py
+
+3. EDITING THE LOCAL SETTINGS FILE
+--------------------------------------------------------------------------------
+
+a. Configure the debug functionnality
+    * "DEBUG" setting
+    * Never set DEBUG to True in production environnement. This will give to 
+	  everyone critical informations about your server and app configuration
+    * DEBUG = TRUE in developpement environnement gives you the ability to 
+	  track bugs easily
+
+b. Define the admins and managers of the web application
+	* "ADMINS" and "MANAGERS" settings
+	* List of tuples containing your name at index-0 and you e-mail at index-1
+
+c. Configure your backend:
+	* "DATABASE_ENGINE": more informations in file
+	* "DATABASE_NAME"
+    * "DATABASE_USER"
+	* "DATABASE_PASSWORD"
+	* "DATABASE_HOST"
+	* "DATABASE_PORT"
+
+d. Configure the time zone:
+	* "TIME_ZONE" setting
+ 	* Vist http://en.wikipedia.org/wiki/List_of_tz_zones_by_name to find an 
+	  exhaustive list of time zones
+
+e. Configure the language code:
+    * "LANGUAGE_CODE" setting
+	* Languages yet available : en, fr
+
+f. Set the path to media, templates and locales:
+	* "MEDIA_ROOT", "TEMPLATE_DIRS", "LOCALE_PATHS" settings
+	* This is already dynamically defined. It should work !
+
+g. Set the logging informations
+    * A rotating file handler is already defined
+    * Define path to the log file (default: /tmp/thot.out)
+    * Define the log level (default: INFO)
+
+h. Options
+    - Adding a CAS authentication:
+        * Uncomment the django_cas middleware in the "MIDDLEWARE_CLASSES" 
+		  setting
+        * Uncomment the "AUTHENTICATION_BACKENDS" setting
+        * Configure the cas server informations in the "CAS CONFIGURATION" 
+          section
+    - Adding an LDAP Server to create users "on the fly"
+        * Configure the ldap server informations in the "LDAP CONFIGURATION" 
+          section
+
+3. POPULATING DATABASE
+--------------------------------------------------------------------------------
+
+ * cd /path/to/thot/root/thot/
+ * python manage.py syncdb
+
+ * And let yourself be guided
+
+4. CHECK INSTALLATION
+---------------------------------------------------------------------------------
+
+ * python manage.py runserver 8000
+ * Point your favorite webbrowser to this address: http://localhost:8000
+ * Enjoy !
+
+ * To add some data go to http://localhost:8000/admin/