@@ -45,56 +45,47 @@ The following software is required to run this application.
4545
4646* Webserver (Nginx, Apache, ...)
4747* MySQL Server
48- * PHP >= 7.1
48+ * PHP >= 7.3
4949 * [ ZeroMQ Extension] ( http://zeromq.org/bindings:php )
5050 * [ Gearman Extension] ( http://gearman.org/download/#php )
5151 * Curl extension
5252 * Mysqli extension
5353
5454### Installation procedure
5555
56- * Install project using composer.
56+ 1 . Install project using composer.
5757
58- ``` composer create-project nekudo/shiny_deploy myshinydeploy ```
58+ ``` composer create-project nekudo/shiny_deploy myshinydeploy ```
5959
60- * Create MySQL tables using db_structure.sql in project root.
60+ 2 . Adjust config files in the following folders:
6161
62- * Adjust config files in the following folders:
62+ ``` config/config.php ```
6363
64- ``` config/ config.php ```
64+ ``` www/js/ config.js ```
6565
66- ``` www/js/config.js ```
66+ 3 . Run the installation script using the following command:
6767
68- ### Start application
68+ ``` php cli/app.php install ```
69+
70+ 4 . Point your virtual host document root to the ` www ` directory and rewrite requests to the index.php file.
6971
70- To use this application you need to start up the websocket server and worker processes. This can be done by executing
72+ 5 . To use this application you need to start up the websocket server and worker processes. This can be done by executing
7173the following command:
7274
73- ``` php cli/app.php start ```
75+ ```php cli/app.php start```
7476
75- ## Updates
77+ ### Update procedure
7678
77- #### Updating to 1.3 or higher
79+ To update an existing instance of ShinyDeploy the first step is to update the files. You can either use a simple
80+ ` git pull ` to do this (in case you installed the application trough composer) or just override all the files with
81+ a fresh copy downloaded from the project website.
7882
79- If you want to update to version 1.3.0 or higher you have to convert the encrypted database when you come from a
80- version that is 1.1 or lower. (See the update guide below.)
83+ Once the files are update you need to execution the update command which will execute all necessary migrations:
8184
82- Please note that is process is only possible running PHP 7.1 with the mcrypt extension installed. Once your data
83- is converted you can update to the latest PHP version and the mcrypt extension is not required any longer.
85+ ` php cli/app.php update `
8486
85- #### Updating to 1.2.*
86-
87- Due to the fact that the mcrypt extension was removed in PHP 7.2 the cryptography routines within this application
88- needed to be updated. So after updating to version 1.2 (or later) you will need to execute the update script by running
89- the following command:
90-
91- ` php cli/scripts/update.php `
92-
93- The updater will ask for your system password and than re-encrypt all data to the new standard. This step has to be done
94- running PHP 7.1.* with the mcrypt extension installed.
95-
96- Unfortunately you will have to ** generate new api/webhook URLs after this step** . (The old URLs won't work any longer
97- after the update.)
87+ Hint: Please have a look into the release notes before update you installation of ShinyDeploy to prevent any
88+ problems.
9889
9990## Developer Hints
10091
0 commit comments