first commit

Author: ciur

.gitignore

@@ -0,0 +1,7 @@
+pmcompose
+docker-compose.yaml
+docker-compose.yml
+vendor/
+dist/
+.vscode/
+*.tar.gz

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Eugen Ciur <eugen@papermerge.com> and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# Generate Docker Compose for Papermerge DMS
+
+

ask/ask.go

@@ -0,0 +1,170 @@
+package ask
+
+import (
+	"bufio"
+	"crypto/subtle"
+	"fmt"
+	"os"
+	"os/user"
+	"strconv"
+	"strings"
+
+	"golang.org/x/term"
+)
+
+func ReadInput(reader *bufio.Reader) string {
+	input, _ := reader.ReadString('\n')
+	return strings.TrimSpace(input)
+}
+
+func WebAppPort(defaultValue int) (int, error) {
+	reader := bufio.NewReader(os.Stdin)
+
+	fmt.Println(
+		`The port on which the Papermerge DMS webserver
+will listen for incoming connections.`)
+
+	fmt.Printf("Port [%d]:", defaultValue)
+	appPort := ReadInput(reader)
+	if appPort != "" {
+		result, err := strconv.Atoi(appPort)
+
+		if err != nil {
+			return -1, err
+		}
+
+		return result, nil
+	}
+
+	return defaultValue, nil
+}
+
+func AppVersion(defaultValue string) (string, error) {
+	reader := bufio.NewReader(os.Stdin)
+
+	fmt.Println("Papermerge DMS version")
+
+	fmt.Printf("Version [%s]:", defaultValue)
+	version := ReadInput(reader)
+	if version == "" {
+		return defaultValue, nil
+	}
+
+	return version, nil
+}
+
+func LoginCredentials() (*Credentials, error) {
+	reader := bufio.NewReader(os.Stdin)
+
+	fmt.Println("Specify initial login credentials.")
+
+	creds := Credentials{}
+	var username string
+
+	currentUser, err := user.Current()
+	if err != nil {
+		return nil, err
+	}
+
+	fmt.Printf("Username [%s]:", currentUser.Username)
+	username = ReadInput(reader)
+	if username == "" {
+		creds.Username = currentUser.Username
+	} else {
+		creds.Username = username
+	}
+
+	passwordMatch := false
+
+	for passwordMatch == false {
+		fmt.Print("Password:")
+		password1, err := term.ReadPassword(int(os.Stdin.Fd()))
+		if err != nil {
+			return nil, err
+		}
+		if len(password1) == 0 {
+			fmt.Println("Cannot be empty")
+			continue
+		}
+		fmt.Println()
+		fmt.Print("Password (again):")
+		password2, err := term.ReadPassword(int(os.Stdin.Fd()))
+		fmt.Println()
+		if err != nil {
+			return nil, err
+		}
+
+		passwordMatch = comparePasswords(password1, password2)
+
+		if passwordMatch {
+			creds.Password = string(password1)
+			break
+		} else {
+			fmt.Println("Password did not match")
+		}
+	}
+
+	return &creds, nil
+}
+
+func StorageBackend() (*S3StorageBackend, error) {
+	fmt.Println(`
+  S3 Storage
+  ===========
+
+  When using S3 storage, Papermerge will upload/download documents
+  to/from your private S3 location. This may be useful for example
+  when you plan run multiple webapp containers or you want
+  to use CDN (currently works only with AWS CloudFront) for serving
+  document files.
+  `)
+
+	reader := bufio.NewReader(os.Stdin)
+	fmt.Print("Would you use S3 storage? (yes no) [no]:")
+
+	yesno := ""
+
+	for yesno != "yes" || yesno != "no" {
+		yesno := ReadInput(reader)
+
+		if yesno == "" || yesno == "no" {
+			return nil, nil
+		}
+
+		if yesno != "yes" {
+			fmt.Print("Answer can be either yes or no")
+		}
+
+		if yesno == "yes" {
+			break
+		}
+	}
+
+	backend := S3StorageBackend{}
+	fmt.Print("AWS negion name? [eu-central-1]:")
+	region := ReadInput(reader)
+	if region == "" {
+		region = "eu-central-1"
+	}
+	backend.AWSRegionName = region
+
+	fmt.Print("S3 bucket name:")
+	bucketName := ReadInput(reader)
+	backend.S3BucketName = bucketName
+
+	fmt.Print("AWS_ACCESS_KEY_ID:")
+	accessKeyID := ReadInput(reader)
+	backend.AWSAccessKeyID = accessKeyID
+
+	fmt.Print("AWS_SECRET_ACCESS_KEY:")
+	secretAccessKey := ReadInput(reader)
+	backend.AWSSecretAccessKey = secretAccessKey
+
+	return &backend, nil
+
+}
+
+func comparePasswords(password1, password2 []byte) bool {
+	// Use subtle.ConstantTimeCompare for secure comparison
+	return subtle.ConstantTimeCompare(password1, password2) == 1
+}

ask/types.go

@@ -0,0 +1,14 @@
+package ask
+
+type Credentials struct {
+	Username string
+	Password string
+	Email    string
+}
+
+type S3StorageBackend struct {
+	S3BucketName       string
+	AWSRegionName      string
+	AWSAccessKeyID     string
+	AWSSecretAccessKey string
+}

go.mod

@@ -0,0 +1,8 @@
+module github.com/papermerge/pmcompose
+
+go 1.24.2
+
+require (
+	golang.org/x/sys v0.32.0 // indirect
+	golang.org/x/term v0.31.0 // indirect
+)

go.sum

