Merge pull request #240 from algooapy/fix/228/review_readme_md

.travis.yml

 sudo: false
 language: python
-python: "3.4"
+python:
+  - "3.4"
+  - "3.5"
+  - "3.6"
 
 env:
   - DB=postgres
 
 install:
   - cd tracim && python setup.py develop; cd -
+  - echo coveralls >> install/requirements.txt; echo
+  - cat install/requirements.postgresql.txt >> install/requirements.txt; echo
+  - cat install/requirements.mysql.txt >> install/requirements.txt; echo
   - pip install -r install/requirements.txt; echo
-  - pip install coveralls
 
 before_script:
   - cp ${TRAVIS_BUILD_DIR}/tracim/development.ini.base ${TRAVIS_BUILD_DIR}/tracim/development.ini
   - sh -c "if [ '$DB' = 'postgres' ]; then cd ${TRAVIS_BUILD_DIR}/tracim && sed -i \"s/\(sqlalchemy.url *= *\).*/\1postgresql:\/\/postgres:dummy@127.0.0.1:5432\/tracim_test?client_encoding=utf8/\" development.ini; fi"
 
   - sh -c "if [ '$DB' = 'mysql' ]; then mysql -e 'CREATE DATABASE tracim_test;'; fi"
-  - sh -c "if [ '$DB' = 'mysql' ]; then cd ${TRAVIS_BUILD_DIR}/tracim && sed -i \"s/\(sqlalchemy.url *= *\).*/\mysql+oursql:\/\/root@localhost\/tracim_test/\" test.ini; fi"
-  - sh -c "if [ '$DB' = 'mysql' ]; then cd ${TRAVIS_BUILD_DIR}/tracim && sed -i \"s/<replace_database_uri_here>/mysql+oursql:\/\/root@localhost\/tracim_test/\" development.ini; fi"
-  - sh -c "if [ '$DB' = 'mysql' ]; then pip install https://launchpad.net/oursql/py3k/py3k-0.9.4/+download/oursql-0.9.4.zip; fi"
+  - sh -c "if [ '$DB' = 'mysql' ]; then cd ${TRAVIS_BUILD_DIR}/tracim && sed -i \"s/\(sqlalchemy.url *= *\).*/\mysql+pymysql:\/\/root@localhost\/tracim_test/\" test.ini; fi"
+  - sh -c "if [ '$DB' = 'mysql' ]; then cd ${TRAVIS_BUILD_DIR}/tracim && sed -i \"s/<replace_database_uri_here>/mysql+pymysql:\/\/root@localhost\/tracim_test/\" development.ini; fi"
 
   - sh -c "if [ '$DB' = 'sqlite' ]; then cd ${TRAVIS_BUILD_DIR}/tracim && sed -i \"s/\(sqlalchemy.url *= *\).*/\sqlite:\/\/\/tracim_test.sqlite/\" test.ini; fi"
   - sh -c "if [ '$DB' = 'sqlite' ]; then cd ${TRAVIS_BUILD_DIR}/tracim && sed -i \"s/<replace_database_uri_here>/sqlite:\/\/\/tracim.sqlite/\" development.ini; fi"
 script: "cd ${TRAVIS_BUILD_DIR}/tracim && nosetests -c ${TRAVIS_BUILD_DIR}/tracim/test.ini -v --with-coverage --cover-package=tracim --cover-erase"
 
 after_success:
-- coveralls
+  - coveralls

README.md

