Merge pull request #364 from tracim/fix/234/apache_documentation

doc/apache.md

@@ -1,31 +1,52 @@
-# Running Tracim through Apache WSGI #
+# Running Tracim through Apache #
 
-## Installation ##
+### Installation ###
 
-Install `Apache` `HTTP` server and its `WSGI` module:
+Install `Apache` server and its [`WSGI` module](https://github.com/GrahamDumpleton/mod_wsgi):
 
     sudo apt install apache2 libapache2-mod-wsgi-py3
 
-## Configuration ##
+### Configuration ###
 
-Example of `Apache` `WSGI` configuration. This configuration refers to
-`productionapp.wsgi` which is a copy of the file `app.wsgi` available in the
-repo. (this file has to be updated to match with your environment and
-installation)
+Create a file named `/etc/apache2/sites-available/tracim.conf` containing:
 
-    <VirtualHost *:80>
-        ServerAdmin webmaster@tracim.mycompany.com
-        ServerName tracim.mycompany.com
+    Listen 8080
 
+    <VirtualHost *:8080>
+        ServerName tracim
+
+        # Serve Tracim through WSGI
+        WSGIDaemonProcess tracim user=[your_user] group=[your_user] threads=4 python-home=[tracim_path]/tg2env python-path=[tracim_path]/tracim lang='C.UTF-8' locale='C.UTF-8'
         WSGIProcessGroup tracim
-        WSGIDaemonProcess tracim user=www-data group=adm threads=4 python-path=/opt/traciminstall/tg2env/lib/python3.2/site-packages
-        WSGIScriptAlias / /opt/traciminstall/tracim/productionapp.wsgi
+        WSGIScriptAlias / [tracim_path]/tracim/app.wsgi process-group=tracim
+        <Directory "[tracim_path]/tracim">
+            <Files "app.wsgi">
+                Require all granted
+            </Files>
+        </Directory>
+
+        # Serve static files directly
+        Alias /assets          [tracim_path]/tracim/tracim/public/assets
+        Alias /_caldavzap      [tracim_path]/tracim/tracim/public/_caldavzap
+        Alias /favicon.ico     [tracim_path]/tracim/tracim/public/favicon.ico
+        <Directory "[tracim_path]/tracim/tracim/public">
+            Require all granted
+        </Directory>
+    </VirtualHost>
 
-        #Serve static files directly without TurboGears
-        Alias /assets     /opt/traciminstall/tracim/tracim/public/assets
-        Alias /favicon.ico /opt/traciminstall/tracim/tracim/public/favicon.ico
+Replace `[tracim_path]` and `[your_user]` by your tracim installation path and your user.
 
-        CustomLog /var/log/apache2/demotracim-access.log combined
-        ErrorLog /var/log/apache2/demotracim-error.log
-        LogLevel debug
-    </VirtualHost>
+Load needed proxy modules and enable this site configuration file:
+
+    sudo a2enmod proxy proxy_http
+    sudo a2ensite tracim.conf
+
+Reload `Apache` configuration:
+
+    sudo systemctl reload apache2.service
+
+## Documentation Links ##
+
+[TurboGears](http://turbogears.readthedocs.io/en/tg2.3.7/cookbook/deploy/mod_wsgi.html)
+
+[mod_wsgi](http://modwsgi.readthedocs.io/en/develop/index.html)

tracim/app.wsgi

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-APP_CONFIG = "/opt/traciminstallpath/development.ini"
+APP_CONFIG = "/var/www/tracim/tracim/development.ini"
 
 #Setup logging
 # import logging
@@ -10,4 +10,3 @@ APP_CONFIG = "/opt/traciminstallpath/development.ini"
 from paste.deploy import loadapp
 application = loadapp('config:%s' % APP_CONFIG)
 application.debug = False
-

tracim/wsgidav.conf.sample

@@ -1,33 +1,33 @@
-################################################################################
-# Sample WsgiDAV configuration file
-#
-# 1. Rename this file to `wsgidav.conf`
-# 2. Adjust settings as appropriate
-# 3. Run tracim as you always do :)
-#
-################################################################################
-
-################################################################################
-# SERVER OPTIONS
-#===============================================================================
-
-# host  = "localhost"
-# host  = "192.168.0.1"
-host  = "0.0.0.0"
-
-port = 3030
-
-show_history = True
-show_deleted = True
-show_archived = True
-
-manager_locks = True
-
-root_path = ''
-
-#===============================================================================
-# Lock Manager
-#
-# Example: Use PERSISTENT shelve based lock manager
-#from wsgidav.lock_storage import LockStorageShelve
-#locksmanager = LockStorageShelve("wsgidav-locks.shelve")
+################################################################################
+# Sample WsgiDAV configuration file
+#
+# 1. Rename this file to `wsgidav.conf`
+# 2. Adjust settings as appropriate
+# 3. Run tracim as you always do :)
+#
+################################################################################
+
+################################################################################
+# SERVER OPTIONS
+#===============================================================================
+
+# host  = "localhost"
+# host  = "192.168.0.1"
+host  = "0.0.0.0"
+
+port = 3030
+
+show_history = True
+show_deleted = True
+show_archived = True
+
+manager_locks = True
+
+root_path = ''
+
+#===============================================================================
+# Lock Manager
+#
+# Example: Use PERSISTENT shelve based lock manager
+#from wsgidav.lock_storage import LockStorageShelve
+#locksmanager = LockStorageShelve("wsgidav-locks.shelve")