Update doc and README

diff --git a/README.rst b/README.rst
index 3c8c962e7823eab7318a48bf2ecc70629253aa65..498976f97f251264e704616be8ba29a4814c7e90 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,6 +1,6 @@
-============================================================
-Telemeta : collaborative multimedia asset management system
-============================================================
+=====================================================================
+Telemeta : collaborative media asset management system for musicology
+=====================================================================
 
 .. image:: https://raw.githubusercontent.com/Parisson/Telemeta/master/telemeta/static/telemeta/images/logo_telemeta_2.png
     :alt: Telemeta logo
@@ -143,18 +143,17 @@ http://demo.telemeta.org
  * password: admin
 
 
-Install
-=======
+Get it
+======
 
 Thanks to Docker, Telemeta is now fully available as a docker composition ready to work. The docker based composition bundles some powerfull applications and modern frameworks out-of-the-box like: Python, Conda, Numpy, Jupyter, Gstreamer, Django, Celery, Haystack, ElasticSearch, MySQL, Redis, uWSGI, Nginx and many more.
 
-First, install `Docker <https://store.docker.com/search?offering=community&q=&type=edition>`_ and `docker-compose <https://docs.docker.com/compose/>`_
+First, install Git, `Docker <https://store.docker.com/search?offering=community&q=&type=edition>`_ and `docker-compose <https://docs.docker.com/compose/>`_
 
 Then clone Telemeta::
 
     git clone --recursive https://github.com/Parisson/Telemeta.git
     cd Telemeta
-    docker-compose build
 
 
 Start it up
@@ -177,16 +176,26 @@ Be **CAREFULL** in production:
 * Use a cron rule and the backup script to save your work periodically
 
 
+Daemonize
+=========
+
+**Linux only**
+
+On a production server, Telemeta can be automatically started as a daemon so that it is started during booting. Just execute the install script::
+
+  sudo ./install.py
+
+
 Backup / Restore
 ================
 
 To backup the database in the data/backup/ folder, run this in **another** terminal (or a Docker Quickstart Terminal)::
 
-    docker-compose run db /srv/scripts/sql/backup_db.sh
+    docker-compose run db /srv/bin/sql/backup_db.sh
 
 To restore the last backuped database from the data/backup/ folder, run this in **another** terminal (or a Docker Quickstart Terminal)::
 
-    docker-compose run db /srv/scripts/sql/restore_db.sh
+    docker-compose run db /srv/bin/sql/restore_db.sh
 
 If the app is broken after a restore script, restart the composition with::
 

diff --git a/doc/content/README.rst b/doc/content/README.rst
index 4e346fb66743090356a013f042bd81bb99dbd016..498976f97f251264e704616be8ba29a4814c7e90 100644 (file)
--- a/doc/content/README.rst
+++ b/doc/content/README.rst
@@ -1,9 +1,6 @@
-============================================================
-Telemeta : collaborative multimedia asset management system
-============================================================
-
-:category: About
-:Pin: true
+=====================================================================
+Telemeta : collaborative media asset management system for musicology
+=====================================================================
 
 .. image:: https://raw.githubusercontent.com/Parisson/Telemeta/master/telemeta/static/telemeta/images/logo_telemeta_2.png
     :alt: Telemeta logo
@@ -40,24 +37,6 @@ It is mostly written in Python, HTML5 and JavaScript.
 
 The *Telemeta* name stands for *Tele* as "remote access" and *meta* for "metadata".
 
-|version| |downloads| |travis_master| |coverage_master|
-
-.. |version| image:: https://img.shields.io/pypi/v/telemeta.svg
-   :target: https://pypi.python.org/pypi/Telemeta/
-   :alt: Version
-
-.. |downloads| image:: https://img.shields.io/pypi/dm/telemeta.svg
-   :target: https://pypi.python.org/pypi/Telemeta/
-   :alt: Downloads
-
-.. |travis_master| image:: https://secure.travis-ci.org/Parisson/Telemeta.png?branch=master
-   :target: https://travis-ci.org/Parisson/Telemeta/
-   :alt: Travis
-
-.. |coverage_master| image:: https://coveralls.io/repos/Parisson/Telemeta/badge.png?branch=master
-   :target: https://coveralls.io/r/Parisson/Telemeta?branch=master
-   :alt: Coverage
-
 
 Funding and support
 ===================
@@ -74,6 +53,46 @@ Thank you so much for your help!
 News
 =====
 