-[![Build Status](https://travis-ci.org/tracim/tracim.svg?branch=master)](https://travis-ci.org/tracim/tracim) [![Coverage Status](https://img.shields.io/coveralls/tracim/tracim.svg)](https://coveralls.io/r/tracim/tracim) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/tracim/tracim/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/tracim/tracim/?branch=master)
+[![Build Status](https://travis-ci.org/tracim/tracim.svg?branch=master)](https://travis-ci.org/tracim/tracim) [![Coverage Status](https://img.shields.io/coveralls/tracim/tracim.svg)](https://coveralls.io/r/tracim/tracim) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/tracim/tracim/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/tracim/tracim/?branch=master) [![PyPI](https://img.shields.io/pypi/pyversions/tracim.svg)](https://pypi.python.org/pypi/tracim)
 
 # Tracim - Introduction #
 
 With Tracim, you manage in the same place:
 
 - forum-like threads,
-- files and automatic versionning,
+- files and automatic versioning,
 - wiki-like pages for online information,
 
 All data offers:
 
 - information status: open / resolved / cancelled / deprecated
-- native versionning
-- comment threads making tracim knowledge-growth ready.
+- native versioning
+- comment threads making Tracim knowledge-growth ready.
 
 Join Tracim community : http://tracim.org
 
 
 ### Manage documents and files ###
 
-Traceability and versionning are very important for high-quality processes. Unfortunately, specialized software are hard to setup and to use.
+Traceability and versioning are very important for high-quality processes. Unfortunately, specialized software are hard to setup and use.
 
-Let's try Tracim ! You define access-control for each workspace and store documents and file there. Users can't delete information: everything is versionned and never deleted.
+Let's try Tracim ! You define access-control for each workspace and store documents and file there. Users can't delete information: everything is versioned and never deleted.
 
 The user interface is easy to use: it's based on the well-known folders and files explorer paradigm.
 
 
 Tracim is a web application:
 
-* developed with python >=3.4.
+* developed with python 3.4, 3.5, 3.6
 * based on the [TurboGears](http://www.turbogears.org/) web framework.
-* relying on [PostgreSQL](http://www.postgresql.org/) or [MySQL](https://www.mysql.fr/) or [sqlite](https://www.sqlite.org/) as the storage engine.
+* relying on [PostgreSQL](http://www.postgresql.org/) or [MySQL](https://www.mysql.fr/) or [SQLite](https://www.sqlite.org/) as the storage engine.
 
 The user interface is based on the following resources and technologies:
 
 
 # Installation #
 
-## Dependencies ##
+## Distribution dependencies ##
 
-_Note: the following information is for Debian. For other OS, adapt the package names._
+You'll need to install the following packages :
 
-You'll need to install the following packages on your Operating System:
+    sudo apt install git realpath redis-server \
+                     python3 python-virtualenv python3-dev python-pip  python-lxml \
+                     build-essential libxml2-dev libxslt1-dev zlib1g-dev
 
-    apt-get install git realpath python3 python-virtualenv python3-dev python-pip build-essential libxml2-dev libxslt1-dev python-lxml
+## Get the source ##
 
-You also need `redis-server` package if you want to send email in async mode.
+Get the sources from GitHub:
 
-## Database ##
+    git clone https://github.com/tracim/tracim.git
+    cd tracim/
 
-If you want use PostgreSQL as database engine:
+*Note: Now everything is documented to be executed from the tracim directory newly created.*
 
-    apt-get install postgresql-server-dev-all postgresql postgresql-client
+## Frontend dependencies ##
 
-Or if you want to use MySQL as database engine
+[//]: # ( from https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
 
-    apt-get install mysql-server mysql-client libmysqlclient-dev
+Install `nodejs` by typing:
 
-Or if you want to use SQLite as database engine
+    curl -sL https://deb.nodesource.com/setup_7.x | sudo -E bash -
+    sudo apt install -y nodejs
 
-    apt-get install sqlite3
+Check that this went well by getting `npm` version:
 
-## Installation ##
+    npm -v
 
-### Get the source ###
+Then install frontend dependencies listed in the file `package.json`:
 
-Get the sources from github with git:
+    npm install
 
-    git clone https://github.com/tracim/tracim.git
-    cd tracim/
-
-*Note: Now everything is documented to be executed from the tracim directory newly created.*
+At last, compile frontend files:
 
-### Setting-up python virtualenv ###
+    npm run gulp-dev # for a development environment
+    # npm run gulp-prod # for a production environment
 
-_Reminder : Tracim is developed and tested using python3.4._
+## Tracim virtual environment ##
 
-We strongly recommend to use virtualenv as deployment environment. This ensure that there will be no conflict between system-wide python installation and Tracim required ones. To Create the virtual environment:
+Create a python virtual environment:
 
     virtualenv -p /usr/bin/python3.4 tg2env
 
-And to activate it in your terminal session (**all tracim command execution must be executed under this virtual environment**)):
+Activate it in your terminal session (**all tracim command execution must be executed under this virtual environment**):
 
     source tg2env/bin/activate
 
-To install tracim and it's dependencies:
+Install Tracim and its dependencies:
 
     cd tracim && python setup.py develop && cd -
     pip install -r install/requirements.txt
 
-**Note**: If you want to use MySQL database, please refer to Configuration/database schema note to install required package.
-
-## Database Setup ##
-
-### Minimalist introduction to PostgreSQL ###
-
-If you already use/know PostgreSQL, you can directly go to *Test the database access*.
-
-#### Allowing local connections on PostgreSQL ####
-
-PostgreSQL stores connections ahtorization in *pg\_hba.conf*
-
-Edit the pg_hba.conf file and check that connectionx from 127.0.0.1 are allowed using user/password. You should find the following line in the file:
-
-    # IPv4 local connections:
-    host    all             all             127.0.0.1/32            md5
-
-Note: on Debian, the *pg\_hba.conf* file is found at */etc/postgresql/9.1/main/pg\_hba.conf*
-
-If you changed the file, reload PostgreSQL:
-
-    service postgresql reload
-
-#### Creating a user and associated database ####
-
-You need a database and associated user/password.
-
-Tracim comes with a tool that will make this step easy : pgtool.
-
-    ~/tracim$ ./bin/pgtool help
-
-login as *postgres* user and run the follwoing commands (which are self explanatory)
-
-    ./bin/pgtool create_user tracimuser tracimpassword
-    ./bin/pgtool create_database tracimdb
-    ./bin/pgtool grant_all_privileges tracimdb tracimuser
-
-Notes :
-
-* in order to login as postgres user, su as root (with your password) then su postgres.
-* pgtool also offers options to delete users / databases. Run *./bin/pgtool help* for more information
-
-#### Test the database access ####
-
-So, now you have a database and an associated user/password.
-
-A good habit is to test things before to use them, that's why we want to test the database access now. This is easily done with tracim pgtool :
-
-    ./bin/pgtool test_connection tracimdb tracimuser tracimpassword 127.0.0.1
-
-The result is similar to the following :
-
-    PG # CONNECT TO DATABASE
-    ------------------------
-    server:     127.0.0.1
-    database:   tracimdb
-    username:   bibi
-
-                  now
-    -------------------------------
-     2014-11-10 09:40:23.306199+01
-    (1 row)
-
-In case of failure, you would get something like this:
-
-    PG # CONNECT TO DATABASE
-    ------------------------
-    server:     127.0.0.1
-    database:   tracimdb
-    username:   bibi
-
-    psql: FATAL:  password authentication failed for user "bibi"
-    FATAL:  password authentication failed for user "bibi"
-    ERRROR
-
-In this case, delete the user and database you previously created (using pgtool) and do it again. Do not forget to run the grant_all_rights command!
-
-### Minimalist introduction to MySQL ###
-
-## Create database ##
-
-Connect to mysql with root user (password has been set at "Installation" -> "Dependencies" chapter, when installing package)
-
-    mysql -u root -p
-
-Create a database with following command:
-
-    CREATE DATABASE tracimdb;
-
-Create a user with following command:
-
-    CREATE USER 'tracimuser'@'localhost' IDENTIFIED BY 'tracimpassword';
-
-And allow him to manipulate created database with following command:
-
-    GRANT ALL PRIVILEGES ON tracimdb . * TO 'tracimuser'@'localhost';
-
-Then flush privileges:
-
-    FLUSH PRIVILEGES;
-
-You can now quit mysql prompt:
-
-    \q
-
-## Configuration ##
-
-At this point, you have :
+## Configuration files ##
 
-* an installation of Tracim with its dedicated python3-ready virtualenv
-* a PostgreSQL/MySQL server and dedicated database (if you don't use sqlite)
-
-What you have to do now is to configure the application and to initialize the database content.
-
-### Create configuration ###
+Create configuration files for a development environment and for `WsgiDAV`:
 
     cp tracim/development.ini.base tracim/development.ini
+    cp tracim/wsgidav.conf.sample tracim/wsgidav.conf
 
-You can now edit the file and setup required files. Here are the main ones:
-
-#### Database access ####
-
-Configure database in the development.ini file. This is defined as sqlalchemy.url. There is an example value for PostgreSQL below:
-
-    sqlalchemy.url = postgresql://tracimuser:tracimpassword@127.0.0.1:5432/tracimdb?client_encoding=utf8
-
-There is an example value for MySQL below (please refer to Configuration/database schema note to install required package):
-
-    sqlalchemy.url = mysql+oursql://tracimuser:tracimpassword@127.0.0.1/tracimdb
-
-There is an example value for SQLite below :
-
-    sqlalchemy.url = sqlite:///tracimdb.sqlite
-
-#### Listening port
-
-Default configuration is to listen on port 8080. If you want to adapt this to your environment, edit the .ini file and setup the port you want:
-
-    port = 8080
-
-#### Interface language
-
-The default language is English. You can change it to French by uncommenting the following line in the .ini file:
-
-    lang = fr
-
-#### SMTP parameters for resetpassword and notifications
-
-for technical reason, you have to configure SMTP parameters for rest password process and SMTP parameters for notifications in separate places.
-
-The reset password related parameters are the follwoing ones :
-
-    resetpassword.email_sender = tracim@mycompany.com
-    resetpassword.smtp_host = smtp.mycompany.com
-    resetpassword.smtp_port = 25
-    resetpassword.smtp_login = username
-    resetpassword.smtp_passwd = password
-
-The main parameters for notifications are the following ones:
-
-    email.notification.activated = true
-    email.notification.from.email = noreply@trac.im
-    email.notification.from.default_label = Tracim Notification
-    email.notification.smtp.server = smtp.mycompany.com
-    email.notification.smtp.port = 25
-    email.notification.smtp.user = username
-    email.notification.smtp.password = password
-
-#### Website ####
-
-You must define general parameters like the base_url and the website title which are required for home page and email notification links
-
-    website.title = My Company Intranet
-    website.base_url = http://intranet.mycompany.com:8080
-
-#### LDAP ####
-
-To use LDAP authentication, set ``auth_type`` parameter to "ldap":
+## Database schema ##
 
-    auth_type = ldap
+The last step before running the application is to initialize the database
+schema. This is done through the following command:
 
-Then add LDAP parameters
-
-    # LDAP server address
-    ldap_url = ldap://localhost:389
-
-    # Base dn to make queries
-    ldap_base_dn = dc=directory,dc=fsf,dc=org
-
-    # Bind dn to identify the search
-    ldap_bind_dn = cn=admin,dc=directory,dc=fsf,dc=org
-
-    # The bind password
-    ldap_bind_pass = toor
-
-    # Attribute name of user record who contain user login (email)
-    ldap_ldap_naming_attribute = uid
-
-    # Matching between ldap attribute and ldap user field (ldap_attr1=user_field1,ldap_attr2=user_field2,...)
-    ldap_user_attributes = mail=email
-
-    # TLS usage to communicate with your LDAP server
-    ldap_tls = False
-
-    # If True, LDAP own tracim group managment (not available for now!)
-    ldap_group_enabled = False
-
-You may need an administrator account to manage Tracim. Use the following command (from ``/install/dir/of/tracim/tracim``):
-
-    gearbox user create -l admin@admin.admin -p admin@admin.admin -g managers -g administrators
-
-Keep in mind ``admin-email@domain.com`` must match with LDAP user.
-
-#### Other parameters  ####
-
-There are other parameters which may be of some interest for you. For example, you can:
-
-* include a JS tracker like Piwik or Google Analytics,
-* define your own notification email subject
-* personalize notification email
-* personalize home page (background image, title color...)
-* ...
-
-### database schema ###
+    cd tracim && gearbox setup-app && cd -
 
-The last step before to run the application is to initialize the database schema. This is done through the following command:
+## Running the paste http server ##
 
-**Note**: If you want to use MySQL database, please install this pip package: ```pip install https://launchpad.net/oursql/py3k/py3k-0.9.4/+download/oursql-0.9.4.zip```
+    gearbox serve
 
-    cd tracim && gearbox setup-app && cd -
+While developing, the following command may be more convenient:
 
-## Running the server ##
+    gearbox serve --reload --debug
 
-### Running Tracim in standalone mode ###
+## Running the standalone server ##
 
 Now you can run the standalone server:
 
     13:53:50,862 INFO  [gearbox] Starting server in PID 11174.
     Starting HTTP server on http://0.0.0.0:8080
 
-You can now enter the application at [http://localhost:8080](http://localhost:8080) and login with admin user.
+You can now enter the application at
+[http://localhost:8080](http://localhost:8080) and login with admin user.
 
  * user : admin@admin.admin
  * password : admin@admin.admin
 
 Enjoy :)
 
-### Running Tracim through Apache WSGI ###
-
-#### Dependencies ####
-
-Install dependencies:
-
-    apt-get install apache2 libapache2-mod-wsgi-py3
-
-#### WSGI 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)
-
-    <VirtualHost *:80>
-        ServerAdmin webmaster@tracim.mycompany.com
-        ServerName tracim.mycompany.com
-
-        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
+# Going further #
 
-        #Serve static files directly without TurboGears
-        Alias /assets     /opt/traciminstall/tracim/tracim/public/assets
-        Alias /favicon.ico /opt/traciminstall/tracim/tracim/public/favicon.ico
+Here is additional documentation about configuring:
 
-        CustomLog /var/log/apache2/demotracim-access.log combined
-        ErrorLog /var/log/apache2/demotracim-error.log
-        LogLevel debug
-    </VirtualHost>
+ * [Apache](doc/apache.md)
+ * [PostgreSQL, MySQL and SQLAlchemy](doc/database.md)
+ * [Tracim](doc/setting.md)
 
 # Support and Community #
 

doc/apache.md

+# Running Tracim through Apache WSGI #
+
+## Installation ##
+
+Install `Apache` `HTTP` server and its `WSGI` module:
+
+    sudo apt install apache2 libapache2-mod-wsgi-py3
+
+## 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)
+
+    <VirtualHost *:80>
+        ServerAdmin webmaster@tracim.mycompany.com
+        ServerName tracim.mycompany.com
+
+        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
+
+        #Serve static files directly without TurboGears
+        Alias /assets     /opt/traciminstall/tracim/tracim/public/assets
+        Alias /favicon.ico /opt/traciminstall/tracim/tracim/public/favicon.ico
+
+        CustomLog /var/log/apache2/demotracim-access.log combined
+        ErrorLog /var/log/apache2/demotracim-error.log
+        LogLevel debug
+    </VirtualHost>

doc/apache.wsgi.example.txt

-<VirtualHost *:8888>
-    ServerName pod
-
-    WSGIProcessGroup pod
-    WSGIDaemonProcess pod user=www-data group=www-data threads=4 python-path=/home/daccorsi/sources/protos/pod/tg2env/lib/python3.2/site-packages
-    WSGIScriptAlias / /home/daccorsi/sources/protos/pod/pod/app.wsgi
-
-    #Serve static files directly without TurboGears
-    Alias /images     /home/daccorsi/sources/protos/pod/pod/pod/public/images
-    Alias /favicon.ico     /home/daccorsi/sources/protos/pod/pod/pod/public/favicon.ico
-    Alias /css        /home/daccorsi/sources/protos/pod/pod/pod/public/css
-    Alias /javascript /home/daccorsi/sources/protos/pod/pod/pod/public/javascript
-
-    CustomLog /var/log/apache2/pod-access.log combined
-    ErrorLog /var/log/apache2/pod-error.log
-    LogLevel info
-</VirtualHost>
-

doc/database.md

+
+# Database #
+
+*Note: This page helps you setting up a **development** environment for `Tracim` and its ORM `SQLAlchemy` with `PostgreSQL` and `MySQL`. To set up a **production** environment, changing default database name, database user name and moreover its password is mandatory.*
+
+## PostgreSQL ##
+
+If you want to use `PostgreSQL` as database engine:
+
+    sudo apt install postgresql-server-dev-all postgresql postgresql-client
+
+### Minimalist introduction to PostgreSQL ###
+
+If you already use/know `PostgreSQL`, you can directly go to *Test the database access*.
+
+#### Driver ####
+
+Tracim uses the `psycopg2` driver between the `SQLAlchemy` ORM and the `PostgreSQL` RDBMS. Run the following command to install the right version:
+
+    pip install -r install/requirements.postgresql.txt
+
+#### Allowing local connections on PostgreSQL ####
+
+Debian `PostgreSQL` stores connections authorization in `/etc/postgresql/9.1/main/pg_hba.conf`. Edit this file and check that connection from `127.0.0.1` are allowed using user/password. You should find the following line in the file:
+
+    # IPv4 local connections:
+    host    all             all             127.0.0.1/32            md5
+
+If you changed the file, reload `PostgreSQL`:
+
+    service postgresql reload
+
+#### Creating a user and associated database ####
+
+You need a database and associated user/password. Tracim comes with `pgtool`, tool that will make this step easy:
+
+    ./bin/pgtool help
+
+Run the following self explanatory commands:
+
+    sudo su postgres
+    ./bin/pgtool create_user tracimuser tracimpassword
+    ./bin/pgtool create_database tracimdb
+    ./bin/pgtool grant_all_privileges tracimdb tracimuser
+    exit
+
+#### Test the database access ####
+
+So, now you have a database and an associated user/password. A good habit is to test things before to use them, that's why we want to test the database access. This is easily done with Tracim `pgtool`:
+
+    ./bin/pgtool test_connection tracimdb tracimuser tracimpassword 127.0.0.1
+
+The result is similar to the following :
+
+    PG # CONNECT TO DATABASE
+    ------------------------
+    server:     127.0.0.1
+    database:   tracimdb
+    username:   bibi
+
+                  now
+    -------------------------------
+     2014-11-10 09:40:23.306199+01
+    (1 row)
+
+In case of failure, you would get something like this:
+
+    PG # CONNECT TO DATABASE
+    ------------------------
+    server:     127.0.0.1
+    database:   tracimdb
+    username:   bibi
+
+    psql: FATAL:  password authentication failed for user "bibi"
+    FATAL:  password authentication failed for user "bibi"
+    ERRROR
+
+In this case, delete the user and database you previously created, using `pgtool`, and do it again. Do not forget to run the `grant_all_rights` command!
+
+## MySQL ##
+
+Or if you want to use `MySQL` as database engine
+
+    sudo apt install mysql-server
+
+### Minimalist introduction to MySQL ###
+
+#### Driver ####
+
+Tracim uses the `PyMySQL` driver between the `SQLAlchemy` ORM and the `MySQL` RDBMS. Run the following command to install the right version:
+
+    pip install -r install/requirements.mysql.txt
+
+#### Create database ####
+
+Connect to `MySQL` with root user (password has been set at "Installation" -> "Dependencies" chapter, when installing package)
+
+    mysql -u root -p
+
+Create a database with following command:
+
+    CREATE DATABASE tracimdb;
+
+Create a user with following command:
+
+    CREATE USER 'tracimuser'@'localhost' IDENTIFIED BY 'tracimpassword';
+
+And allow him to manipulate created database with following command:
+
+    GRANT ALL PRIVILEGES ON tracimdb . * TO 'tracimuser'@'localhost';
+
+Then flush privileges:
+
+    FLUSH PRIVILEGES;
+
+You can now quit `MySQL` prompt:
+
+    \q
+
+## SQLAlchemy settings ##
+
+In the file `tracim/development.ini`, search the lines corresponding to the `SQLAlchemy` database url parameter `sqlalchemy.url`. `SQLite` is the default active database and others should be commented.
+
+If you're willing to choose `PostgreSQL` or `MySQL`, comment the `sqlalchemy.url` line corresponding to `SQLite` and uncomment the one of your choice.
+
+For example with `PostgreSQL`, this should gives you:
+
+    sqlalchemy.url = postgresql://tracimuser:tracimpassword@127.0.0.1:5432/tracimdb?client_encoding=utf8
+    # sqlalchemy.url = mysql+pymysql://tracimuser:tracimpassword@127.0.0.1/tracimdb
+    # sqlalchemy.url = sqlite:///tracimdb.sqlite
+
+Proceed as above for the file `tracim/tests.ini`, except that you need to reproduce these steps three times for each of the following entries:
+
+- [app:main]
+- [app:ldap]
+- [app:radicale]
+
+Again with `PostgreSQL`, this should gives you:
+
+    sqlalchemy.url = postgresql://tracimuser:tracimpassword@127.0.0.1:5432/tracimdb_test?client_encoding=utf8
+    # sqlalchemy.url = mysql+pymysql://tracimuser:tracimpassword@127.0.0.1/tracimdb_test
+    # sqlalchemy.url = sqlite:///tracimdb_test.sqlite
+
+*Note: Do not copy the lines from the file `tracim/development.ini` to the file `tracim/tests.ini`, the database names aren't the same.*

doc/setting.md

+# Setting #
+
+Here is a short description of settings available in the file `tracim/development.ini`.
+
+## Listening port ##
+
+Default configuration is to listen on port 8080. If you want to adapt this to your environment, edit the `.ini` file and setup the port you want:
+
+    port = 8080
+
+## Interface language ##
+
+The default language is English. You can change it to French by uncommenting the following line in the `.ini` file:
+
+    lang = fr
+
+## SMTP parameters for resetpassword and notifications ##
+
+For technical reason, you have to configure `SMTP` parameters for rest password process and `SMTP` parameters for notifications in separate places.
+
+The reset password related parameters are the following ones :
+
+    resetpassword.email_sender = tracim@mycompany.com
+    resetpassword.smtp_host = smtp.mycompany.com
+    resetpassword.smtp_port = 25
+    resetpassword.smtp_login = username
+    resetpassword.smtp_passwd = password
+
+The main parameters for notifications are the following ones:
+
+    email.notification.activated = true
+    email.notification.from.email = noreply@trac.im
+    email.notification.from.default_label = Tracim Notification
+    email.notification.smtp.server = smtp.mycompany.com
+    email.notification.smtp.port = 25
+    email.notification.smtp.user = username
+    email.notification.smtp.password = password
+
+## Website ##
+
+You must define general parameters like the `base_url` and the website title which are required for home page and email notification links
+
+    website.title = My Company Intranet
+    website.base_url = http://intranet.mycompany.com:8080
+
+## LDAP ##
+
+To use LDAP authentication, set `auth_type` parameter to `ldap`:
+
+    auth_type = ldap
+
+Then add LDAP parameters
+
+    # LDAP server address
+    ldap_url = ldap://localhost:389
+
+    # Base dn to make queries
+    ldap_base_dn = dc=directory,dc=fsf,dc=org
+
+    # Bind dn to identify the search
+    ldap_bind_dn = cn=admin,dc=directory,dc=fsf,dc=org
+
+    # The bind password
+    ldap_bind_pass = toor
+
+    # Attribute name of user record who contain user login (email)
+    ldap_ldap_naming_attribute = uid
+
+    # Matching between ldap attribute and ldap user field (ldap_attr1=user_field1,ldap_attr2=user_field2,...)
+    ldap_user_attributes = mail=email
+
+    # TLS usage to communicate with your LDAP server
+    ldap_tls = False
+
+    # If True, LDAP own tracim group managment (not available for now!)
+    ldap_group_enabled = False
+
+You may need an administrator account to manage Tracim. Use the following command (from ``/install/dir/of/tracim/tracim``):
+
+    gearbox user create -l admin@admin.admin -p admin@admin.admin -g managers -g administrators
+
+Keep in mind `admin-email@domain.com` must match with LDAP user.
+
+## Other parameters  ##
+
+There are other parameters which may be of interest to you. For example, you can:
+
+* include a JS tracker like Piwik or Google Analytics,
+* define your own notification email subject
+* personalize notification email
+* personalize home page (background image, title color...)
+* ...

install/requirements.mysql.txt

+PyMySQL==0.7.11

install/requirements.postgresql.txt

+psycopg2==2.5.4

install/requirements.txt

 alembic==0.8.4
 argparse==1.2.1
 backlash==0.0.7
-beautifulsoup4==4.3.2
+beautifulsoup4==4.4.0
 caldav==0.4.0
 cliff==1.8.0
-cmd2==0.6.7
-coverage==4.0b1
+cmd2==0.6.9
+coverage==4.4.1
 crank==0.7.3
 decorator==3.4.0
 gearbox==0.0.7
 nose==1.3.4
 pbr==0.10.0
 prettytable==0.7.2
-psycopg2==2.5.4
 py4j==0.10.1
 pyasn1==0.1.9
 pyparsing==2.0.3
 python-editor==1.0.1
 python-ldap-test==0.2.1
 repoze.lru==0.6
-repoze.who==2.2
+repoze.who==2.3
 requests==2.10.0
 six==1.8.0
 speaklater==1.3
 unicode-slugify==0.1.3
 vobject==0.9.2
 waitress==0.8.9
-who-ldap==3.1.0
+who_ldap==3.2.2
 -e git+https://github.com/algoo/wsgidav.git@py3#egg=wsgidav
 zope.interface==4.1.3
 zope.sqlalchemy==0.7.6

package.json

   "description": "",
   "main": "",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "gulp-dev": "gulp dev",
+    "gulp-prod": "gulp prod"
   },
   "repository": {
     "type": "git",

tracim/README.txt

-This file is for you to describe the pod application. Typically
-you would include information such as the information below:
-
-Installation and Setup
-======================
-
-Install ``pod`` using the setup.py script::
-
-    $ cd pod
-    $ python setup.py develop
-
-Create the project database for any model classes defined::
-
-    $ gearbox setup-app
-
-Start the paste http server::
-
-    $ gearbox serve
-
-While developing you may want the server to reload after changes in package files (or its dependencies) are saved. This can be achieved easily by adding the --reload option::
-
-    $ gearbox serve --reload --debug
-
-Then you are ready to go.

tracim/development.ini.base

 # invalidate the URI when specifying a SQLite db via path name
 # sqlalchemy.url=postgresql://username:password@hostname:port/databasename
 # sqlalchemy.url=mysql://username:password@hostname:port/databasename
-# sqlalchemy.url = postgresql://tracim_user:tracim_user_password@127.0.0.1:5432/tracim?client_encoding=utf8
-sqlalchemy.url = <replace_database_uri_here>
+# sqlalchemy.url = postgresql://tracimuser:tracimpassword@127.0.0.1:5432/tracimdb?client_encoding=utf8
+# sqlalchemy.url = mysql+pymysql://tracimuser:tracimpassword@127.0.0.1/tracimdb
+sqlalchemy.url = sqlite:///tracimdb.sqlite
 
 #echo shouldn't be used together with the logging module.
 sqlalchemy.echo = false

tracim/setup.py

     use_setuptools()
     from setuptools import setup, find_packages
 
+classifiers = [
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.4",
+    "Programming Language :: Python :: 3.5",
+    "Programming Language :: Python :: 3.6",
+]
+
 testpkgs=['WebTest >= 1.2.3',
                'nose',
                'coverage',
     "sqlalchemy",
     "alembic",
     "repoze.who",
-    "who-ldap==3.1.0",
+    "who_ldap>=3.2.1",
     "python-ldap-test==0.2.1",
     "unicode-slugify==0.1.3",
     "pytz==2014.7",

tracim/test.ini

 port = 8080
 
 [app:main]
-sqlalchemy.url =  postgresql://postgres:dummy@127.0.0.1:5432/tracim_test?client_encoding=utf8
+# sqlalchemy.url = postgresql://tracimuser:tracimpassword@127.0.0.1:5432/tracimdb_test?client_encoding=utf8
+# sqlalchemy.url = mysql+pymysql://tracimuser:tracimpassword@127.0.0.1/tracimdb_test
+sqlalchemy.url = sqlite:///tracimdb_test.sqlite
 use = config:development.ini
 
 [app:main_without_authn]
 skip_authentication = True
 
 [app:ldap]
-sqlalchemy.url =  postgresql://postgres:dummy@127.0.0.1:5432/tracim_test?client_encoding=utf8
+# sqlalchemy.url = postgresql://tracimuser:tracimpassword@127.0.0.1:5432/tracimdb_test?client_encoding=utf8
+# sqlalchemy.url = mysql+pymysql://tracimuser:tracimpassword@127.0.0.1/tracimdb_test
+sqlalchemy.url = sqlite:///tracimdb_test.sqlite
 auth_type = ldap
 ldap_url = ldap://localhost:3333
 ldap_base_dn = dc=directory,dc=fsf,dc=org
 use = config:development.ini
 
 [app:radicale]
-sqlalchemy.url =  postgresql://postgres:dummy@127.0.0.1:5432/tracim_test?client_encoding=utf8
+# sqlalchemy.url = postgresql://tracimuser:tracimpassword@127.0.0.1:5432/tracimdb_test?client_encoding=utf8
+# sqlalchemy.url = mysql+pymysql://tracimuser:tracimpassword@127.0.0.1/tracimdb_test
+sqlalchemy.url = sqlite:///tracimdb_test.sqlite
 
 use = config:development.ini