feat: add branded banner with logo and links to all commands, better docs

Author: adiologydev

README.md

@@ -471,6 +471,7 @@ services:
   backitup:
     image: ghcr.io/climactic/backitup:latest
     command: start
+    user: root  # Required for reading files with restrictive permissions
     volumes:
       - ./config:/config              # Config + database
       - ./data:/data:ro               # Source files (read-only)
@@ -482,6 +483,53 @@ services:
     restart: unless-stopped
 ```
 
+### File Permissions
+
+The Docker image runs as a non-root user (UID 1000) by default. If you're backing up files with restrictive permissions (e.g., SSH keys, database files), you have two options:
+
+> **Tip:** Always mount source data directories as read-only (`:ro`) to prevent accidental modifications during backup.
+
+**Option 1: Run as root (simplest)**
+
+```yaml
+services:
+  backitup:
+    image: ghcr.io/climactic/backitup:latest
+    user: root
+    # ...
+```
+
+**Option 2: Match the host user**
+
+If your files are owned by a specific user, run the container as that user:
+
+```yaml
+services:
+  backitup:
+    image: ghcr.io/climactic/backitup:latest
+    user: "1000:1000"  # Match the UID:GID of file owner
+    # ...
+```
+
+### One-time vs Scheduled Backups
+
+Use `command: start` for the long-running scheduler daemon with `restart: unless-stopped`.
+
+For one-time backups (e.g., triggered by cron or CI), use `restart: on-failure` to prevent the container from restarting indefinitely after a successful backup:
+
+```yaml
+services:
+  backitup:
+    image: ghcr.io/climactic/backitup:latest
+    command: backup -s manual
+    user: root
+    volumes:
+      - ./config:/config
+      - ./data:/data:ro
+      - ./backups:/backups
+    restart: on-failure  # Don't restart after successful backup
+```
+
 ### systemd
 
 ```ini

docs/configuration.md

@@ -151,11 +151,43 @@ Named backup sources. Each source defines files to include in backups.
 | `path`     | string   | Yes      | Base directory path                 |
 | `patterns` | string[] | No       | Glob patterns (default: `["**/*"]`) |
 
-**Glob Pattern Examples:**
+**Glob Pattern Syntax:**
 
-- `**/*.ts` - All TypeScript files
-- `!**/node_modules/**` - Exclude node_modules
-- `src/**` - Everything in src directory
+Patterns use glob syntax to include or exclude files. Patterns starting with `!` are exclusions.
+
+**Important:** Patterns are matched relative to the source `path`, not as absolute paths. If your source path is `/data`, a file at `/data/logs/app.log` would be matched against `logs/app.log`.
+
+**Examples:**
+
+| Pattern | Description |
+| ------- | ----------- |
+| `**/*` | All files (default) |
+| `**/*.ts` | All TypeScript files |
+| `src/**` | Everything in src directory |
+| `!**/node_modules/**` | Exclude node_modules anywhere |
+| `!logs/**` | Exclude the logs directory |
+| `!*.log` | Exclude .log files in root only |
+| `!**/*.log` | Exclude all .log files |
+
+**Common mistake:** Using absolute paths in exclude patterns.
+
+```yaml
+# Wrong - patterns are relative to path, not absolute
+sources:
+  mydata:
+    path: "/data"
+    patterns:
+      - "**/*"
+      - "!/data/cache/**"  # Won't work!
+
+# Correct - use relative paths
+sources:
+  mydata:
+    path: "/data"
+    patterns:
+      - "**/*"
+      - "!cache/**"  # Excludes /data/cache/
+```
 
 ### `local`
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@climactic/backitup",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0",
   "description": "Secure backup utility with glob patterns, tar.gz archives, local + S3 storage, and safe cleanup",
   "author": {
     "name": "Climactic",

src/cli/commands/backup.ts

@@ -81,7 +81,7 @@ export async function backupCommand(args: string[]): Promise<number> {
 
     if (!schedule) {
       // Interactive mode - prompt for schedule
-      ui.intro("backitup backup");
+      ui.banner("backup");
 
       const scheduleOptions = [
         { value: "manual", label: "manual", hint: "One-time backup" },
@@ -114,7 +114,7 @@ export async function backupCommand(args: string[]): Promise<number> {
 
     // Show intro if we didn't already (non-interactive mode)
     if (values.schedule) {
-      ui.intro("backitup backup");
+      ui.banner("backup");
     }
 
     // Run backup with spinner

src/cli/commands/cleanup.ts

@@ -30,7 +30,7 @@ export async function cleanupCommand(args: string[]): Promise<number> {
   try {
     const config = await findAndLoadConfig(values.config);
 
-    ui.intro("backitup cleanup");
+    ui.banner("cleanup");
 
     // Validate schedule if specified
     if (values.schedule && !config.schedules[values.schedule]) {

src/cli/commands/list.ts

@@ -66,7 +66,7 @@ export async function listCommand(args: string[]): Promise<number> {
         return 0;
       default:
         // Show intro for table format
-        ui.intro("backitup list");
+        ui.banner("list");
 
         if (backups.length === 0) {
           ui.info("No backups found");

src/cli/commands/start.ts

@@ -68,7 +68,7 @@ export async function startCommand(args: string[]): Promise<number> {
       }
     }
 
-    ui.intro("backitup scheduler");
+    ui.banner("start");
 
     if (Object.keys(config.schedules).length === 0) {
       ui.error("No schedules configured");

src/cli/commands/verify.ts

@@ -43,7 +43,7 @@ export async function verifyCommand(args: string[]): Promise<number> {
     const config = await findAndLoadConfig(values.config);
     await initDatabase(config.database.path);
 
-    ui.intro("backitup verify");
+    ui.banner("verify");
 
     // Initialize S3 if enabled
     if (config.s3.enabled) {

src/cli/ui.ts

@@ -4,6 +4,7 @@
 
 export type { SummaryItem } from "./ui/index";
 export {
+  banner,
   cancel,
   color,
   confirm,
@@ -14,6 +15,8 @@ export {
   info,
   intro,
   isCancel,
+  LINKS,
+  LOGO,
   message,
   multiselect,
   note,
@@ -25,5 +28,6 @@ export {
   TABLE_WIDTHS,
   text,
   ui,
+  VERSION,
   warn,
 } from "./ui/index";

src/cli/ui/index.ts

@@ -7,17 +7,21 @@ export type { SummaryItem } from "./formatters";
 export { formatSummary, formatTableRow, formatTableSeparator, TABLE_WIDTHS } from "./formatters";
 // Output
 export {
+  banner,
   cancel,
   color,
   error,
   info,
   intro,
+  LINKS,
+  LOGO,
   message,
   note,
   outro,
   spinner,
   step,
   success,
+  VERSION,
   warn,
 } from "./output";
 // Prompts
@@ -28,6 +32,7 @@ import * as output from "./output";
 import * as prompts from "./prompts";
 
 export const ui = {
+  banner: output.banner,
   intro: output.intro,
   outro: output.outro,
   cancel: output.cancel,