Fix for configuration not being mountable.

Author: winromulus

ES.SFTP.Host/Business/Configuration/GlobalConfiguration.cs

@@ -4,7 +4,6 @@ namespace ES.SFTP.Host.Business.Configuration
 {
     public class GlobalConfiguration
     {
-        public string HomeDirectory { get; set; }
         public ChrootDefinition Chroot { get; set; }
         public List<string> Directories { get; set; } = new List<string>();
     }

ES.SFTP.Host/Program.cs

@@ -48,7 +48,7 @@ public static IHostBuilder CreateHostBuilder(string[] args)
                 .ConfigureAppConfiguration((hostingContext, config) =>
                 {
                     config.AddJsonFile("app.logging.json", false, false);
-                    config.AddJsonFile("sftp.json", false, true);
+                    config.AddJsonFile("config/sftp.json", false, true);
                     config.AddEnvironmentVariables(EnvironmentVariablePrefix);
                     config.AddCommandLine(args);
                 })

ES.SFTP.Host/sftp.Development.json ES.SFTP.Host/config/sftp.Development.jsonES.SFTP.Host/sftp.Development.json renamed to ES.SFTP.Host/config/sftp.Development.json

@@ -29,7 +29,7 @@ Process:
 
 ### Configuration
 
-The SFTP server uses a `json` based configuration file for default server options and to define users. This file has to be mounted on `/app/sftp.json` inside the container.
+The SFTP server uses a `json` based configuration file for default server options and to define users. This file has to be mounted on `/app/config/sftp.json` inside the container.
 Environment variable based configuration is not supported (see the `Advanced Configuration` section below for the reasons).
 
 Below is the simplest configuration file for the SFTP server:
@@ -70,14 +70,14 @@ This will start a SFTP in the container `sftp` with the default configuration. Y
 > Provide your configuration
 
 ```shellsession
-$ docker run -p 22:22 -d emberstack/sftp --name sftp -v /host/sftp.json:/app/sftp.json:ro
+$ docker run -p 22:22 -d emberstack/sftp --name sftp -v /host/sftp.json:/app/config/sftp.json:ro
 ```
-This will override the default (`/app/sftp.json`) configuration with the one from the host `/host/sftp.json`.
+This will override the default (`/app/config/sftp.json`) configuration with the one from the host `/host/sftp.json`.
 
 > Mount a directory from the host for the user 'demo'
 
 ```shellsession
-$ docker run -p 22:22 -d emberstack/sftp --name sftp -v /host/sftp.json:/app/sftp.json:ro -v /host/demo:/home/demo/sftp
+$ docker run -p 22:22 -d emberstack/sftp --name sftp -v /host/sftp.json:/app/config/sftp.json:ro -v /host/demo:/home/demo/sftp
 ```
 This will mount the `demo` directory from the host on the `sftp` directory for the "demo" user.
 
@@ -95,7 +95,7 @@ services:
     ports:
       - "22:22"
     volumes:
-      - ../config-samples/sample.sftp.json:/app/sftp.json:ro
+      - ../config-samples/sample.sftp.json:/app/config/sftp.json:ro
 ```
 And run it using docker-compose
 ```shellsession
@@ -126,6 +126,7 @@ You can customize the values of the helm deployment by using the following Value
 | `image.pullPolicy`                                          | Container image pull policy                                                      | `Always` if `image.tag` is `latest`, else `IfNotPresent`|
 | `storage.volumes`                                           | Defines additional volumes for the pod                                           | `{}`                                                    |
 | `storage.volumeMounts`                                      | Defines additional volumes mounts for the sftp container                         | `{}`                                                    |
+| `configuration`                                             | Allows the in-line override of the configuration values                          | `null`                                                  |
 | `configuration.Global.Chroot.Directory`                     | Global chroot directory for the `sftp` user group. Can be overriden per-user     | `"%h"`                                                  |
 | `configuration.Global.Chroot.StartPath`                     | Start path for the `sftp` user group. Can be overriden per-user                  | `"sftp"`                                                |
 | `configuration.Global.Directories`                          | Directories that get created for all `sftp` users. Can be appended per user      | `["sftp"]`                                              |

ES.SFTP.Host/sftp.json ES.SFTP.Host/config/sftp.jsonES.SFTP.Host/sftp.json renamed to ES.SFTP.Host/config/sftp.json

@@ -8,6 +8,6 @@ services:
     ports:
       - "2222:22"
     volumes:
-    - ../samples/sample.dev.sftp.json:/app/sftp.json:ro
+    - ../samples/sample.dev.sftp.json:/app/config/sftp.json:ro
     - ../samples/.ssh/id_demo_rsa.pub:/home/demo/.ssh/keys/id_rsa.pub:ro
     - ../samples/.ssh/id_demo2_rsa.pub:/home/demo2/.ssh/keys/id_rsa.pub:ro

README.md

@@ -5,4 +5,4 @@ services:
     ports:
       - "22:22"
     volumes:
-      - ../samples/sample.sftp.json:/app/sftp.json:ro
+      - ../samples/sample.sftp.json:/app/config/sftp.json:ro

deploy/docker-compose/docker-compose.override.dev.yaml

@@ -33,6 +33,7 @@ You can customize the values of the helm deployment by using the following Value
 | `image.pullPolicy`                                          | Container image pull policy                                                      | `Always` if `image.tag` is `latest`, else `IfNotPresent`|
 | `storage.volumes`                                           | Defines additional volumes for the pod                                           | `{}`                                                    |
 | `storage.volumeMounts`                                      | Defines additional volumes mounts for the sftp container                         | `{}`                                                    |
+| `configuration`                                             | Allows the in-line override of the configuration values                          | `null`                                                  |
 | `configuration.Global.Chroot.Directory`                     | Global chroot directory for the `sftp` user group. Can be overriden per-user     | `"%h"`                                                  |
 | `configuration.Global.Chroot.StartPath`                     | Start path for the `sftp` user group. Can be overriden per-user                  | `"sftp"`                                                |
 | `configuration.Global.Directories`                          | Directories that get created for all `sftp` users. Can be appended per user      | `["sftp"]`                                              |

deploy/docker-compose/docker-compose.yaml

@@ -36,7 +36,8 @@ spec:
           volumeMounts:
           {{- if .Values.configuration }}
             - name: sftp-json
-              mountPath: "/app"
+              mountPath: "/app/config"
+              subPath: sftp.json
               readOnly: true
           {{- end }}
           {{- with .Values.storage.volumeMounts }}

deploy/helm/sftp/README.md

@@ -14,22 +14,14 @@ nameOverride: ""
 fullnameOverride: ""
 
 
-configuration:
-  Global:
-    Chroot:
-      Directory: "%h"
-      StartPath: "sftp"
-    Directories: ["sftp"]
-  Users:
-    - Username: demo
-      Password: demo
+configuration: null
 
 storage:
-  volumeMounts: {}
-  volumes: {}
+  volumeMounts: []
+  volumes: []
 
 
-initContainers: {}
+initContainers: []
 
 service:
   type: ClusterIP