Merge pull request #20 from bnema/improve/install-docs-and-user-logs

docs(install): add quick install script and fix logs user service fallback

commit: 511b814996f12e38af5ea0787bda795900663c70
author: bnema · 9mo ago · 2026-01-16 05:13 UTC
committer: GitHub · 9mo ago · 2026-01-16 05:13 UTC
merge of: 12cefde + 8f6a4dc · diff against the first parent
signature: GPG UnverifiedB5690EEEBB952194 The key is unknown
refs: tag: v2.2.5

3 files · +63 -22

M docs/getting-started.md +3 -11


@@ -11,19 +11,11 @@ Deploy your first app with Gordon in under 5 minutes.
11	11		## 1. Install Gordon
12	12
13	13		```bash
14		-	# Download the latest release (choose your architecture)
15		-	# For x86_64:
16		-	wget https://github.com/bnema/gordon/releases/latest/download/gordon_linux_amd64.tar.gz
17		-	tar -xzf gordon_linux_amd64.tar.gz
18		-
19		-	# For ARM64 (Raspberry Pi 4, AWS Graviton, etc.):
20		-	# wget https://github.com/bnema/gordon/releases/latest/download/gordon_linux_arm64.tar.gz
21		-	# tar -xzf gordon_linux_arm64.tar.gz
22		-
23		-	chmod +x gordon
24		-	sudo mv gordon /usr/local/bin/
	14	+	curl -fsSL https://gordon.bnema.dev/install \| bash
25	15		```
26	16
	17	+	This script automatically detects your OS and architecture, downloads the appropriate binary, and installs it to `/usr/local/bin`.
	18	+
27	19		## 2. Start Gordon
28	20
29	21		```bash

 ## 1. Install Gordon
 ```bash
-# Download the latest release (choose your architecture)
+curl -fsSL https://gordon.bnema.dev/install | bash
-# For x86_64:
-wget https://github.com/bnema/gordon/releases/latest/download/gordon_linux_amd64.tar.gz
-tar -xzf gordon_linux_amd64.tar.gz
-# For ARM64 (Raspberry Pi 4, AWS Graviton, etc.):
-# wget https://github.com/bnema/gordon/releases/latest/download/gordon_linux_arm64.tar.gz
-# tar -xzf gordon_linux_arm64.tar.gz
-chmod +x gordon
-sudo mv gordon /usr/local/bin/
 ```
+This script automatically detects your OS and architecture, downloads the appropriate binary, and installs it to `/usr/local/bin`.
 ## 2. Start Gordon
 ```bash

M docs/installation.md +9 -1


@@ -12,7 +12,15 @@ Detailed installation guide for production environments.
12	12
13	13		## Download Gordon
14	14
15		-	### From GitHub Releases
	15	+	### Quick Install (Recommended)
	16	+
	17	+	```bash
	18	+	curl -fsSL https://gordon.bnema.dev/install \| bash
	19	+	```
	20	+
	21	+	This script automatically detects your OS (Linux/macOS) and architecture (amd64/arm64), downloads the appropriate binary from GitHub releases, and installs it to `/usr/local/bin`.
	22	+
	23	+	### Manual Installation
