Changeset 2464 in main for trunk/docs


Ignore:
Timestamp:
06/17/13 13:09:43 (6 years ago)
Author:
pcosquer
Message:

docs: upgrade instructions: documents new settings

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/en/admin/upgrade/upgrade-1.3.rst

    r2266 r2464  
    33=========================================== 
    44 
    5 :Date: 2013-03-12 
     5:Date: 2013-06-17 
    66 
    77New/updated dependencies 
     
    4343before migrating a database: 
    4444 
    45     * ``pip install -U south`` 
     45    * ``pip install -U 'south==0.7.6'`` 
    4646 
    4747psycopg2 
     
    8585++++++++++++ 
    8686 
    87 ALLOWED_HOSTS 
    88  
    89 COMMENT_APPS 
    90  
    91 USE_TZ 
    92  
    93 AUTH_PROFILE_MODULE 
    94  
    95 BROKER_URL 
    96  
    97 INSTALLED_APPS 
    98  
    99 STATIC_ROOT 
    100  
    101 STATIC_URL 
    102  
    103 ADMIN_MEDIA_PREFIX 
    104  
    105 TEMPLATE_LOADERS 
    106  
    107 MIDDLEWARE_CLASSES 
    108  
    109  
    110 TEMPLATE_CONTEXT_PROCESSORS 
    111  
    112  
    113 LOCALE_PATHS 
     87.. data:: PROJECT_ROOT 
     88 
     89    Add the following line at the top of file:: 
     90 
     91        import sys 
     92        import os.path 
     93 
     94        PROJECT_ROOT = os.path.dirname(os.path.abspath(__file__)) 
     95 
     96 
     97.. data:: ALLOWED_HOSTS 
     98 
     99    It must be set to a list of strings representing the host/domain names that this Django site can serve. 
     100 
     101    For example:: 
     102 
     103        ALLOWED_HOSTS = [ 
     104            '.example.com', # Allow domain and subdomains 
     105            '.example.com.', # Also allow FQDN and subdomains 
     106        ] 
     107 
     108    See :setting:`django:ALLOWED_HOSTS` 
     109 
     110 
     111.. data:: COMMENT_APPS 
     112 
     113    Must be set to:: 
     114         
     115        COMMENTS_APP = "openPLM.plmapp" 
     116 
     117.. data:: USE_TZ 
     118 
     119    Must be set to:: 
     120 
     121        USE_TZ = True 
     122 
     123.. data:: BROKER_URL 
     124 
     125    Adds the following lines after all ``BROKER_*`` lines:: 
     126                 
     127        BROKER_URL = "amqp://%s:%s@%s:%d/%s" % (BROKER_USER, 
     128                BROKER_PASSWORD, BROKER_HOST, BROKER_PORT, BROKER_VHOST) 
     129        del BROKER_USER, BROKER_PASSWORD, BROKER_HOST, BROKER_PORT, BROKER_VHOST 
     130 
     131.. data:: INSTALLED_APPS 
     132 
     133    The first installed applications must be:: 
     134 
     135        INSTALLED_APPS = ( 
     136            'django.contrib.auth', 
     137            'django.contrib.contenttypes', 
     138            'django.contrib.sessions', 
     139            'django.contrib.sites', 
     140            'django.contrib.admin', 
     141            'django.contrib.comments', 
     142            'django.contrib.humanize', 
     143            'django.contrib.messages', 
     144            'django.contrib.staticfiles', 
     145            'djcelery', 
     146            'haystack', 
     147            'south', 
     148            'openPLM.plmapp', 
     149            # your optional applications are set here 
     150        ) 
     151 
     152 
     153.. data:: STATIC_ROOT 
     154 
     155    Must be set to:: 
     156         
     157        STATIC_ROOT = os.path.join(PROJECT_ROOT, "static") 
     158         
     159 
     160.. data:: STATIC_URL 
     161     
     162    Must be set to:: 
     163         
     164        STATIC_URL = "/static/" 
     165 
     166 
     167.. data:: TEMPLATE_LOADERS 
     168 
     169    Must be set to:: 
     170 
     171        TEMPLATE_LOADERS = ( 
     172            "django.template.loaders.filesystem.Loader", 
     173            "django.template.loaders.app_directories.Loader", 
     174        ) 
     175 
     176    or (cached version):: 
     177 
     178        TEMPLATE_LOADERS = ( 
     179            ('django.template.loaders.cached.Loader', ( 
     180                "django.template.loaders.filesystem.Loader", 
     181                "django.template.loaders.app_directories.Loader", 
     182            )), 
     183        ) 
     184 
     185.. data:: MIDDLEWARE_CLASSES 
     186 
     187    Must be set to:: 
     188                 
     189        MIDDLEWARE_CLASSES = ( 
     190            'django.middleware.common.CommonMiddleware', 
     191            'django.middleware.csrf.CsrfViewMiddleware', 
     192            'django.contrib.sessions.middleware.SessionMiddleware', 
     193            'django.contrib.auth.middleware.AuthenticationMiddleware', 
     194            'django.contrib.messages.middleware.MessageMiddleware', 
     195            'openPLM.plmapp.middleware.locale.ProfileLocaleMiddleware', 
     196        ) 
     197 
     198 
     199.. data:: TEMPLATE_CONTEXT_PROCESSORS 
     200 
     201    Must be set to:: 
     202 
     203        TEMPLATE_CONTEXT_PROCESSORS = ( 
     204                "django.contrib.auth.context_processors.auth", 
     205                "django.core.context_processors.debug", 
     206                "django.core.context_processors.i18n", 
     207                "django.core.context_processors.media", 
     208                "django.core.context_processors.static", 
     209                "django.core.context_processors.request", 
     210                "django.contrib.messages.context_processors.messages", 
     211        ) 
     212 
     213.. data:: LOCALE_PATHS 
     214     
     215    Must be set to:: 
     216 
     217        LOCALE_PATHS = ( 
     218            os.path.join(PROJECT_ROOT, "locale"), 
     219        ) 
     220 
     221Removed 
     222++++++++++ 
     223 
     224The settings ``AUTH_PROFILE_MODULE`` and ``ADMIN_MEDIA_PREFIX`` are no longer required 
     225and can be safely removed. 
     226 
    114227 
    115228Optional 
    116229++++++++++ 
    117230 
    118 RICHTEXT_FILTER 
    119  
    120 REFERENCES 
     231.. data:: RICHTEXT_FILTER and RICHTEXT_WIDGET_CLASS 
     232 
     233    This settings set the wiki syntax used by comments and description fields. 
     234 
     235    To enable the Markdown syntaxe, add the following lines:: 
     236 
     237        RICHTEXT_FILTER = 'openPLM.plmapp.filters.markdown_filter' 
     238        RICHTEXT_WIDGET_CLASS = 'openPLM.plmapp.widgets.MarkdownWidget' 
     239 
     240    See :ref:`richtext-admin`. 
     241     
     242.. data:: REFERENCE_PATTERNS 
     243 
     244    This setting describes how new document and part references are generated. 
     245    See :ref:`admin-references`. 
     246 
    121247 
    122248Applications 
    123249=================== 
    124250 
    125 Badges: new required middleware 
     251Badges 
     252++++++++ 
     253 
     254If the badges application is installed, set the ``MIDDLEWARE_CLASSES`` setting to:: 
     255 
     256 
     257    MIDDLEWARE_CLASSES = ( 
     258        'django.middleware.common.CommonMiddleware', 
     259        'django.middleware.csrf.CsrfViewMiddleware', 
     260        'django.contrib.sessions.middleware.SessionMiddleware', 
     261        'django.contrib.auth.middleware.AuthenticationMiddleware', 
     262        'django.contrib.messages.middleware.MessageMiddleware', 
     263        'openPLM.plmapp.middleware.locale.ProfileLocaleMiddleware', 
     264        'openPLM.apps.badges.middleware.GlobalRequest', 
     265    ) 
    126266 
    127267Commands 
    128268============== 
    129269 
    130 Collect static 
     270It is necessary to run the following commands to serve all static files: 
     271 
     272    * ``./manage.py collectstatic --noinput`` 
    131273 
    132274Apache 
    133275================ 
    134  
    135 static files 
    136  
    137 avatars directory 
    138  
    139  
     276    
     277Apache must serve the ``static/`` folder. It must also be able to write in the ``media/`` directory. 
     278 
     279    * ``chown -R www-data:www-data media/`` 
     280 
     281Apache files look like: 
     282 
     283.. literalinclude:: ../apache/simple_1.3.conf 
     284    :language: apache 
     285 
     286SSL: 
     287 
     288.. literalinclude:: ../apache/ssl_1.3.conf 
     289    :language: apache 
     290 
     291Ad the following lines if document3D application is installed (befor the ``<Location /media>`` line): 
     292 
     293.. code-block:: apache 
     294 
     295    <Location /media/3D> 
     296        WSGIAccessScript /var/django/openPLM/trunk/openPLM/apache/access.wsgi 
     297    </Location> 
     298 
Note: See TracChangeset for help on using the changeset viewer.