Skip to content
This repository has been archived by the owner on Sep 10, 2018. It is now read-only.

Commit

Permalink
Upgrade guide for 1.0.0-beta release
Browse files Browse the repository at this point in the history
  • Loading branch information
@lGuillaume124
lGuillaume124 committed Dec 5, 2015
1 parent 5ee6da0 commit 93dffd5
Show file tree
Hide file tree
Showing 10 changed files with 122 additions and 32 deletions.
3 changes: 2 additions & 1 deletion en/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Contents:
requirements
installation
configuration
upgrade
annexes

The project's roadmap is available here: `roadmap.sonerezh.bzh <http://roadmap.sonerezh.bzh/b/eCuz4jyhwjmxpxX8C/sonerezh-roadmap>`_
The project's roadmap is available here: `roadmap.sonerezh.bzh <https://roadmap.sonerezh.bzh/b/eCuz4jyhwjmxpxX8C/sonerezh-roadmap>`_

21 changes: 11 additions & 10 deletions en/installation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,26 +10,25 @@ Installation on a dedicated server

As Sonerezh does not have auto-updater yet, we recommend you to use Git to download the sources, it will facilitate the update process.

.. note:: We are installing Sonerezh in ``/var/www/sonerezh``, and deploying it to http://demo.sonerezh.bzh.

But if you prefer, you can also download a ZIP archive on GitHub.
.. note:: We will install Sonerezh in ``/var/www/sonerezh``, and make it reachable to http://demo.sonerezh.bzh.

Install Sonerezh with Git:

.. code-block:: sh
cd /var/www
sudo git clone --branch 1.0.0-beta https://github.com/Sonerezh/sonerezh.git
sudo git clone --branch master https://github.com/Sonerezh/sonerezh.git
sudo chown -R www-data: sonerezh/ && sudo chmod -R 775 sonerezh/
Install Sonerezh with the zip archive:
But if you prefer, you can also download a ZIP archive from GitHub.

.. code-block:: sh
cd /var/www
sudo wget https://github.com/Sonerezh/sonerezh/archive/1.0.0-beta.zip
sudo unzip master.zip
sudo chown -R www-data: sonerezh-master/ && sudo chmod -R 775 sonerezh-master/
sudo unzip 1.0.0-beta.zip
sudo mv sonerezh-1.0.0-beta sonerezh
sudo chown -R www-data: sonerezh && sudo chmod -R 775 sonerezh
^^^^^^^^^^^^^^^^^^^^^^^^
Preparing the web server
Expand All @@ -50,8 +49,8 @@ Installation on shared hosting
The installation process on shared hosting is almost the same than on dedicated server.

1) Prepare your database, depending on your hosting provider
2) Download Sonerezh on `GitHub`
3) Upload and decompress the archive on your FTP, for example in ``sonerezh/``
2) Download Sonerezh from GitHub_
3) Upload and decompress the archive on your distant hosting, for example in ``sonerezh/``
4) Go to the installation page (for example http://demo.sonerezh.bzh/install)
5) Fill in the form
6) Enjoy your music :)
Expand All @@ -71,7 +70,7 @@ As mentioned above, it is recommended to use Git to download the sources (instal
.. code-block:: sh
cd /var/www/html/
sudo git clone --branch 1.0.0-beta http://github.com/Sonerezh/sonerezh.git
sudo git clone --branch master http://github.com/Sonerezh/sonerezh.git
sudo chown -R www-data: sonerezh/ && sudo chmod -R 775 sonerezh/
^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -137,3 +136,5 @@ Save the file, enable the new virtual host and restart your web server:
Configure Sonerezh
^^^^^^^^^^^^^^^^^^
In your browser, go to http://www.myserver.com/sonerezh and fill in the form with your parameters. Enjoy your music!

.. _GitHub: https://github.com/Sonerezh/sonerezh/archive/1.0.0-beta.zip
1 change: 1 addition & 0 deletions en/introduction.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ Features
* User access management with two access levels
* Playlist management
* Automatic conversion to MP3
* Work on MySQL and PostgreSQL
* And more to come
9 changes: 5 additions & 4 deletions en/requirements.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,16 @@ Web server

Sonerezh is a web-based application which works with your browser. You need a web server to deploy it (Apache, Nginx...). You can find configuration samples for Apache and Nginx in the appendices, but we will not cover the web server installation.

.. note:: You need to enable the ``mod_rewrite`` module if you want to run Sonerezh with Apache. To enable it on Debian an derivative: ``sudo a2enmod rewrite && sudo service apache2 restart``.
.. note:: You need to enable the ``mod_rewrite`` module if you want to run Sonerezh with Apache. For example on Debian: ``sudo a2enmod rewrite && sudo service apache2 restart``.

---------------
Database
---------------

Sonerezh requires a MySQL or MariaDB database to sort your music. The database must be created and ready before the deployment.
Sonerezh requires a database to store its datas. We recommend MariaDB but it should work on MySQL and PostgreSQL.
The database must be created and ready before the deployment.

1) Connect to the MySQL prompt:
1) Connect to the MariaDB/MySQL prompt:

