diff options
Diffstat (limited to 'docs/_build/html/install.html')
| -rw-r--r-- | docs/_build/html/install.html | 82 |
1 files changed, 43 insertions, 39 deletions
diff --git a/docs/_build/html/install.html b/docs/_build/html/install.html index 3121524..6aaf672 100644 --- a/docs/_build/html/install.html +++ b/docs/_build/html/install.html @@ -130,7 +130,7 @@ to the applications’ websites.</p> <div class="section" id="database-configuration"> <h2>Database configuration<a class="headerlink" href="#database-configuration" title="Permalink to this headline">¶</a></h2> <p>Now that postgres and postgis are installed, you need to create a new user for -chimere:</p> +Chimère:</p> <div class="highlight-python"><pre>su postgres createuser --echo --adduser --createdb --encrypted --pwprompt chimere-user</pre> </div> @@ -143,8 +143,8 @@ psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/postgis psql -d chimere -f /usr/share/postgresql/$PG_VERSION/contrib/postgis-1.5/spatial_ref_sys.sql</pre> </div> </div> -<div class="section" id="install-the-sources"> -<h2>Install the sources<a class="headerlink" href="#install-the-sources" title="Permalink to this headline">¶</a></h2> +<div class="section" id="installing-the-sources"> +<h2>Installing the sources<a class="headerlink" href="#installing-the-sources" title="Permalink to this headline">¶</a></h2> <p>Choose a path to install your Chimère:</p> <div class="highlight-python"><pre>INSTALL_PATH=/var/local/django mkdir $INSTALL_PATH</pre> @@ -153,8 +153,7 @@ mkdir $INSTALL_PATH</pre> <h3>From an archive<a class="headerlink" href="#from-an-archive" title="Permalink to this headline">¶</a></h3> <p>The last “stable” version is available in this <a class="reference external" href="http://www.peacefrogs.net/download/chimere/">directory</a>. Take care of getting the last version in the desired X.Y branch (for instance -the last version for the 1.0 branch is version 1.0.2. -Extract it to the desired destination path:</p> +the last version for the 1.0 branch is version 1.0.2).:</p> <div class="highlight-python"><pre>wget http://www.peacefrogs.net/download/chimere -q -O -| html2text (...) [[ ]] chimere-1.0.0.tar.bz2 17-Nov-2010 16:51 53K @@ -173,7 +172,7 @@ chown -R myusername:www-data chimere</pre> </div> <div class="section" id="from-the-git-repository"> <h3>From the git repository<a class="headerlink" href="#from-the-git-repository" title="Permalink to this headline">¶</a></h3> -<p>Another solution is to get the last git version:</p> +<p>Another solution is to get it from the git repository:</p> <div class="highlight-python"><pre>cd $INSTALL_PATH git clone git://www.peacefrogs.net/git/chimere cd chimere @@ -182,23 +181,23 @@ git checkout v2.0 # checkout the desired version</pre> </div> </div> </div> -<div class="section" id="create-a-custom-project-template"> -<h2>Create a custom project template<a class="headerlink" href="#create-a-custom-project-template" title="Permalink to this headline">¶</a></h2> -<p>There a default project is provided (example_project). Copy and modify it (or -get another project based on Chimere):</p> +<div class="section" id="creating-a-custom-project-template"> +<h2>Creating a custom project template<a class="headerlink" href="#creating-a-custom-project-template" title="Permalink to this headline">¶</a></h2> +<p>There, a default project is provided (<em>example_project</em>). Copy and modify +it (or get another project based on Chimère):</p> <div class="highlight-python"><pre>cd $INSTALL_PATH/chimere cp -ra example_project mychimere_project</pre> </div> <p>Your project name is used for the name of the Python package of your template. As a Python package it should follow the rule of Python variable name: -it must be at least one letter and can have a string of numbers, letters and -underscores (“_”) to any length. Don’t begin the name by “_” because it has -special significance in Python.</p> -<p>In your chimere application directory create local_settings.py to fit to your +it must contain at least one letter and can have a string of numbers, letters and +underscores (“_”) to any length. Don’t use accentuated letters. Don’t begin the +name by “_” because it has special significance in Python.</p> +<p>In your Chimère application directory create <em>local_settings.py</em> to fit to your configuration. -A base template is provided (local_settings.py.example) and short descriptions of -the more relevant fields are given below (at least check them). Most of these -settings are initialized in settings.py.</p> +A base template is provided (<em>local_settings.py.example</em>) and short descriptions +of the more relevant fields are given below (at least check them). Most of +these settings are initialized in <em>settings.py</em>.</p> <div class="highlight-python"><pre>cd $INSTALL_PATH/chimere/mychimere_project cp local_settings.py.sample local_settings.py vim local_settings.py</pre> @@ -212,18 +211,20 @@ vim local_settings.py</pre> <li>PROJECT_NAME: name of the project</li> <li>SECRET_KEY: a secret key for a particular Django installation. This is used to provide cryptographic signing, and should be set to a unique, -unpredictable value. Change it!</li> +unpredictable value. <strong>Change it!</strong></li> <li>ROOT_URLCONF: url configuration for your project something like: ‘mychimere_project.urls’</li> <li>EMAIL_HOST: smtp of an email server to send emails</li> <li>TINYMCE_URL: url to tinymce path (default is appropriate for a Debian -installation with tinymce activated)</li> -<li>JQUERY_JS_URLS: list of Jquery and Jquery-ui urls (default is appropriate -for a Debian installation with Jquery and Jquery-ui activated)</li> -<li>JQUERY_CSS_URLS: list of Jquery and Jquery-ui urls (default is appropriate -for a Debian installation with Jquery and Jquery-ui activated)</li> +installation with tinymce package installed)</li> +<li>JQUERY_JS_URLS: list of jquery and jquery-ui javascript urls (default is +appropriate for a Debian installation with libjs-jquery libjs-jquery-ui +packages installed)</li> +<li>JQUERY_CSS_URLS: list of jquery and jquery-ui CSS urls (default is +appropriate for a Debian installation with libjs-jquery libjs-jquery-ui +packages installed)</li> <li>GPSBABEL: path to gpsbabel (default is appropriate for a Debian -installation with gpsbabel installed)</li> +installation with gpsbabel package installed)</li> <li>TIME_ZONE: local time zone for this installation</li> <li>LANGUAGE_CODE: language code for this installation</li> </ul> @@ -249,9 +250,9 @@ chmod -R g+w /var/log/django/</pre> </div> <div class="section" id="compiling-languages"> <h2>Compiling languages<a class="headerlink" href="#compiling-languages" title="Permalink to this headline">¶</a></h2> -<p>If your language is available in the locale directory of chimere, you will just -need to get it compiled. This can be done with (here, <strong>fr</strong> stands for french. -Replace it with the appropriate language code):</p> +<p>If your language is available in the directory <em>chimere/locale/</em>, you will just +need to get it compiled. This can be done with the following command (here, +<strong>fr</strong> stands for French, replace it with the appropriate language code):</p> <div class="highlight-python"><pre>cd $INSTALL_PATH/chimere/chimere/ django-admin compilemessages</pre> </div> @@ -268,13 +269,13 @@ would have if the language file was already available.</p> </div> <div class="section" id="database-initialisation"> <h2>Database initialisation<a class="headerlink" href="#database-initialisation" title="Permalink to this headline">¶</a></h2> -<p>Create the appropriate tables (still being in chimère application directory):</p> +<p>Create the appropriate tables (still being in your Chimère project directory):</p> <div class="highlight-python"><pre>cd $INSTALL_PATH/chimere/mychimere_project ./manage.py syncdb</pre> </div> <p>You will be prompted for the creation of an administrator account -(administration can be found at: <a class="reference external" href="http://where_is_chimere/admin">http://where_is_chimere/admin</a>). Then you have -to create tables managed with south:</p> +(administration can be found at: <a class="reference external" href="http://where_is_chimere/admin/">http://where_is_chimere/admin/</a>). Then you have +to create tables managed with Django-South:</p> <div class="highlight-python"><pre>./manage.py migrate</pre> </div> <p>The database is set, congratulations!</p> @@ -287,26 +288,29 @@ an already populated instance!):</p> <h2>Webserver configuration<a class="headerlink" href="#webserver-configuration" title="Permalink to this headline">¶</a></h2> <div class="section" id="apache-configuration-with-mod-wsgi"> <h3>Apache configuration with mod_wsgi<a class="headerlink" href="#apache-configuration-with-mod-wsgi" title="Permalink to this headline">¶</a></h3> -<p>Install mod_wsgi for apache:</p> +<p>Install <em>mod_wsgi</em> for Apache:</p> <div class="highlight-python"><pre>apt-get install libapache2-mod-wsgi</pre> </div> -<p>TODO: adapt apache-wsgi.conf</p> <p>Create and edit a configuration for Chimère:</p> -<div class="highlight-python"><pre>cp $INSTALL_PATH/chimere/apache/django.wsgi $INSTALL_PATH/chimere/apache/mydjango.wsgi +<div class="highlight-python"><pre>cp $INSTALL_PATH/chimere/apache/django.wsgi \ + $INSTALL_PATH/chimere/apache/mydjango.wsgi vim $INSTALL_PATH/chimere/apache/mydjango.wsgi -cp $INSTALL_PATH/chimere/apache/apache-wsgi.conf /etc/apache2/sites-available/chimere +cp $INSTALL_PATH/chimere/apache/apache-wsgi.conf \ + /etc/apache2/sites-available/chimere vim /etc/apache2/sites-available/chimere # create log dir -mkdir /var/log/apache2/chimere/</pre> +mkdir /var/log/apache2/chimere/ +chown www-data /var/log/apache2/chimere/</pre> </div> -<p>Adapt the files <em>mydjango.wsgi</em> (with the correct sys path) and Apache <em>chimere</em>.</p> +<p>Adapt the files <em>mydjango.wsgi</em> (with the correct sys path and the correct +module) and Apache <em>chimere</em> (with the correct servername and correct paths).</p> <p>To activate the website, reload apache:</p> <div class="highlight-python"><pre>a2ensite chimere /etc/init.d/apache2 reload</pre> </div> <p>If you encounter problem with the upload of files with Unicode chars in their names, activate the appropriate locale in Apache. On a Debian server with UTF-8 -as default encoding in the file <em>/etc/apache2/envvars</em>, uncomment the following +as default encoding, in the file <em>/etc/apache2/envvars</em> uncomment the following line:</p> <div class="highlight-python"><pre>. /etc/default/locale</pre> </div> @@ -325,12 +329,12 @@ line:</p> <li><a class="reference internal" href="#">Installation</a><ul> <li><a class="reference internal" href="#prerequisites">Prerequisites</a></li> <li><a class="reference internal" href="#database-configuration">Database configuration</a></li> -<li><a class="reference internal" href="#install-the-sources">Install the sources</a><ul> +<li><a class="reference internal" href="#installing-the-sources">Installing the sources</a><ul> <li><a class="reference internal" href="#from-an-archive">From an archive</a></li> <li><a class="reference internal" href="#from-the-git-repository">From the git repository</a></li> </ul> </li> -<li><a class="reference internal" href="#create-a-custom-project-template">Create a custom project template</a></li> +<li><a class="reference internal" href="#creating-a-custom-project-template">Creating a custom project template</a></li> <li><a class="reference internal" href="#compiling-languages">Compiling languages</a></li> <li><a class="reference internal" href="#database-initialisation">Database initialisation</a></li> <li><a class="reference internal" href="#webserver-configuration">Webserver configuration</a><ul> |