FF-232 FF-233 Update Script (#9)

* basics of the stable update script

* cleaning

* added the latest update

* fixed error with digest check

* cleaning

* changes requested by @open-schnick, updated readme

* minor spelling fix.

* added more >/dev/null 2>&1

* Bumped Version to 1.5

Co-authored-by: open-schnick <[email protected]>

Author: qvalentin

Install.sh

@@ -28,7 +28,7 @@ if [ $? == 127 ]; then # command does not exist add it to path
     echo "$newPATH" >>"$rc"
     commandToRun="source $rc"
   else
-    echo "Couldn't add FileFighter Application to PATH. Please contact us at filefighter@t-online.de."
+    echo "Couldn't add FileFighter Application to PATH. Please contact us at dev@filefighter.de."
     echo "Or add following line to your PATH variable:"
     echo "$rootDir"
     exit 1

README.md

@@ -14,7 +14,7 @@ You need [Docker](https://www.docker.com/).
 Docker is a way to organise and run multiple applications. You can imagine it like a virtual machine (technical it`s a bit different), with a small file- and operating system within your machine.
 Sounds more scary than it actually is. Different Applications run in different containers, these only contain the necessary software to run the application.  
 The containers use the resources of the host machine, depending on the load.  
-Advantages are security and the possibility to easily shutdown and update the services. See more under [Usage](#Usage).
+Advantages are security and the possibility to easily shutdown and update the services. See more under ["Running FileFighter"](#Running FileFighter).
 
 #### Docker
 First check whether you have Docker already installed.  
@@ -26,7 +26,7 @@ If you see something like that (your version might be different):
 ```shell script
 Docker version 19.03.13, build 4484c46d9f
 ```
-You are good to go, and you can skip to [Usage](#Usage).
+You are good to go, and you can skip to ["Installing FileFighter"](#Installing FileFighter).
 
 To install **Docker** on Unix you can either use [snap](https://www.howtogeek.com/660193/how-to-work-with-snap-packages-on-linux/) or [apt](https://en.wikipedia.org/wiki/APT_(software)) as a package manager.  
 With snap its easier but of course it's not always possible to use snap.  
@@ -44,16 +44,16 @@ After successfully installing Docker you can start using FileFighter.
 Just download this repository as a zipfile [here](https://github.com/FileFighter/ClientSetup/releases/).  
 This repository contains the *Install.sh* installation script.  
  ```shell script
- dev@filefighter:~/Downloads/FileFighter-1.3 $ ls
+ dev@filefighter:~/Downloads/FileFighter-1.5 $ ls
  config.cfg  ffighter  Install.sh  lib  README.md
  ```  
 You can execute the script:
 ```shell script
-dev@filefighter:~/Downloads/FileFighter-1.3 $ ./Install.sh
+dev@filefighter:~/Downloads/FileFighter-1.5 $ ./Install.sh
 ```
 And you should see something like that:
 ```shell script
-dev@filefighter:~/Downloads/FileFighter-1.3 $ ./Install.sh 
+dev@filefighter:~/Downloads/FileFighter-1.5 $ ./Install.sh 
 Adding FileFighter Application to PATH...
 Adding FileFighter Application to PATH was successful.
 Please run the following command to finish the installation.
@@ -65,16 +65,16 @@ Running this command will add the FileFighter Application to your System.
 You can use the FileFighter Application with the command *ffighter*  
 Running this command should show you something like that:
 ```shell script
-dev@filefighter:~/Downloads/FileFighter-1.3 $ ffighter
+dev@filefighter:~/Downloads/FileFighter-1.5 $ ffighter
   _____   _   _          _____   _           _       _                 
  |  ___| (_) | |   ___  |  ___| (_)   __ _  | |__   | |_    ___   _ __ 
  | |_    | | | |  / _ \ | |_    | |  / _` | | '_ \  | __|  / _ \ | '__|
  |  _|   | | | | |  __/ |  _|   | | | (_| | | | | | | |_  |  __/ | |   
  |_|     |_| |_|  \___| |_|     |_|  \__, | |_| |_|  \__|  \___| |_|   
                                      |___/                             
-                   Version v1.3 Last updated: 08.11.20
+                   Version v1.5 Last updated: 21.12.20
               Developed by Gimleux, Valentin, Open-Schnick.            
-             Development Blog: https://filefighter.github.io           
+             Development Blog: https://blog.filefighter.de           
        The code can be found at: https://www.github.com/filefighter    
 
 -------------------------< Show Usage >---------------------------
@@ -86,6 +86,7 @@ usage: ffighter <args>
   start     - start the services.
   stop      - stop the services.
   remove    - remove all services.
+  update    - update all the services that have a new version available.
 ```
 You can see all the available options to run with *ffighter*.  
 
@@ -96,6 +97,7 @@ You can see all the available options to run with *ffighter*.
 | start | Start the services if already downloaded. |
 | stop | Stop the services if running. |
 | remove | Remove all services. |
+| update | Update all the services that have a new version available. |
 
 To start the Application just run:
 ```shell script
@@ -117,8 +119,7 @@ Valid keys to configure how FileFighter behaves are listed here:
 
 | Key      | Possible Values | Default | Description |
 | :----:   | :----:          |  :----: |  :----:  |
-| rest_port | 0-65535  | 8080 | The port of the restapi service that will be published for the frontend. |
-| frontend_port | 0-65535  | 80 | The port of the webapp (frontend) service. You can visit the FileFighter application over this port. |
+| app_port | 0-65535  | 80 | The port of the application. You can visit the FileFighter application over this port. |
 | db_user | any string | root | The name of the Database running in the background. |
 | db_password | any string | none (see below) | The password of the database. (The database won't be exposed to the internet, but passwords never hurt.) |
 | db_name | any string | filefighter | The name of the database. |
@@ -130,8 +131,34 @@ If the `db_password` key is empty, a random password will be generated.
 
 Be carefully as the developers of FileFighter won't take responsibility when you are using the application or configuration options wrong or in a not intended way.
 
+## Updating
+To update us the update command:
+
+```shell script
+ffighter update
+```
+This will check if new versions of the different services are available and will apply the updates.
+Depending on the configuration the update will either use the current stable version (recommended) or the newest latest version (experimental).
+
+In case you are using the latest versions you will also need to install [regclient](https://github.com/regclient/regclient/releases).
+Download the right version depending on your operating system and architecture, rename it to 'regctl', make it executable and move it to a folder that is in your path variable.
+
+### Auto update
+To achieve automatic updates you can set up a cron job as described in this [article](https://ostechnix.com/a-beginners-guide-to-cron-jobs/) with the update command.
+
+## Other operation systems (Windows)
+
+If you are not able to run the shell script for the installation you can still run FileFighter using [Docker Compose](https://docs.docker.com/compose/).
+Just download the [docker-compose.yml](https://raw.githubusercontent.com/FileFighter/ClientSetup/master/docker-compose.yml) file or clone this repo and execute this command in the folder where the file is located: 
+
+```shell script
+docker-compose up
+```
+This will also start all services and make them available [here](http://localhost:80/).
+
+
 ## Remaining Files
 All the remaining not explicitly explained files are important for the scripts to work and should not be changed manually.
 
 ## Help
-For further help, feedback or questions write us an [email](mailto:filefighter@t-online.de).
+For further help, feedback or questions write us an [email](mailto:dev@filefighter.de).

ffighter

@@ -11,9 +11,10 @@ source lib/install.sh
 source lib/start.sh
 source lib/stop.sh
 source lib/status.sh
+source lib/update.sh
 
-version="v1.4"
-date="15.11.20"
+version="v1.5"
+date="21.12.20"
 
 # Check if docker is running
 if ! docker info >/dev/null 2>&1; then
@@ -57,6 +58,12 @@ if [[ $1 == "remove" ]]; then
   exit 0
 fi
 
+if [[ $1 == "update" ]]; then
+  echoLogo $version $date "Updating FileFighter"
+  ffupdate
+  exit 0
+fi
+
 echoLogo $version $date "Show Usage"
 printUsage
 exit 1

lib/install.sh

@@ -123,7 +123,6 @@ ffinstall() {
   echo "Creating Frontend Container, with tag: $frontendVersion."
   echo "Downloading filefighter/frontend image."
   docker create \
-    -e REST_PORT=$rest_port \
     --network $networkname \
     --name $frontendname filefighter/frontend:$frontendVersion >/dev/null 2>&1
 

lib/remove.sh

@@ -6,10 +6,10 @@ ffremove() {
   reverseproxyname="FileFighterReverseProxy"
 
   if [[ $(docker ps -a --format "{{.Names}}" | grep $restname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $frontendname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $dbname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $reverseproxyname) ]]; then
-    docker container stop $restname && docker container rm $restname
-    docker container stop $frontendname && docker container rm $frontendname
-    docker container stop $dbname && docker container rm $dbname
-    docker container stop $reverseproxyname && docker container rm $reverseproxyname
+    docker container stop $restname && docker container rm $restname >/dev/null 2>&1
+    docker container stop $frontendname && docker container rm $frontendname >/dev/null 2>&1
+    docker container stop $dbname && docker container rm $dbname >/dev/null 2>&1
+    docker container stop $reverseproxyname && docker container rm $reverseproxyname >/dev/null 2>&1
 
     echo ""
     echo "Removed FileFighter Application. Install it again with 'ffighter install'."

lib/update.sh

@@ -0,0 +1,172 @@
+restname="FileFighterREST"
+frontendname="FileFighterFrontend"
+networkname="FileFighterNetwork"
+dbname="FileFighterDB"
+
+
+ffupdate(){
+
+if [[ $(docker ps -a --format "{{.Names}}" | grep $restname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $frontendname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $dbname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $reverseproxyname) ]]; then
+   echo "Installation is fine, starting to read config..."
+else
+  echo "FileFighter is not installed, run 'ffighter install' first"
+fi
+
+  source lib/config.sh     # load the config library functions
+  source lib/dockertags.sh # load docker functions.
+
+configFilePath=$(pwd)/config.cfg
+
+  # Read in default keys.
+  app_port="$(read $configFilePath app_port)"
+  db_name="$(read $configFilePath db_name)"
+  db_user="$(read $configFilePath db_user)"
+  db_password="$(read $configFilePath db_password)"
+  use_stable_versions="$(read $configFilePath use_stable_versions)"
+
+
+  if ! [[ $app_port ]]; then
+    echo "Config for app_port not found, using defaults."
+    app_port="$(read ./lib/config.cfg.defaults app_port)"
+  fi
+
+  if ! [[ $db_name ]]; then
+    echo "Config for db_name not found, using defaults."
+    db_name="$(read config.cfg.defaults db_name)"
+  fi
+
+  if ! [[ $db_user ]]; then
+    echo "Config for db_user not found, using defaults."
+    db_user="$(read config.cfg.defaults db_user)"
+  fi
+
+  if ! [[ $db_password ]]; then
+    echo "Config for db_password not found, using defaults."
+    db_password="$(read config.cfg.defaults db_password)"
+  fi
+
+  # Finished Config:
+  echo "Finished reading config. starting update..."
+
+  # Check if (default) password was empty.
+  if ! [[ $db_password ]]; then
+    echo "Password was not set, please set the password in your config ($configFilePath) or run 'ffighter install' again"
+    exit 1
+  fi
+
+  # Check versions config
+  if [[ $use_stable_versions == "true" ]]; then
+    echo "Updating stable versions."
+   ffupdateStable
+  else
+    echo "Warning! Updating latest versions."
+    echo "Updating latest version is not recommended and might break the application. Please report found problems here: [email protected]."
+    ffupdateLatest
+  fi
+}
+
+ffupdateStable(){
+
+frontendVersionRepo="$(getTagsByName filefighter/frontend v | tail -1)"
+restVersionRepo="$(getTagsByName filefighter/rest v | tail -1)"
+
+if [[ "$(docker images -q filefighter/frontend:$frontendVersionRepo 2> /dev/null)" == "" ]]; then
+  echo "New version for FileFighter Frontend available, downloading it"
+  docker container stop $frontendname && docker container rm $frontendname
+
+  echo "Creating Frontend Container, with tag: $frontendVersionRepo."
+  echo "Downloading filefighter/frontend image."
+  docker create \
+    --network $networkname \
+    --name $frontendname filefighter/frontend:$frontendVersionRepo >/dev/null 2>&1
+
+  echo "Finished downloading. Starting the updated container..."
+  docker start $frontendname
+
+else
+  echo "FileFighter Frontend is up to date"
+fi
+
+if [[ "$(docker images -q filefighter/rest:$restVersionRepo 2> /dev/null)" == "" ]]; then
+  echo "New version for FileFighter Rest available, downloading it"
+  docker container stop $restname && docker container rm $restname
+
+  # REST APP
+  echo "Creating REST Container, with tag: $restVersionRepo."
+  echo "Downloading filefighter/rest image."
+  docker create \
+    -e DB_USERNAME=$db_user \
+    -e DB_PASSWORD=$db_password \
+    -e DB_NAME=$db_name \
+    -e DB_CONTAINER_NAME=$dbname \
+    -e SPRING_PROFILES_ACTIVE="prod" \
+    --expose 8080 \
+    --network $networkname \
+    --name $restname filefighter/rest:$restVersionRepo >/dev/null 2>&1
+
+  echo "Finished downloading. Restarting the updated container..."
+  docker start $restname
+
+  echo ""
+else
+  echo "FileFighter FileFighter Rest is up to date"
+fi
+}
+
+ffupdateLatest(){
+
+if ! type "regctl" >/dev/null 2>&1; then
+ echo ""
+ echo "regctl not found! Install it from here https://github.com/regclient/regclient/releases"
+ echo ""
+ exit 1
+fi
+
+frontendDigest="$(regctl image digest --list filefighter/frontend:latest)"
+restDigest="$(regctl image digest --list filefighter/rest:latest)"
+
+if [[ "$( docker inspect --format='{{.RepoDigests}}' filefighter/frontend:latest 2> /dev/null)" == "[filefighter/frontend@$frontendDigest]" ]]; then
+  echo "FileFighter Frontend is up to date"
+else
+
+  echo "New version for FileFighter Frontend available, downloading it"
+
+  docker container stop $frontendname >/dev/null 2>&1 && docker container rm $frontendname >/dev/null 2>&1
+  docker rmi filefighter/frontend:latest >/dev/null 2>&1
+
+  echo "Creating Frontend Container, with tag: latest."
+  echo "Downloading filefighter/frontend image."
+  docker create \
+    --network $networkname \
+    --name $frontendname filefighter/frontend:latest >/dev/null 2>&1
+
+  echo "Finished downloading. Restarting the updated container..."
+  docker start $frontendname >/dev/null 2>&1
+fi
+
+if [[ "$( docker inspect --format='{{.RepoDigests}}' filefighter/rest:latest 2> /dev/null)" == "[filefighter/rest@$restDigest]" ]]; then
+  echo "FileFighter Rest is up to date"
+else
+   echo "New version for FileFighter Rest available, downloading it"
+
+docker container stop $restname >/dev/null 2>&1 && docker container rm $restname >/dev/null 2>&1
+docker rmi filefighter/rest:latest >/dev/null 2>&1
+
+  # REST APP
+  echo "Creating REST Container, with tag: latest."
+  echo "Downloading filefighter/rest image."
+  docker create \
+    -e DB_USERNAME=$db_user \
+    -e DB_PASSWORD=$db_password \
+    -e DB_NAME=$db_name \
+    -e DB_CONTAINER_NAME=$dbname \
+    -e SPRING_PROFILES_ACTIVE="prod" \
+    --expose 8080 \
+    --network $networkname \
+    --name $restname filefighter/rest:latest >/dev/null 2>&1
+
+  echo "Finished downloading. Restarting the updated container..."
+  docker start $restname >/dev/null 2>&1
+  echo ""
+fi
+}

lib/utils.sh

@@ -7,7 +7,7 @@ echoLogo() {
   echo "                                     |___/                             "
   echo "                   Version $1 Last updated: $2"
   echo "              Developed by Gimleux, Valentin, Open-Schnick.            "
-  echo "             Development Blog: https://filefighter.github.io           "
+  echo "             Development Blog: https://blog.filefighter.de           "
   echo "       The code can be found at: https://www.github.com/filefighter    "
   echo ""
   echo "-------------------------< $3 >---------------------------"
@@ -22,4 +22,5 @@ printUsage() {
   echo "  start     - start the services."
   echo "  stop      - stop the services."
   echo "  remove    - remove all services."
-}
+  echo "  update    - update all the services that have a new version available."
+}