.. code-block:: sh
Expand All @@ -42,7 +43,7 @@ Sonerezh is cooked with CakePHP, and you need PHP to be installed.

Ensure the required PHP extensions are enabled in your php.ini:

.. code-block:: text
.. code-block:: ini
extension=exif.so
extension=gd.so
Expand Down
42 changes: 42 additions & 0 deletions en/upgrade.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
=======
Upgrade
=======

Sonerezh does not provide automatic upgrades for the moment. We need to do it manually.

------------------
Upgrade from 0.9.0
------------------

.. warning:: Unfortunately it is not possible to upgrade Sonerezh from 0.9.0 to a more recent version. We have made too many deep changes between 0.9.0 and 1.0.0-beta and you need to install Sonerezh from scratch if you come from 0.9.0.

------------------------------------------------
Upgrade from old 1.0.0-beta branch to 1.0.0-beta
------------------------------------------------

.. note:: You can use this section if you upgrade from the old 1.0.0-beta branch (it means before 12/01/2015)

^^^^^^^^
With git
^^^^^^^^
Get the last version from GitHub:

.. code-block:: sh
cd /var/www/sonerezh
git fetch
git checkout tags/1.0.0-beta
The dabatase schema has changed, you have to update it (php-cli required):

.. code-block:: sh
# Follow the instructions given by the command
app/Console/cake schema update sonerezh
You instance has been upgraded! You can check verify it under the statistics, on the settings page. Do not forget to empty you browser cache and delete the Sonerezh cookies.

^^^^^^^^^^^
Without git
^^^^^^^^^^^
You cannot upgrade Sonerezh if you do not use git. You have to install the new version from scratch.
5 changes: 3 additions & 2 deletions fr/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Bienvenue sur la documentation de Sonerezh !
============================================

.. note:: English translation available here: https://www.sonerezh.bzh/docs/en/
.. note:: English version available here: https://www.sonerezh.bzh/docs/en/

Contents:

Expand All @@ -18,7 +18,8 @@ Contents:
requirements
installation
configuration
upgrade
annexes

La roadmap du projet est disponible à cette adresse : `roadmap.sonerezh.bzh <http://roadmap.sonerezh.bzh/b/eCuz4jyhwjmxpxX8C/sonerezh-roadmap>`_
La roadmap du projet est disponible à cette adresse : `roadmap.sonerezh.bzh <https://roadmap.sonerezh.bzh/b/eCuz4jyhwjmxpxX8C/sonerezh-roadmap>`_

21 changes: 10 additions & 11 deletions fr/installation.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,23 @@ Nous vous recommandons d'utiliser ``git`` pour récupérer les sources du projet

.. note:: Nous allons installer sonerezh dans ``/var/www/sonerezh``, pour pouvoir y accéder à l'adresse http://demo.sonerezh.bzh.

Vous pouvez utiliser Git ou bien récupérer une archive au format ZIP sur le dépôt GitHub de Sonerezh.

Installation avec Git :

