FF-134 reverse proxy (#6)

* rp is basiclly working

* proxy working, rest is weird

* cleanup is neccesarry

* fixed weird behavouir of rest

* refactoring

* changed ngix config till i turn insane

* made the docker running check consistent.

* fixed small typo

* made install.sh output consistent.

* FF-138 Created nginx workflow

Co-authored-by: open-schnick <jonathan.burst@gmx.de>

Author: qvalentin

.github/workflows/nginx_image.yml

@@ -0,0 +1,29 @@
+name: Build Nginx Image
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag for new Image'
+        required: true
+        default: 'v1.0.0'
+
+jobs:
+  Build_Image:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout Repo.
+        uses: actions/checkout@v1
+      -
+        name: Login to DockerHub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USER }}
+          password: ${{ secrets.DOCKER_PW }}
+      -
+        name: Build and push Image
+          run: |
+          VERSION=${{ github.event.inputs.tag }}
+          docker build -t filefighter/reverseproxy:$VERSION ReverseProxy/
+          docker push filefighter/reverseproxy:$VERSION

README.md

@@ -112,7 +112,7 @@ You should see a login page. For the first setup you can use the credentials.
 To be sure everything is setup correctly click [here](http://localhost:80/health). If everything is green you are good to go.
 
 ### Configuration
-The script uses a [config.cfg](./config.cfg) file that stores information in `key=value` format.  
+The script uses a [config.cfg](config.cfg) file that stores information in `key=value` format.  
 Valid keys to configure how FileFighter behaves are listed here:
 
 | Key      | Possible Values | Default | Description |
@@ -125,7 +125,7 @@ Valid keys to configure how FileFighter behaves are listed here:
 | use_stable_versions | true / false | true | When set to true the latest stable versions will be used. When set to false always the latest (possible unstable) versions will be used. |
 
 All of these keys use the [default values](./lib/config.cfg.defaults) if you don't overwrite those values.  
-It is also possible to have an empty [config.cfg](./config.cfg) file as the default values will be used.
+It is also possible to have an empty [config.cfg](config.cfg) file as the default values will be used.
 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.

ReverseProxy/Dockerfile

@@ -0,0 +1,6 @@
+# dockerfile
+FROM nginx
+RUN rm /etc/nginx/conf.d/default.conf
+COPY nginx.conf /etc/nginx/nginx.conf
+EXPOSE 80
+CMD ["nginx", "-g", "daemon off;"]

ReverseProxy/nginx.conf

@@ -0,0 +1,27 @@
+worker_processes 1;
+
+events { worker_connections 1024; }
+
+http {
+
+  sendfile on;
+
+  server {
+    listen 80;
+
+      proxy_set_header   Host $host;
+      proxy_set_header   X-Real-IP $remote_addr;
+      proxy_set_header   X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header   X-Forwarded-Host $server_name;
+
+    location /api  {
+      proxy_pass         http://FileFighterREST:8080/;
+      proxy_redirect     off;
+    }
+
+    location / {
+      proxy_pass         http://FileFighterFrontend:5000/;
+      proxy_redirect     off;
+    }
+  }
+}

config.cfg

@@ -1,5 +1,4 @@
-rest_port=8080
-frontend_port=80
+app_port=80
 db_user=root
 db_name=filefighter
 use_stable_versions=true

ffighter

@@ -15,6 +15,12 @@ source lib/status.sh
 version="v1.3"
 date="08.11.20"
 
+# Check if docker is running
+if ! docker info >/dev/null 2>&1; then
+  echo "Docker is not running, install it first or retry."
+  exit 1
+fi
+
 if [ -z "$1" ]; then
   echoLogo $version $date "Show Usage"
   printUsage

lib/config.cfg.defaults

@@ -1,8 +1,8 @@
 # DO NOT CHANGE OR REMOVE THIS FILE!
 
 # Services
-rest_port=8080
-frontend_port=80
+app_port=80
+
 
 # DB Settings
 db_user=root

lib/install.sh

@@ -3,42 +3,33 @@ ffinstall() {
   source lib/config.sh     # load the config library functions
   source lib/dockertags.sh # load docker functions.
 
-  # Check if docker is running
-  if ! docker info >/dev/null 2>&1; then
-    echo "Docker is not running, install it first or retry."
-    exit 1
-  fi
-
   # setup variables
   configFilePath=$(pwd)/config.cfg
   restname="FileFighterREST"
   frontendname="FileFighterFrontend"
   dbname="FileFighterDB"
   networkname="FileFighterNetwork"
+  reverseproxyname="FileFighterReverseProxy"
 
   # latest stable versions.
   frontendVersion="latest"
   restVersion="latest"
+  proxyVersion="$(getTagsByName filefighter/reverseproxy | tail -1)"
+
 
   echo "Docker prerequisites matched. Docker instance running."
   echo "Reading in config file from: $configFilePath."
 
   # Read in default keys.
-  frontend_port="$(read $configFilePath frontend_port)"
-  rest_port="$(read $configFilePath rest_port)"
+  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 ! [[ $frontend_port ]]; then
-    echo "Config for frontend_port not found, using defaults."
-    frontend_port="$(read ./lib/config.cfg.defaults frontend_port)"
-  fi
-
-  if ! [[ $rest_port ]]; then
-    echo "Config for rest_port not found, using defaults."
-    rest_port="$(read config.cfg.defaults rest_port)"
+  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
@@ -65,7 +56,7 @@ ffinstall() {
   if ! [[ $db_password ]]; then
     # Create new Password
     echo "Creating new random password for the database."
-    db_password=$(wget -qO- "https://www.passwordrandom.com/query?command=password&scheme=rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr")
+    db_password=$(wget -qO- "https://www.passwordrandom.com/query?command=password&scheme=rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr")
     write $configFilePath db_password $db_password
   fi
 
@@ -85,7 +76,7 @@ ffinstall() {
   echo "Finished reading config. Building containers..."
 
   # Check for already existing CONTAINERS.
-  if [[ $(docker ps -a --format "{{.Names}}" | grep $restname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $frontendname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $dbname) ]]; then
+  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 ""
     echo "A container with already exists with the name $restname or $frontendname or $dbname."
     echo "Maybe its the second time that you run this script. If not please remove these containers."
@@ -121,7 +112,7 @@ ffinstall() {
     -e DB_NAME=$db_name \
     -e DB_CONTAINER_NAME=$dbname \
     -e SPRING_PROFILES_ACTIVE="prod" \
-    -p $rest_port:8080 \
+    --expose 8080 \
     --network $networkname \
     --name $restname filefighter/rest:$restVersion >/dev/null 2>&1
 
@@ -133,10 +124,20 @@ ffinstall() {
   echo "Downloading filefighter/frontend image."
   docker create \
     -e REST_PORT=$rest_port \
-    -p $frontend_port:5000 \
+    --network $networkname \
     --name $frontendname filefighter/frontend:$frontendVersion >/dev/null 2>&1
 
   echo "Finished downloading."
+  echo ""
+
+  # ReverseProxy
+  echo "Creating ReverseProxy Container with tag: $proxyVersion"
+  echo "Downloading filefighter/reverseproxy image."
+  docker create \
+    --network $networkname \
+    -p $app_port:80 \
+    --name=$reverseproxyname \
+    filefighter/reverseproxy:$proxyVersion >/dev/null 2>&1
 
   # DataHandler
 

lib/remove.sh

@@ -3,11 +3,13 @@ ffremove() {
   restname="FileFighterREST"
   frontendname="FileFighterFrontend"
   dbname="FileFighterDB"
+  reverseproxyname="FileFighterReverseProxy"
 
-  if [[ $(docker ps -a --format "{{.Names}}" | grep $restname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $frontendname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $dbname) ]]; then
+  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
 
     echo "Removed FileFighter Application. Install it again with 'ffighter install'."
     exit 0

lib/start.sh

@@ -1,31 +1,27 @@
 #!/usr/bin/env bash
 
 ffstart() {
-  # Check if docker is running
-  if ! docker info >/dev/null 2>&1; then
-    echo "Docker is not running, install it first or retry."
-    exit 1
-  fi
-
   source ./lib/config.sh # load the config library functions
-  frontendport=$(read config.cfg frontend_port)
+  appport=$(read config.cfg app_port)
 
   # setup variables
   restname="FileFighterREST"
   frontendname="FileFighterFrontend"
   dbname="FileFighterDB"
+  reverseproxyname="FileFighterReverseProxy"
 
-  if [[ $(docker ps -a --format "{{.Names}}" | grep $restname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $frontendname) ]] || [[ $(docker ps -a --format "{{.Names}}" | grep $dbname) ]]; then
+  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 "Docker prerequisites matched. Docker instance running."
     echo "Starting services..."
 
     docker start $restname
     docker start $frontendname
     docker start $dbname
+    docker start $reverseproxyname
 
     echo ""
     echo "Finished starting FileFighter services."
-    echo "Frontend is running here: http://localhost:$frontendport."
+    echo "Frontend is running here: http://localhost:$appport."
     echo "You can stop them again with 'ffighter stop'."
     echo ""
     exit 0