Add file logging via LOGGING_DIRECTORY and add an example systemd service for native deployments

README.md

@@ -128,7 +128,7 @@ via web interface or API.
 The following environment variables can be used to modify application behavior.
 
 | Variable                           | Purpose                                                                                                                                                                                                       | Default/Description                                                                                                                  |
-|:-----------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------|
+|:-----------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------|
 | `TZ`                               | The time zone (**recommended** to set it properly, background tasks depend on it)                                                                                                                             | Defaults to `Europe/Berlin`, can be any time zone according to _tz database_                                                         |
 | `ADMIN_USER`                       | Admin user name for login                                                                                                                                                                                     | Not set by default, you need to explicitly set it to user name                                                                       |
 | `ADMIN_PASSWORD`                   | Admin password for login                                                                                                                                                                                      | Not set by default, you need to explicitly set it to a secure random                                                                 |
@@ -154,6 +154,7 @@ The following environment variables can be used to modify application behavior.
 |                                    |                                                                                                                                                                                                               |                                                                                                                                      |
 | `LOGGING_LEVEL`                    | Logging level. Possible are `debug`, `info`, `warn`, `error`, `dpanic`, `panic`, `fatal`. Setting to `debug` enables high verbosity output.                                                                   | Defaults to `info`                                                                                                                   |
 | `LOGGING_ENCODING`                 | Logging encoding. Possible are `console` and `json`                                                                                                                                                           | Defaults to `json`                                                                                                                   |
+| `LOGGING_DIRECTORY`                | Logging directory. When set, logs will be added to a file called `upda.log` in addition to the standard output. Ensure that upda has access permissions. Use an external program for log rotation if desired. |                                                                                                                                      |
 |                                    |                                                                                                                                                                                                               |                                                                                                                                      |
 | `WEBHOOKS_TOKEN_LENGTH`            | The length of the token                                                                                                                                                                                       | Defaults to `16`, positive number                                                                                                    |
 |                                    |                                                                                                                                                                                                               |                                                                                                                                      |

_doc/DEPLOYMENT.md

@@ -1,5 +1,13 @@
 # Deployment
 
+## Native
+
+Download the binary for your operating system. Next, use the binary or execute it locally.
+
+See the provided systemd service example [upda.service](./contrib/upda.service) to deploy on a UNIX/Linux machine.
+
+## Container
+
 Use one of the provided `docker-compose` examples, edit to your needs. Then issue `docker compose up` command.
 
 All applications should be up and running.
@@ -10,7 +18,7 @@ Default image user is `appuser` (`uid=2033`) and group is `appgroup` (`gid=2033`
 
 The following examples are available
 
-## Postgres
+### Postgres
 
 ```yaml
 version: '3.9'
@@ -78,7 +86,7 @@ volumes:
     external: false
 ```
 
-## SQLite
+### SQLite
 
 ```yaml
 version: '3.9'
@@ -111,14 +119,13 @@ services:
     image: git.myservermanager.com/varakh/upda:latest
     environment:
       - TZ=Europe/Berlin
-      - DB_SQLITE_FILE=/data/upda.db
       - ADMIN_USER=admin
       - ADMIN_PASSWORD=changeit
     restart: unless-stopped
     networks:
       - internal
     volumes:
-      - upda-app-vol:/data
+      - upda-app-vol:/home/appuser
     ports:
       - "127.0.0.1:8080:8080"
 
@@ -127,7 +134,7 @@ volumes:
     external: false
 ```
 
-### Reverse proxy
+## Reverse proxy
 
 You may want to use a proxy in front of them on your host, e.g., nginx. Here's a configuration snippet which should do
 the work.

_doc/contrib/upda.service

@@ -0,0 +1,14 @@
+[Unit]
+Description=upda
+After=network.target
+
+[Service]
+Type=simple
+# Using a dynamic user drops privileges and sets some security defaults
+# See https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html
+DynamicUser=yes
+# All environment variables for upda can be put into this file
+# upda picks them up (on each restart)
+EnvironmentFile=/etc/upda.conf
+# Requires upda' binary to be installed at this location, e.g., via package manager or copying it over manually
+ExecStart=/usr/local/bin/upda-server

server/constants_env.go

@@ -8,6 +8,9 @@ const (
 	envLoggingEncoding     = "LOGGING_ENCODING"
 	loggingEncodingDefault = "json"
 
+	envLoggingDirectory    = "LOGGING_DIRECTORY"
+	loggingFileNameDefault = "upda.log"
+
 	envTZ     = "TZ"
 	tzDefault = "Europe/Berlin"
 

server/environment.go

@@ -3,6 +3,7 @@ package server
 import (
 	"errors"
 	"fmt"
+	"git.myservermanager.com/varakh/upda/util"
 	"github.com/adrg/xdg"
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
@@ -13,6 +14,7 @@ import (
 	"log"
 	"moul.io/zapgorm2"
 	"os"
+	"path/filepath"
 	"strconv"
 	"time"
 )
@@ -111,6 +113,19 @@ func bootstrapEnvironment() *Environment {
 		loggingEncoderConfig = zap.NewDevelopmentEncoderConfig()
 	}
 
+	logPaths := []string{"stderr"}
+	loggingDirectory := os.Getenv(envLoggingDirectory)
+
+	if loggingDirectory != "" {
+		logFile := filepath.Join(loggingDirectory, loggingFileNameDefault)
+
+		if err = util.CreateFileWithParent(logFile); err != nil {
+			log.Fatalf("Log file '%s' cannot be created: %v", loggingDirectory, err)
+		}
+
+		logPaths = append(logPaths, logFile)
+	}
+
 	var zapConfig *zap.Config
 	if isDebug {
 		zapConfig = &zap.Config{
@@ -118,8 +133,8 @@ func bootstrapEnvironment() *Environment {
 			Development:      isDevelopment,
 			Encoding:         loggingEncoding,
 			EncoderConfig:    loggingEncoderConfig,
-			OutputPaths:      []string{"stderr"},
-			ErrorOutputPaths: []string{"stderr"},
+			OutputPaths:      logPaths,
+			ErrorOutputPaths: logPaths,
 		}
 	} else {
 		zapConfig = &zap.Config{
@@ -131,8 +146,8 @@ func bootstrapEnvironment() *Environment {
 			},
 			Encoding:         loggingEncoding,
 			EncoderConfig:    loggingEncoderConfig,
-			OutputPaths:      []string{"stderr"},
-			ErrorOutputPaths: []string{"stderr"},
+			OutputPaths:      logPaths,
+			ErrorOutputPaths: logPaths,
 		}
 	}
 
@@ -265,6 +280,10 @@ func bootstrapEnvironment() *Environment {
 		dbFile := os.Getenv(envDbSqliteFile)
 		zap.L().Sugar().Infof("Using database file '%s'", dbFile)
 
+		if err = util.CreateFileWithParent(dbFile); err != nil {
+			zap.L().Sugar().Fatalf("Database file '%s' cannot be created: %v", dbFile, err)
+		}
+
 		if db, err = gorm.Open(sqlite.Open(dbFile), gormConfig); err != nil {
 			zap.L().Sugar().Fatalf("Could not setup database: %v", err)
 		}

util/file.go

@@ -0,0 +1,47 @@
+package util
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"path/filepath"
+)
+
+// CreateFileWithParent creates a file and all prefixed directories first
+func CreateFileWithParent(file string) error {
+	if file == "" {
+		return errors.New("assert: blank values are not allowed for 'file'")
+	}
+
+	var err error
+	parentDir := filepath.Dir(file)
+
+	if err = os.MkdirAll(parentDir, os.ModePerm); err != nil {
+		return errors.New(fmt.Sprintf("cannot create parent directory '%v': %v", parentDir, fmt.Errorf("%w", err)))
+	}
+
+	if _, err = os.Stat(file); errors.Is(err, os.ErrNotExist) {
+		var f *os.File
+		f, err = os.Create(file)
+		defer f.Close()
+		if err != nil {
+			return errors.New(fmt.Sprintf("cannot create file '%v': %v", file, fmt.Errorf("%w", err)))
+		}
+	}
+
+	return err
+}
+
+// CreateDirectoryRecursively creates a directory recursively
+func CreateDirectoryRecursively(dir string) error {
+	if dir == "" {
+		return errors.New("assert: blank values are not allowed for 'dir'")
+	}
+
+	var err error
+	if err = os.MkdirAll(dir, os.ModePerm); err != nil {
+		return errors.New(fmt.Sprintf("cannot create parent directory '%v': %v", dir, fmt.Errorf("%w", err)))
+	}
+
+	return err
+}