@@ -0,0 +1,4 @@
+golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
+golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
+golang.org/x/term v0.31.0 h1:erwDkOK1Msy6offm1mOgvspSkslFnIGsFnxOKoufg3o=
+golang.org/x/term v0.31.0/go.mod h1:R4BeIy7D95HzImkxGkTW1UQTtP54tio2RyHz7PwK0aw=

pmcompose.go

@@ -0,0 +1,95 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"text/template"
+
+	"github.com/papermerge/pmcompose/ask"
+	"github.com/papermerge/pmcompose/utils"
+)
+
+type ComposeConfig struct {
+	SecretKey            string
+	AppVersion           string
+	UserLoginCredentials ask.Credentials
+	WebAppPort           int
+	S3StorageBackend     ask.S3StorageBackend
+}
+
+func main() {
+
+	fmt.Println(`
+###################################################
+###   Papermerge DMS docker compose generator   ###
+###################################################
+  `)
+
+	cfg := ComposeConfig{}
+
+	version, err := ask.AppVersion("3.5")
+
+	if err != nil {
+		fmt.Printf("Error: %v\n", err)
+		return
+	}
+
+	cfg.AppVersion = version
+
+	appPort, err := ask.WebAppPort(12000)
+
+	if err != nil {
+		fmt.Printf("Error: %v\n", err)
+		return
+	}
+
+	cfg.WebAppPort = appPort
+
+	creds, err := ask.LoginCredentials()
+
+	if err != nil {
+		fmt.Printf("Error: %v\n", err)
+		return
+	}
+
+	cfg.UserLoginCredentials = *creds
+
+	s3StorageBackend, err := ask.StorageBackend()
+
+	if err != nil {
+		fmt.Printf("Error: %v\n", err)
+		return
+	}
+
+	if s3StorageBackend != nil {
+		cfg.S3StorageBackend = *s3StorageBackend
+	}
+
+	secretKey, err := utils.GenerateSecretString(32)
+	if err != nil {
+		fmt.Printf("Error: %v\n", err)
+		return
+	}
+	cfg.SecretKey = secretKey
+
+	tmpl, err := template.ParseFiles("pmcompose_templates/docker-compose.yaml.tmpl")
+	if err != nil {
+		fmt.Println("Error loading template:", err)
+		return
+	}
+
+	outputFile, err := os.Create("docker-compose.yml")
+	if err != nil {
+		fmt.Println("Error creating docker-compose.yml:", err)
+		return
+	}
+	defer outputFile.Close()
+
+	err = tmpl.Execute(outputFile, cfg)
+	if err != nil {
+		fmt.Println("Error executing template:", err)
+		return
+	}
+
+	fmt.Println("✅ docker-compose.yml generated successfully.")
+}

pmcompose_templates/docker-compose.yaml.tmpl

@@ -0,0 +1,68 @@
+services:
+  webapp:
+    image: papermerge/papermerge:{{ .AppVersion }}
+    environment:
+      PAPERMERGE__SECURITY__SECRET_KEY: "{{ .SecretKey }}"
+      PAPERMERGE__AUTH__USERNAME: {{.UserLoginCredentials.Username }}
+      PAPERMERGE__AUTH__PASSWORD: {{.UserLoginCredentials.Password }}
+      PAPERMERGE__DATABASE__URL: postgresql://coco:jumbo@db:5432/pmgdb
+      PAPERMERGE__MAIN__MEDIA_ROOT: /var/media/pmg
+    ports:
+     - "{{ .WebAppPort }}:80"
+    depends_on:
+      - db
+      - redis
+    volumes:
+      - media_root:/var/media/pmg
+  path_template_worker:
+    image: papermerge/path-tmpl-worker:0.4
+    command: worker
+    environment:
+      PAPERMERGE__DATABASE__URL: postgresql://coco:jumbo@db:5432/pmgdb
+      PAPERMERGE__REDIS__URL: redis://redis:6379/0
+      PATH_TMPL_WORKER_ARGS: "-Q path_tmpl -c 2"
+    depends_on:
+      - db
+      - redis
+{{- if ne .S3StorageBackend.S3BucketName ""  }}
+  s3worker:
+    image: papermerge/s3worker:0.4.3
+    command: worker
+    environment:
+      PAPERMERGE__DATABASE__URL: postgresql://coco:jumbo@db:5432/pmgdb
+      PAPERMERGE__REDIS__URL: redis://redis:6379/0
+      PAPERMERGE__MAIN__MEDIA_ROOT: /var/media/pmg
+      PAPERMERGE__S3__BUCKET_NAME: {{ .S3StorageBackend.S3BucketName }}
+      S3_WORKER_ARGS: "-Q s3 -c 2"
+      AWS_REGION_NAME: {{ .S3StorageBackend.AWSRegionName }}
+      AWS_ACCESS_KEY_ID: {{ .S3StorageBackend.AWSAccessKeyID }}
+      AWS_SECRET_ACCESS_KEY: {{ .S3StorageBackend.AWSSecretAccessKey }}
+    depends_on:
+      - db
+      - redis
+    volumes:
+      - media_root:/var/media/pmg
+{{- end }}
+  db:
+    image: postgres:16.1
+    volumes:
+      - pgdata:/var/lib/postgresql/data/
+    environment:
+      POSTGRES_PASSWORD: jumbo
+      POSTGRES_DB: pmgdb
+      POSTGRES_USER: coco
+    healthcheck:
+      test: pg_isready -U $$POSTGRES_USER -d $$POSTGRES_DB
+      interval: 5s
+      timeout: 10s
+      retries: 5
+      start_period: 10s
+  redis:
+    image: bitnami/redis:7.2
+    ports:
+      - "6379:6379"
+    environment:
+      ALLOW_EMPTY_PASSWORD: "yes"
+volumes:
+  pgdata:
+  media_root: