feat: construction of mountOpt and vfsOpt for rc moounts

Author: iPromKnight

compose.yaml

@@ -1,12 +1,13 @@
 services:
   rclone-manager:
+    image: ipromknight/rclone-manager:latest
     container_name: rclone-manager
     restart: unless-stopped
     stop_signal: SIGTERM
     stop_grace_period: 30s
     ports:
       - "5572:5572"  # Rclone RC API
-      - "8080:8080"
+      - "8080:8080" # Add Mappings for any serves you have defined in config.yaml
     devices:
       - /dev/fuse:/dev/fuse:rwm
     cap_add:
@@ -19,36 +20,50 @@ services:
       - ./local-dev/mnt/rclone:/mnt/rclone:shared
       - ./local-dev/caches/rclone:/caches/rclone
     environment:
-      # General
-      RCLONE_BUFFER_SIZE: 0
+      # Rclone Manager Debug Messages (true/false)
+      DEBUG_MODE: "false"
+
+      # Customize Rclone Defaults
+      RCLONE_USE_MMAP: true
       RCLONE_BWLIMIT: off
       RCLONE_BIND: 0.0.0.0
       RCLONE_LOG_LEVEL: Info
       RCLONE_CACHE_DIR: /caches/rclone
-      RCLONE_DIR_CACHE_TIME: 10s
+      RCLONE_CONFIG: /data/rclone.conf
       RCLONE_TIMEOUT: 10m
       RCLONE_UMASK: 002
-      RCLONE_UID: 1000
-      RCLONE_GID: 1000
-      RCLONE_LINKS: true
+      RCLONE_UID: 568
+      RCLONE_GID: 568
+      RCLONE_ALLOW_NON_EMPTY: true
+      RCLONE_ALLOW_OTHER: true
+      RCLONE_BUFFER_SIZE: 0
+      RCLONE_DIR_CACHE_TIME: 10s
+      RCLONE_POLL_INTERVAL: 0
+      RCLONE_VFS_CACHE_MAX_AGE: 72h
+      RCLONE_VFS_CACHE_MAX_SIZE: 2G
+      RCLONE_VFS_CACHE_MIN_FREE_SPACE: off
+      RCLONE_VFS_CACHE_MODE: writes
+      RCLONE_VFS_CACHE_POLL_INTERVAL: 30s
+      RCLONE_VFS_DISK_SPACE_TOTAL_SIZE: 20G
+      RCLONE_VFS_FAST_FINGERPRINT: true
+      RCLONE_VFS_READ_AHEAD: 2M
+      RCLONE_VFS_READ_CHUNK_SIZE: 8M
+      RCLONE_VFS_READ_CHUNK_SIZE_LIMIT: 0
+      RCLONE_VFS_READ_WAIT: 5ms
+      RCLONE_VFS_REFRESH: true
+      RCLONE_READ_ONLY: true
+      RCLONE_NO_MODTIME: true
       RCLONE_MULTI_THREAD_STREAMS: 1
-      RCLONE_TRANSFERS: 1
-      RCLONE_ALLOW_NON_EMPTY: "true"
-      RCLONE_ALLOW_OTHER: "true"
-      RCLONE_CONFIG: /data/rclone.conf
+      RCLONE_TRANSFERS: 4
 
       # RCD API
       RCLONE_RC_ADDR: :5572
       RCLONE_RC_NO_AUTH: "true"
+
+      # RCD API Web GUI
       RCLONE_RC_WEB_GUI: "true"
       RCLONE_RC_WEB_GUI_NO_OPEN_BROWSER: "true"
+      RCLONE_RC_WEB_GUI_UPDATE: "true"
 
-      # VFS DEFAULTS
-      RCLONE_VFS_CACHE_MODE: writes
-      RCLONE_VFS_READ_CHUNK_SIZE: 10M
-      RCLONE_VFS_READ_CHUNK_SIZE_LIMIT: 10M
-
-      # MOUNT DEFAULTS
-      RCLONE_NO_TRAVERSE: "true"
-      RCLONE_IGNORE_EXISTING: "true"
-      RCLONE_POLL_INTERVAL: 0
+      ## Uncomment to use custom URL for fetching latest release. This is RcloneFM's URL.
+      # RCLONE_RC_WEB_FETCH_URL: "https://api.github.com/repos/retifrav/rclone-rc-web-gui/releases/latest"

config.yaml

@@ -1,28 +1,26 @@
+# Define your Mounts for Rclone Backends here
 mounts:
+    # This is the name of the backend in your rclone.conf
   - backendName: "AllDebrid"
+    # This is the path to the mountpoint on the host
     mountPoint: "/mnt/rclone/alldebrid"
+    # These will be fully converted to vfsOpt and mountOpt payloads for the rclone mount command through RC. You can use your regular rclone env vars.
+    # They override the shared options in the environment section of the compose / running container for this specific mount.
     environment:
       RCLONE_BWLIMIT: off
       RCLONE_READ_ONLY: true
       RCLONE_VFS_READ_CHUNK_SIZE: 16M
       RCLONE_VFS_READ_CHUNK_SIZE_LIMIT: 32M
+      RCLONE_VFS_CACHE_MODE: full
 
+# Define your Rclone Serves here . All protocols are supported.
 serves:
+    # This is the name of the backend in your rclone.conf
   - backendName: "AllDebrid"
+    # This is the serve protocol: webdav, ftp, sftp, dlna, docker, nfs, restic, s3.
     protocol: "webdav"
+    # This is the port to bind the serve to.
     addr: "0.0.0.0:8080"
+    # These will override the shared options in the environment section of the compose / running container for this specific serve.
     environment:
-      RCLONE_BUFFER_SIZE: 0
-      RCLONE_BWLIMIT: 300M
-      RCLONE_COPY_LINKS: true
-      RCLONE_LINKS: false
-      RCLONE_MAX_HEADER_SIZE: 8192
-      RCLONE_VFS_READ_CHUNK_SIZE: 16M
-      RCLONE_VFS_READ_CHUNK_SIZE_LIMIT: 32M
-      RCLONE_STATS: 60s
-      RCLONE_VFS_CACHE_MODE: writes
-      RCLONE_CUTOFF_MODE: cautious
-      RCLONE_MULTI_THREAD_STREAMS: 0
-      RCLONE_DIR_CACHE_TIME: 10s
-      RCLONE_NO_MODTIME: true
-      RCLONE_READ_ONLY: true
+      RCLONE_BUFFER_SIZE: 0

src/cmd/main.go

@@ -5,11 +5,21 @@ import (
 	"os"
 	"os/signal"
 	"rclone-manager/internal/rclone_manager"
+	"strings"
 	"syscall"
 	"time"
 )
 
-var logger = zerolog.New(os.Stdout).With().Timestamp().Logger()
+var logger zerolog.Logger
+
+func init() {
+	debugMode := os.Getenv("DEBUG_MODE")
+	if strings.ToLower(debugMode) == "true" || strings.ToLower(debugMode) == "1" {
+		logger = zerolog.New(os.Stdout).Level(zerolog.DebugLevel).With().Timestamp().Logger()
+	} else {
+		logger = zerolog.New(os.Stdout).Level(zerolog.InfoLevel).With().Timestamp().Logger()
+	}
+}
 
 func main() {
 	sigs := make(chan os.Signal, 1)

src/go.mod

@@ -4,12 +4,53 @@ go 1.23
 
 require (
 	github.com/fsnotify/fsnotify v1.8.0
+	github.com/rclone/rclone v1.68.2
 	github.com/rs/zerolog v1.33.0
 	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
+	github.com/Max-Sum/base32768 v0.0.0-20230304063302-18e6ce5945fd // indirect
+	github.com/aalpar/deheap v0.0.0-20210914013432-0cc84d79dec3 // indirect
+	github.com/abbot/go-http-auth v0.4.0 // indirect
+	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/coreos/go-semver v0.3.1 // indirect
+	github.com/coreos/go-systemd/v22 v22.5.0 // indirect
+	github.com/go-chi/chi/v5 v5.1.0 // indirect
+	github.com/go-git/go-billy/v5 v5.5.0 // indirect
+	github.com/go-ole/go-ole v1.3.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/jzelinskie/whirlpool v0.0.0-20201016144138-0675e54bb004 // indirect
+	github.com/lufia/plan9stats v0.0.0-20231016141302-07b5767bb0ed // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
-	github.com/mattn/go-isatty v0.0.19 // indirect
-	golang.org/x/sys v0.13.0 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/moby/sys/mountinfo v0.7.2 // indirect
+	github.com/power-devops/perfstat v0.0.0-20221212215047-62379fc7944b // indirect
+	github.com/prometheus/client_golang v1.19.1 // indirect
+	github.com/prometheus/client_model v0.5.0 // indirect
+	github.com/prometheus/common v0.48.0 // indirect
+	github.com/prometheus/procfs v0.12.0 // indirect
+	github.com/rfjakob/eme v1.1.2 // indirect
+	github.com/shirou/gopsutil/v3 v3.24.5 // indirect
+	github.com/shoenig/go-m1cpu v0.1.6 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
+	github.com/skratchdot/open-golang v0.0.0-20200116055534-eef842397966 // indirect
+	github.com/smartystreets/goconvey v1.8.1 // indirect
+	github.com/spf13/cobra v1.8.1 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	github.com/tklauser/go-sysconf v0.3.13 // indirect
+	github.com/tklauser/numcpus v0.7.0 // indirect
+	github.com/unknwon/goconfig v1.0.0 // indirect
+	github.com/yusufpapurcu/wmi v1.2.4 // indirect
+	golang.org/x/crypto v0.25.0 // indirect
+	golang.org/x/net v0.27.0 // indirect
+	golang.org/x/sync v0.8.0 // indirect
+	golang.org/x/sys v0.22.0 // indirect
+	golang.org/x/term v0.22.0 // indirect
+	golang.org/x/text v0.17.0 // indirect
+	golang.org/x/time v0.5.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
 )