Merge branch 'release-0-10-0'

.github/workflows/main.yml

@@ -20,7 +20,7 @@ jobs:
     - name: Run GoReleaser
       uses: goreleaser/goreleaser-action@v1
       with:
-        version: latest
+        version: v1.6.3
         args: release --rm-dist
         key: ${{ secrets.YOUR_PRIVATE_KEY }}
       env:

.goreleaser.yml

@@ -36,6 +36,18 @@ changelog:
     exclude:
     - '^docs:'
     - '^test:'
+    - '^chore:'
+release:
+  footer: |
+    ## Downloads
+    | Platform | Download link                                                                                                                 |
+    |----------|-------------------------------------------------------------------------------------------------------------------------------|
+    | Linux    | [deb package](https://github.com/claudiodangelis/qrcp/releases/download/{{ .Tag }}/qrcp_{{ .Tag }}_linux_x86_64.deb)          |
+    | Linux    | [RPM package](https://github.com/claudiodangelis/qrcp/releases/download/{{ .Tag }}/qrcp_{{ .Tag }}_linux_x86_64.rpm)          |
+    | macOS    | [macOS package](https://github.com/claudiodangelis/qrcp/releases/download/{{ .Tag }}/qrcp_{{ .Tag }}_macOS_x86_64.tar.gz)     |
+    | Windows  | [Windows package](https://github.com/claudiodangelis/qrcp/releases/download/{{ .Tag }}/qrcp_{{ .Tag }}_Windows_x86_64.tar.gz) |
+
+    Refer to the list of assets below for all supported platform.
 nfpms:
   - replacements:
       darwin: macOS

README.md

@@ -8,7 +8,8 @@ Transfer files over Wi-Fi from your computer to a mobile device by scanning a QR
 
 You can support development by donating with  [![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/claudiodangelis).
 
-Join the **Telegram channel** [qrcp_dev](https://t.me/qrcp_dev) for news about the development.
+Join the **Telegram channel** [qrcp_dev](https://t.me/qrcp_dev) or the [@qrcp_dev](https://twitter.com/qrcp_dev) **Twitter account** for news about the development.
+
 
 ## How does it work?
 ![Screenshot](docs/screenshot.png)
@@ -44,6 +45,10 @@ _Note: it requires go 1.8_
 
     go get github.com/claudiodangelis/qrcp
 
+If using go 1.18 or higher,
+
+    go install github.com/claudiodangelis/qrcp@latest
+
 ## Linux
 
 Download the latest Linux .tar.gz archive from the [Releases](https://github.com/claudiodangelis/qrcp/releases) page, extract it, move the binary to the proper directory, then set execution permissions.
@@ -186,9 +191,40 @@ qrcp receive --output=/tmp/dir
 ```
 
 
-## Options
+## Configuration
+
+`qrcp` works without any prior configuration, however, you can choose to configure to use specific values.
+
+To configure `qrcp` you can create a configuration file inside `$XDG_CONFIG_HOME/qrcp`.
+
+> Note: On Linux, the `$XDG_CONFIG_HOME` is `.config` under user home directory.
+> So, for example, on Linux the configuration file will be `$HOME/.config/qrcp/config.yml`.
+
+> Note: Starting from version 0.10.0, qrcp uses a YAML configuration file instead of the old JSON one. You can automatically migrate the legacy JSON format to the new YAML format by running `qrcp config migrate`.
+
+| Key         | Type    | Notes                                                                                                                                                                                  |
+|-------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `interface` | String  | This value is automatically discovered during the first launch of `qrcp`, you can set it to override the default. You can use the `any` interface to bind the web server to `0.0.0.0`. |
+| `bind`      | String  | This value is used by qrcp to bind the web server to. Note: if this value is set, the `interface` parameter is ignored.                                                                |
+| `port`      | Integer | When this value is not set, `qrcp` will pick a random port at any launch.                                                                                                              |
+| `path`      | String  | When this value is not set, `qrcp` will add a random string at the end of URL.                                                                                                         |
+| `output`    | String  | Default directory to receive files to. If empty, the current working directory is used.                                                                                                |
+| `fqdn`      | String  | When this value is set, `qrcp` will use it to replace the IP address in the generated URL.                                                                                             |
+| `keepAlive` | Bool    | Controls whether `qrcp` should quit after transferring the file. Defaults to `false`.                                                                                                  |
+| `secure`    | Bool    | Controls whether `qrcp` should use HTTPS instead of HTTP. Defaults to `false`                                                                                                          |
+| `tls-cert`  | String  | Path to the TLS certificate. It's only used when `secure: true`.                                                                                                                       |
+| `tls-key`   | String  | Path to the TLS key. It's only used when `secure: true`.                                                                                                                               |
 
-`qrcp` works without any prior configuration, however, you can choose to configure to use specific values. The `config` command launches a wizard that lets you configure parameters like interface, port, fully-qualified domain name and keep alive.
+
+All the configuration parameters can be controlled via environment variables prefixed with `QRCP_`, for example:
+- `$QRCP_INTERFACE`
+- `$QRCP_PORT`
+- `$QRCP_KEEPALIVE`
+- _etc_
+
+### Config Wizard
+
+The `config` command launches a wizard that lets you configure parameters like interface, port, fully-qualified domain name and keep alive.
 
 ```sh
 qrcp config
@@ -203,10 +239,10 @@ qrcp --list-all-interfaces config
 
 ### Configuration File
 
-The default configuration file is stored in $XDG_CONFIG_HOME/qrcp/config.json, however, you can specify the location of the config file by passing the `--config` flag:
+The default configuration file is stored in $XDG_CONFIG_HOME/qrcp/config.yml, however, you can specify the location of the config file by passing the `--config` flag:
 
 ```sh
-qrcp --config /tmp/qrcp.json MyDocument.pdf
+qrcp --config /tmp/qrcp.yml MyDocument.pdf
 ```
 
 ### Port
@@ -247,6 +283,13 @@ This is useful when you want to transfer files from your Amazon EC2, Digital Oce
 qrcp -i any MyDocument.pdf
 ```
 
+### Bind
+
+Alternatively to choosing the interface, you can directly specify the address you want `qrcp` to bind the webserver to.
+
+```sh
+qrcp --bind 10.20.30.40 MyDocument.pdf
+```
 
 ### URL
 
@@ -349,7 +392,7 @@ To load completions for each session, execute once:
 
 ## Authors
 
-**qrcp**, originally called **qr-filetransfer**, started from an idea of [Claudio d'Angelis]([email protected]) ([@daw985](https://twitter.com/daw985) on Twitter), the current maintainer, and it's [developed by the community](https://github.com/claudiodangelis/qrcp/graphs/contributors).
+**qrcp**, originally called **qr-filetransfer**, started from an idea of [Claudio d'Angelis]([email protected]) ([@claudiodangelis](https://t.me/claudiodangelis) on Telegram), the current maintainer, and it's [developed by the community](https://github.com/claudiodangelis/qrcp/graphs/contributors).
 
 
 [Join us!](https://github.com/claudiodangelis/qrcp/fork)

application/application.go

@@ -0,0 +1,31 @@
+package application
+
+type Flags struct {
+	Quiet             bool
+	KeepAlive         bool
+	ListAllInterfaces bool
+	Port              int
+	Path              string
+	Interface         string
+	Bind              string
+	FQDN              string
+	Zip               bool
+	Config            string
+	Browser           bool
+	Secure            bool
+	TlsCert           string
+	TlsKey            string
+	Output            string
+}
+
+type App struct {
+	Flags Flags
+	Name  string
+}
+
+func New() App {
+	return App{
+		Name:  "qrcp",
+		Flags: Flags{},
+	}
+}

cmd/config.go

@@ -1,12 +1,14 @@
 package cmd
 
 import (
+	"fmt"
+
 	"github.com/claudiodangelis/qrcp/config"
 	"github.com/spf13/cobra"
 )
 
 func configCmdFunc(command *cobra.Command, args []string) error {
-	return config.Wizard(configFlag, listallinterfacesFlag)
+	return config.Wizard(app)
 }
 
 var configCmd = &cobra.Command{
@@ -16,3 +18,18 @@ var configCmd = &cobra.Command{
 	Aliases: []string{"c", "cfg"},
 	RunE:    configCmdFunc,
 }
+
+var migrateCmd = &cobra.Command{
+	Use:   "migrate",
+	Short: "Migrate the legacy configuration file",
+	Long:  "Migrate the legacy JSON configuration file to the new YAML format",
+	Run: func(cmd *cobra.Command, args []string) {
+		ok, err := config.Migrate(app)
+		if err != nil {
+			fmt.Println("error while migrating the legacy JSON configuration file:", err)
+		}
+		if ok {
+			fmt.Println("Legacy JSON configuration file has been successfully deleted")
+		}
+	},
+}

cmd/qrcp.go

@@ -1,49 +1,39 @@
 package cmd
 
 import (
+	"github.com/claudiodangelis/qrcp/application"
 	"github.com/spf13/cobra"
 )
 
+var app application.App
+
 func init() {
+	app = application.New()
 	rootCmd.AddCommand(sendCmd)
 	rootCmd.AddCommand(receiveCmd)
 	rootCmd.AddCommand(configCmd)
 	rootCmd.AddCommand(versionCmd)
 	rootCmd.AddCommand(completionCmd)
+	configCmd.AddCommand(migrateCmd)
 	// Global command flags
-	rootCmd.PersistentFlags().BoolVarP(&quietFlag, "quiet", "q", false, "only print errors")
-	rootCmd.PersistentFlags().BoolVarP(&keepaliveFlag, "keep-alive", "k", false, "keep server alive after transferring")
-	rootCmd.PersistentFlags().BoolVarP(&listallinterfacesFlag, "list-all-interfaces", "l", false, "list all available interfaces when choosing the one to use")
-	rootCmd.PersistentFlags().IntVarP(&portFlag, "port", "p", 0, "port to use for the server")
-	rootCmd.PersistentFlags().StringVar(&pathFlag, "path", "", "path to use. Defaults to a random string")
-	rootCmd.PersistentFlags().StringVarP(&interfaceFlag, "interface", "i", "", "network interface to use for the server")
-	rootCmd.PersistentFlags().StringVarP(&fqdnFlag, "fqdn", "d", "", "fully-qualified domain name to use for the resulting URLs")
-	rootCmd.PersistentFlags().BoolVarP(&zipFlag, "zip", "z", false, "zip content before transferring")
-	rootCmd.PersistentFlags().StringVarP(&configFlag, "config", "c", "", "path to the config file, defaults to $XDG_CONFIG_HOME/qrcp/config.json")
-	rootCmd.PersistentFlags().BoolVarP(&browserFlag, "browser", "b", false, "display the QR code in a browser window")
-	rootCmd.PersistentFlags().BoolVarP(&secureFlag, "secure", "s", false, "use https connection")
-	rootCmd.PersistentFlags().StringVar(&tlscertFlag, "tls-cert", "", "path to TLS certificate to use with HTTPS")
-	rootCmd.PersistentFlags().StringVar(&tlskeyFlag, "tls-key", "", "path to TLS private key to use with HTTPS")
+	rootCmd.PersistentFlags().BoolVarP(&app.Flags.Quiet, "quiet", "q", false, "only print errors")
+	rootCmd.PersistentFlags().BoolVarP(&app.Flags.KeepAlive, "keep-alive", "k", false, "keep server alive after transferring")
+	rootCmd.PersistentFlags().BoolVarP(&app.Flags.ListAllInterfaces, "list-all-interfaces", "l", false, "list all available interfaces when choosing the one to use")
+	rootCmd.PersistentFlags().IntVarP(&app.Flags.Port, "port", "p", 0, "port to use for the server")
+	rootCmd.PersistentFlags().StringVar(&app.Flags.Path, "path", "", "path to use. Defaults to a random string")
+	rootCmd.PersistentFlags().StringVarP(&app.Flags.Interface, "interface", "i", "", "network interface to use for the server")
+	rootCmd.PersistentFlags().StringVar(&app.Flags.Bind, "bind", "", "address to bind the web server to")
+	rootCmd.PersistentFlags().StringVarP(&app.Flags.FQDN, "fqdn", "d", "", "fully-qualified domain name to use for the resulting URLs")
+	rootCmd.PersistentFlags().BoolVarP(&app.Flags.Zip, "zip", "z", false, "zip content before transferring")
+	rootCmd.PersistentFlags().StringVarP(&app.Flags.Config, "config", "c", "", "path to the config file, defaults to $XDG_CONFIG_HOME/qrcp/config.json")
+	rootCmd.PersistentFlags().BoolVarP(&app.Flags.Browser, "browser", "b", false, "display the QR code in a browser window")
+	rootCmd.PersistentFlags().BoolVarP(&app.Flags.Secure, "secure", "s", false, "use https connection")
+	rootCmd.PersistentFlags().StringVar(&app.Flags.TlsCert, "tls-cert", "", "path to TLS certificate to use with HTTPS")
+	rootCmd.PersistentFlags().StringVar(&app.Flags.TlsKey, "tls-key", "", "path to TLS private key to use with HTTPS")
 	// Receive command flags
-	receiveCmd.PersistentFlags().StringVarP(&outputFlag, "output", "o", "", "output directory for receiving files")
+	receiveCmd.PersistentFlags().StringVarP(&app.Flags.Output, "output", "o", "", "output directory for receiving files")
 }
 
-// Flags
-var zipFlag bool
-var portFlag int
-var interfaceFlag string
-var outputFlag string
-var keepaliveFlag bool
-var quietFlag bool
-var fqdnFlag string
-var pathFlag string
-var listallinterfacesFlag bool
-var configFlag string
-var browserFlag bool
-var secureFlag bool
-var tlscertFlag string
-var tlskeyFlag string
-
 // The root command (`qrcp`) is like a shortcut of the `send` command
 var rootCmd = &cobra.Command{
 	Use:           "qrcp",

cmd/receive.go

@@ -12,24 +12,9 @@ import (
 )
 
 func receiveCmdFunc(command *cobra.Command, args []string) error {
-	log := logger.New(quietFlag)
+	log := logger.New(app.Flags.Quiet)
 	// Load configuration
-	configOptions := config.Options{
-		Interface:         interfaceFlag,
-		Port:              portFlag,
-		Path:              pathFlag,
-		FQDN:              fqdnFlag,
-		KeepAlive:         keepaliveFlag,
-		ListAllInterfaces: listallinterfacesFlag,
-		Secure:            secureFlag,
-		TLSCert:           tlscertFlag,
-		TLSKey:            tlskeyFlag,
-		Output:            outputFlag,
-	}
-	cfg, err := config.New(configFlag, configOptions)
-	if err != nil {
-		return err
-	}
+	cfg := config.New(app)
 	// Create the server
 	srv, err := server.New(&cfg)
 	if err != nil {
@@ -44,7 +29,7 @@ func receiveCmdFunc(command *cobra.Command, args []string) error {
 	log.Print(srv.ReceiveURL)
 	// Renders the QR
 	qr.RenderString(srv.ReceiveURL)
-	if browserFlag {
+	if app.Flags.Browser {
 		srv.DisplayQR(srv.ReceiveURL)
 	}
 	if err := keyboard.Open(); err == nil {

cmd/send.go

@@ -14,24 +14,12 @@ import (
 )
 
 func sendCmdFunc(command *cobra.Command, args []string) error {
-	log := logger.New(quietFlag)
-	payload, err := payload.FromArgs(args, zipFlag)
+	log := logger.New(app.Flags.Quiet)
+	payload, err := payload.FromArgs(args, app.Flags.Zip)
 	if err != nil {
 		return err
 	}
-	// Load configuration
-	configOptions := config.Options{
-		Interface:         interfaceFlag,
-		Port:              portFlag,
-		Path:              pathFlag,
-		FQDN:              fqdnFlag,
-		KeepAlive:         keepaliveFlag,
-		ListAllInterfaces: listallinterfacesFlag,
-		Secure:            secureFlag,
-		TLSCert:           tlscertFlag,
-		TLSKey:            tlskeyFlag,
-	}
-	cfg, err := config.New(configFlag, configOptions)
+	cfg := config.New(app)
 	if err != nil {
 		return err
 	}
@@ -44,7 +32,7 @@ func sendCmdFunc(command *cobra.Command, args []string) error {
 	log.Print(`Scan the following URL with a QR reader to start the file transfer, press CTRL+C or "q" to exit:`)
 	log.Print(srv.SendURL)
 	qr.RenderString(srv.SendURL)
-	if browserFlag {
+	if app.Flags.Browser {
 		srv.DisplayQR(srv.SendURL)
 	}
 	if err := keyboard.Open(); err == nil {