.. code-block:: sh
cd /var/www
sudo git clone --branch 1.0.0-beta https://github.com/Sonerezh/sonerezh.git
sudo git clone --branch master https://github.com/Sonerezh/sonerezh.git
sudo chown -R www-data: sonerezh/ && sudo chmod -R 775 sonerezh/
Installation sans Git :
Si vous préférez télécharger une archive Zip depuis GitHub:
.. code-block:: sh
cd /var/www
sudo wget https://github.com/Sonerezh/sonerezh/archive/1.0.0-beta.zip
sudo unzip master.zip
sudo chown -R www-data: sonerezh-master/ && sudo chmod -R 775 sonerezh-master/
sudo unzip 1.0.0-beta.zip
sudo mv sonerezh-1.0.0-beta sonerezh
sudo chown -R www-data: sonerezh && sudo chmod -R 775 sonerezh
^^^^^^^^^^^^^^^^^^^^^^^^^^
Préparation du serveur web
Expand Down Expand Up @@ -70,7 +69,7 @@ Les hébergements de type mutualisés ne vous permettent pas un accès complet.
* Email : l'adresse email utilisée pour vous connecter, ce premier compte sera créé avec le niveau d'accès administrateur
* Mot de passe : mot de passe de l'administrateur
* Dossier musique : le dossier dans lequel se trouve votre musique
* Hôte : le nom d'hôte de la base de données pour Sonerezh
* Hôte : le nom d'hôte de la base de données pour Sonerezh (ajoutez :1234 si vous utilisez un port non standard)
* Base de données : le nom de la base de données
* Identifiant : l'identifiant de l'utilisateur MySQL ou MariaDB
* Mot de passe : le mot de passe de l'utilisateur MySQL ou MariaDB
Expand All @@ -93,7 +92,7 @@ Comme indiqué ci-dessus, nous utilisons Git pour récupérer les sources du pro
.. code-block:: sh
cd /var/www/html
sudo git clone --branch 1.0.0-beta https://github.com/Sonerezh/sonerezh.git
sudo git clone --branch master https://github.com/Sonerezh/sonerezh.git
sudo chown -R www-data: sonerezh/ && sudo chmod -R 775 sonerezh/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -136,7 +135,7 @@ Et y ajouter le Virtual Host suivant :
.. code-block:: apache
<VirtualHost *:80>
ServerName www.myserver.com
ServerName www.monserveur.com
DocumentRoot /var/www/html/sonerezh
<Directory /var/www/html/sonerezh>
Expand All @@ -147,8 +146,8 @@ Et y ajouter le Virtual Host suivant :
</IfModule>
</Directory>
CustomLog /var/log/apache2/www.myserver.com-access.log "Combined"
ErrorLog /var/log/apache2/www.myserver.com-error.log
CustomLog /var/log/apache2/www.monserveur.com-access.log "Combined"
ErrorLog /var/log/apache2/www.monserveur.com-error.log
</VirtualHost>
Enregistrer le fichier, activer le nouveau site et redémarrer Apache :
Expand Down
1 change: 1 addition & 0 deletions fr/introduction.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,5 @@ Actuellement, Sonerezh propose les fonctionnalités suivantes :
* Gestion des utilisateurs selon deux niveaux d'accès
* Conversion des pistes au format MP3
* Gestionnaire de listes de lectures
* Compatible MySQL et PostgreSQL
* Et plus encore à venir !
9 changes: 5 additions & 4 deletions fr/requirements.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ Sonerezh est une application web accessible avec votre navigateur. Elle a donc b
Base de données
---------------

Sonerezh s'appuie sur une base de données MySQL ou MariaDB pour fonctionner. La base de données doit être créée avant de lancer l'installation.
Sonerezh s'appuie sur une base de données pour stocker ses données. Celle-ci peut être gérée par MariaDB, MySQL ou PostgreSQL mais nous recommandons MariaDB/MySQL.
Elle doit être créée avant de lancer l'installation.

1) Connectez-vous à votre gestionnaire de base de données :
1) Connectez-vous au gestionnaire de base de données :

.. code-block:: sh
Expand All @@ -40,9 +41,9 @@ Sonerezh fonctionne avec le framework PHP CakePHP, PHP est donc indispensable.
* PHP 5.4 ou supérieur
* Le module PHP GD

Veuillez vérifier que les extensions PHP requises sont bien activées dans votre php.ini:
Vérifiez que les extensions PHP requises sont bien activées dans votre php.ini:

.. code-block:: text
.. code-block:: ini
extension=exif.so
extension=gd.so
Expand Down
42 changes: 42 additions & 0 deletions fr/upgrade.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
===========
Mise à jour
===========

Sonerezh ne propose pas encore de mise à jour automatique. Il faut donc le faire à la main.

------------------------
Mise à jour depuis 0.9.0
------------------------

.. warning:: Malheureusement il n'est pas possible de mettre à jour Sonerezh depuis la version 0.9.0 vers un version supérieure. Ceci est dû aux nombreux changements importants réalisés entre la version 0.9.0 et la version 1.0.0-beta. Il faut repartir de zéro afin d'avoir une installation propre.

----------------------------------------------------------------
Mise à jour depuis l'ancienne branche 1.0.0-beta vers 1.0.0-beta
----------------------------------------------------------------

.. note:: Cette section est valable si vous mettez à jour depuis l'ancienne branche 1.0.0-beta (c'est-à-dire avant le 01/12/2015)

^^^^^^^^
Avec git
^^^^^^^^
Récupérez la dernière version des sources :

.. code-block:: sh
cd /var/www/sonerezh
git fetch
git checkout tags/1.0.0-beta
Le schéma de la base de données à changé, il faut donc le mettre à jour (requiert php-cli) :

.. code-block:: sh
# Suivez les instructions fournies par la commande
app/Console/cake schema update sonerezh
Votre instance est à jour ! Vous pouvez aller le vérifier sur la page des paramètres, sous les statistiques. Pensez aussi à vider le cache de votre navigateur, et supprimer les cookies de Sonerezh.

^^^^^^^^
Sans git
^^^^^^^^
Malheureusement il n'y a pas de processus de mise à jour si vous n'utilisez pas Git. Vous devez repartir sur une installation vierge.

0 comments on commit 93dffd5

Please sign in to comment.