Another Redis Desktop Manager

To create distributable packages for different platforms, use the following commands:

1. Prepare: Run npm run pack:prepare before building.
2. Windows (64-bit): npm run pack:win
3. Windows (32-bit): npm run pack:win32
4. Mac: npm run pack:mac
5. Linux: npm run pack:linux

You can install Another Redis Desktop Manager on macOS using these methods:

1. DMG: Download the latest .dmg package from GitHub releases or Gitee and double-click to install.
2. Homebrew: Use the command brew install --cask another-redis-desktop-manager.
3. App Store: Purchase and install via the Mac App Store to support the developer.

Troubleshooting: If the application fails to open after installation via brew or dmg, run the following command to remove the quarantine attribute and then reopen the app: sudo xattr -rd com.apple.quarantine /Applications/Another\ Redis\ Desktop\ Manager.app

You can launch the application from the command line and pass connection arguments directly. This is useful for automating connections or passing specific configurations like SSH or Cluster modes.

Platform-specific launch commands:

• Linux: ./Another Redis Desktop Manager.AppImage
• Mac: open /Applications/Another\ Redis\ Desktop\ Manager.app --args
• Windows: "D:\xxxx\Another Redis Desktop Manager.exe" (followed by arguments)

# Example: Connect to a local instance with authentication and a custom name
./Another\ Redis\ Desktop\ Manager.AppImage --host 127.0.0.1 --port 6379 --auth 123 --name tmp_connection

# Example: Connect to a Cluster via SSH
./Another\ Redis\ Desktop\ Manager.AppImage --ssh-host 192.168.0.110 --ssh-username root --ssh-password 123 --cluster

You can install Another Redis Desktop Manager on Windows using several methods:

1. Direct Download: Download the latest .exe package from the GitHub releases or Gitee and double-click to install.
2. Chocolatey: Use the command choco install another-redis-desktop-manager.
3. Winget: Use the command winget install qishibo.AnotherRedisDesktopManager.
4. Microsoft Store: Purchase and install via the Windows Store to support the developer.

You can install Another Redis Desktop Manager on Linux using these methods:

1. AppImage: Download the latest AppImage from GitHub releases or Gitee, run chmod +x <filename>, and double-click to run.
2. Snap: Use the command sudo snap install another-redis-desktop-manager.

Note for Snap users: If you encounter a 'permission denied' error when selecting a private key, grant access to your ~/.ssh folder by running: sudo snap connect another-redis-desktop-manager:ssh-keys

To build and run the development version on Linux or Mac, follow these steps:

1. Clone the repository: git clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1
2. Navigate to the directory: cd AnotherRedisDesktopManager
3. Install dependencies: npm install (If Electron download fails, use ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" npm install)
4. Start the development server with hot reload at localhost:9988: npm start
5. In a new terminal tab, build the desktop client: npm run electron

Linux Dependency: If you encounter a fontconfig/fontconfig.h: No such file or directory error, install the development library: sudo apt install libfontconfig1-dev

To build and run the development version on Windows, follow these steps:

1. Clone the repository: git clone https://github.com/qishibo/AnotherRedisDesktopManager.git --depth=1
2. Navigate to the directory: cd AnotherRedisDesktopManager
3. Install dependencies (using win32 platform): npm install --platform=win32 (If Electron download fails, use npm config set ELECTRON_MIRROR https://npmmirror.com/mirrors/electron/ then run npm install --platform=win32)
4. Start the development server with hot reload at localhost:9988: npm start
5. In a new terminal tab, build the desktop client: npm run electron

To connect to a Redis Cluster located in an internal network (e.g., Docker, LAN, or AWS), use the SSH + Cluster approach:

1. Use SSH to tunnel into the internal network.
2. Provide the internal IP of the Redis host in the --host field.
3. Enable the --cluster flag.

How to find the internal IP: Connect via SSH without the Cluster option enabled, open the console, and execute the command CLUSTER NODES. Select any IP address from the resulting output to use as your host.

The dev configuration object controls the behavior of the local development server. You can override the host and port using environment variables process.env.HOST and process.env.PORT respectively. If the specified port is already in use, the server will automatically determine a free port.

// Example of how dev settings are structured in config/index.js
module.exports = {
  dev: {
    host: 'localhost', // can be overwritten by process.env.HOST
    port: 9988,        // can be overwritten by process.env.PORT
    autoOpenBrowser: false,
    errorOverlay: true,
    notifyOnErrors: true,
    poll: false,
    devtool: 'cheap-module-eval-source-map',
    cacheBusting: true,
    cssSourceMap: true
  }
}