+1.7.0
++++++
+
+* Based on TimeSide 0.9
+* Use Django 1.8
+* Rename some directories
+* Better video streaming
+* Better logging
+
+UPGRADING::
+
+  git pull origin master
+  git submodule update --init --remote
+  docker-compose run app /srv/app/bin/upgrade_from_1.6_to_1.7.sh
+
+WARNING:
+
+`scripts/` and `app/scripts/` directories has been renamed `bin/` and `app/bin/` respectively. So please adapt your management and maintenance personal script.
+
+1.6.5 > 1.6.7
++++++++++++++
+
+ * Setting utf8 database by default
+ * Deactivate video.js for now
+ * Use mysql:5
+ * Fix phpmyadmin config
+ * Various bugfixes
+
+1.6.4
++++++
+
+   * Minor bug fixes and improvments
+   * Fix HTML5 audio compatibility (#173) for the web audio player. The SoundManager Flash player fallback should not be used in most modern web browser. Media files are now serves through Nginx (#155) which enables to stream music with byte range requests.
+   * Add a User permission "can_run_analysis" to specify that a user or a group of users has the right to list and select advanced Timeside analysis to be displayed in the Timeside web audio player.
+   * Add enumeration management and statitics
+   * Improved media security allowing streaming through Nginx only from the application
+   * Add TimeSide as a submodule
+   * Add a validator for Corpus and Fonds
+   * Upgrade various dependencies
+
 1.6
 ++++
 
@@ -124,14 +143,12 @@ http://demo.telemeta.org
  * password: admin
 
 
-Install
-=======
+Get it
+======
 
 Thanks to Docker, Telemeta is now fully available as a docker composition ready to work. The docker based composition bundles some powerfull applications and modern frameworks out-of-the-box like: Python, Conda, Numpy, Jupyter, Gstreamer, Django, Celery, Haystack, ElasticSearch, MySQL, Redis, uWSGI, Nginx and many more.
 
-On Linux, first install `Git <http://git-scm.com/downloads>`_, `Docker engine <https://docs.docker.com/installation/>`_ and `docker-compose <https://docs.docker.com/compose/install/>`_ and open a terminal.
-
-On MacOSX or Windows install the `Docker Toolbox <https://www.docker.com/products/docker-toolbox>`_ and open a Docker Quickstart Terminal.
+First, install Git, `Docker <https://store.docker.com/search?offering=community&q=&type=edition>`_ and `docker-compose <https://docs.docker.com/compose/>`_
 
 Then clone Telemeta::
 
@@ -142,9 +159,9 @@ Then clone Telemeta::
 Start it up
 ===========
 
-For a production environment setup::
+For a production environment setup, first read / edit `env/prod.env`, then::
 
-     docker-compose up
+    docker-compose up
 
 Then browse the app at http://localhost:8000/ (replacing 'localhost' by the IP given by the docker terminal on OSX or Windows)
 
@@ -159,16 +176,26 @@ Be **CAREFULL** in production:
 * Use a cron rule and the backup script to save your work periodically
 
 
+Daemonize
+=========
+
+**Linux only**
+
+On a production server, Telemeta can be automatically started as a daemon so that it is started during booting. Just execute the install script::
+
+  sudo ./install.py
+
+
 Backup / Restore
 ================
 
 To backup the database in the data/backup/ folder, run this in **another** terminal (or a Docker Quickstart Terminal)::
 
-    docker-compose run db /srv/scripts/sql/backup_db.sh
+    docker-compose run db /srv/bin/sql/backup_db.sh
 
 To restore the last backuped database from the data/backup/ folder, run this in **another** terminal (or a Docker Quickstart Terminal)::
 
-    docker-compose run db /srv/scripts/sql/restore_db.sh
+    docker-compose run db /srv/bin/sql/restore_db.sh
 
 If the app is broken after a restore script, restart the composition with::
 
@@ -188,31 +215,16 @@ API / Documentation
 Development
 ===========
 
-|travis_dev| |coverage_dev|
-
-.. |travis_dev| image:: https://secure.travis-ci.org/Parisson/Telemeta.png?branch=dev
-   :target: https://travis-ci.org/Parisson/Telemeta/
-   :alt: Travis
-
-.. |coverage_dev| image:: https://coveralls.io/repos/Parisson/Telemeta/badge.png?branch=dev
-   :target: https://coveralls.io/r/Parisson/Telemeta?branch=dev
-   :alt: Coverage
-
-
-To start the application in a development environment setup::
+To start the application in a development environment setup, first read / edit `env/debug.env`, then::
 
     cd Telemeta
     git pull
     git checkout dev
     docker-compose -f docker-compose.yml -f env/dev.yml up
 
-Then browse the app at http://localhost:9000/ (replacing 'localhost' by the IP given by the docker terminal on OSX or Windows). Note the service will automatically when code is modified.
-
-To build your own composition (if dependency tree is changed)::
-
-    docker-compose -f docker-compose.yml -f env/dev.yml -f env/build.yml build
+Then browse the app at http://localhost:9100/ (replacing 'localhost' by the IP given by the docker terminal on OSX or Windows). Note that the service will automatically be reloaded when any code of the app is modified.
 
-You are welcome to participate to the development by forking the Telemeta project on GitHub_.
+You are welcome to participate to the development by forking the Telemeta project on GitHub_, using it as if it were the original and submitting your changes through a Pull Request on the **dev branch ONLY**.
 
 
 Bugs, issues, ideas

diff --git a/doc/content/TM-1.6.4.rst b/doc/content/TM-1.6.4.rst
index b8850958dd37b123d52547419d2f8555858e3273..d723bb6c17d0f9c8d6ac17157f9bb6221192385e 100644 (file)
--- a/doc/content/TM-1.6.4.rst
+++ b/doc/content/TM-1.6.4.rst
@@ -3,7 +3,7 @@ Telemeta 1.6.4 is out!
 
 :category: Releases
 
-ChangeLig:
+ChangeLog:
 
    * Minor bug fixes and improvments
    * Fix HTML5 audio compatibility (#173) for the web audio player. The SoundManager Flash player fallback should not be used in most modern web browser. Media files are now serves through Nginx (#155) which enables to stream music with byte range requests.