16	24
17	25		Linux (x86_64)
18	26		```bash


@@ -12,7 +12,15 @@ Detailed installation guide for production environments.
12			12
13		## Download Gordon	13		## Download Gordon
14			14
15	-	### From GitHub Releases	15	+	### Quick Install (Recommended)
			16	+
			17	+	```bash
			18	+	curl -fsSL https://gordon.bnema.dev/install \| bash
			19	+	```
			20	+
			21	+	This script automatically detects your OS (Linux/macOS) and architecture (amd64/arm64), downloads the appropriate binary from GitHub releases, and installs it to `/usr/local/bin`.
			22	+
			23	+	### Manual Installation
16			24
17		Linux (x86_64)	25		Linux (x86_64)
18		```bash	26		```bash

M internal/app/logs.go +51 -10


@@ -3,6 +3,7 @@ package app
3	3
4	4		import (
5	5		"bufio"
	6	+	"bytes"
6	7		"fmt"
7	8		"os"
8	9		"os/exec"

@@ -192,8 +193,57 @@ func hasJournalctl() bool {
192	193		}
193	194
194	195		// showJournalctlLog displays logs from journalctl.
	196	+	// It first tries user service, then falls back to system service.
195	197		func showJournalctlLog(follow bool, lines int) error {
	198	+	var userErr, systemErr error
	199	+
	200	+	// Try user service first (works without special permissions)
	201	+	hasLogs, err := hasJournalctlLogs(true)
	202	+	if err != nil {
	203	+	userErr = err
	204	+	} else if hasLogs {
	205	+	return runJournalctl(follow, lines, true)
	206	+	}
	207	+
	208	+	// Fall back to system service
	209	+	hasLogs, err = hasJournalctlLogs(false)
	210	+	if err != nil {
	211	+	systemErr = err
	212	+	} else if hasLogs {
	213	+	return runJournalctl(follow, lines, false)
	214	+	}
	215	+
	216	+	// If either check failed with an error, include that information
	217	+	if userErr != nil \|\| systemErr != nil {
	218	+	return fmt.Errorf("gordon service not found in journalctl (user: %v, system: %v)", userErr, systemErr)
	219	+	}
	220	+
	221	+	return fmt.Errorf("gordon service not found in journalctl: enable file logging in config.toml or run gordon as a systemd service")
	222	+	}
	223	+
	224	+	// hasJournalctlLogs checks if there are any logs for the gordon service.
	225	+	func hasJournalctlLogs(userService bool) (bool, error) {
	226	+	args := []string{"-u", "gordon", "-n", "1", "--no-pager", "-q"}
	227	+	if userService {
	228	+	args = append([]string{"--user"}, args...)
	229	+	}
	230	+
	231	+	// #nosec G204 -- args are constructed internally with controlled values
	232	+	cmd := exec.Command("journalctl", args...)
	233	+	output, err := cmd.Output()
	234	+	if err != nil {
	235	+	return false, err
	236	+	}
	237	+
	238	+	return len(bytes.TrimSpace(output)) > 0, nil
	239	+	}
	240	+
	241	+	// runJournalctl runs journalctl and displays the output.
	242	+	func runJournalctl(follow bool, lines int, userService bool) error {
196	243		args := []string{"-u", "gordon", "-n", fmt.Sprintf("%d", lines), "--no-pager"}
	244	+	if userService {
	245	+	args = append([]string{"--user"}, args...)
	246	+	}
197	247		if follow {
198	248		args = append(args, "-f")
199	249		}

@@ -203,14 +253,5 @@ func showJournalctlLog(follow bool, lines int) error {
203	253		cmd.Stdout = os.Stdout
204	254		cmd.Stderr = os.Stderr
205	255
206		-	err := cmd.Run()
207		-	if err != nil {
208		-	// Check if it's because the service doesn't exist
209		-	if exitErr, ok := err.(*exec.ExitError); ok && exitErr.ExitCode() != 0 {
210		-	return fmt.Errorf("gordon service not found in journalctl: enable file logging in config.toml or run gordon as a systemd service")
211		-	}
212		-	return fmt.Errorf("failed to run journalctl: %w", err)
213		-	}
214		-
215		-	return nil
	256	+	return cmd.Run()
216	257		}


@@ -3,6 +3,7 @@ package app
3			3
4		import (	4		import (
5		"bufio"	5		"bufio"
			6	+	"bytes"
6		"fmt"	7		"fmt"
7		"os"	8		"os"
8		"os/exec"	9		"os/exec"

@@ -192,8 +193,57 @@ func hasJournalctl() bool {
192		}	193		}
193			194
194		// showJournalctlLog displays logs from journalctl.	195		// showJournalctlLog displays logs from journalctl.
			196	+	// It first tries user service, then falls back to system service.
195		func showJournalctlLog(follow bool, lines int) error {	197		func showJournalctlLog(follow bool, lines int) error {
			198	+	var userErr, systemErr error
			199	+
			200	+	// Try user service first (works without special permissions)
			201	+	hasLogs, err := hasJournalctlLogs(true)
			202	+	if err != nil {
			203	+	userErr = err
			204	+	} else if hasLogs {
			205	+	return runJournalctl(follow, lines, true)
			206	+	}
			207	+
			208	+	// Fall back to system service
			209	+	hasLogs, err = hasJournalctlLogs(false)
			210	+	if err != nil {
			211	+	systemErr = err
			212	+	} else if hasLogs {
			213	+	return runJournalctl(follow, lines, false)
			214	+	}
			215	+
			216	+	// If either check failed with an error, include that information
			217	+	if userErr != nil \|\| systemErr != nil {
			218	+	return fmt.Errorf("gordon service not found in journalctl (user: %v, system: %v)", userErr, systemErr)
			219	+	}
			220	+
			221	+	return fmt.Errorf("gordon service not found in journalctl: enable file logging in config.toml or run gordon as a systemd service")
			222	+	}
			223	+
			224	+	// hasJournalctlLogs checks if there are any logs for the gordon service.
			225	+	func hasJournalctlLogs(userService bool) (bool, error) {
			226	+	args := []string{"-u", "gordon", "-n", "1", "--no-pager", "-q"}
			227	+	if userService {
			228	+	args = append([]string{"--user"}, args...)
			229	+	}
			230	+
			231	+	// #nosec G204 -- args are constructed internally with controlled values
			232	+	cmd := exec.Command("journalctl", args...)
			233	+	output, err := cmd.Output()
			234	+	if err != nil {
			235	+	return false, err
			236	+	}
			237	+
			238	+	return len(bytes.TrimSpace(output)) > 0, nil
			239	+	}
			240	+
			241	+	// runJournalctl runs journalctl and displays the output.
			242	+	func runJournalctl(follow bool, lines int, userService bool) error {
196		args := []string{"-u", "gordon", "-n", fmt.Sprintf("%d", lines), "--no-pager"}	243		args := []string{"-u", "gordon", "-n", fmt.Sprintf("%d", lines), "--no-pager"}
			244	+	if userService {
			245	+	args = append([]string{"--user"}, args...)
			246	+	}
197		if follow {	247		if follow {
198		args = append(args, "-f")	248		args = append(args, "-f")
199		}	249		}

@@ -203,14 +253,5 @@ func showJournalctlLog(follow bool, lines int) error {
203		cmd.Stdout = os.Stdout	253		cmd.Stdout = os.Stdout
204		cmd.Stderr = os.Stderr	254		cmd.Stderr = os.Stderr
205			255
206	-	err := cmd.Run()	256	+	return cmd.Run()
207	-	if err != nil {
208	-	// Check if it's because the service doesn't exist
209	-	if exitErr, ok := err.(*exec.ExitError); ok && exitErr.ExitCode() != 0 {
210	-	return fmt.Errorf("gordon service not found in journalctl: enable file logging in config.toml or run gordon as a systemd service")
211	-	}
212	-	return fmt.Errorf("failed to run journalctl: %w", err)
213	-	}
214	-
215	-	return nil
216		}	257		}