Skip to content

Commit 6847935

Browse files
tjone270uglide
authored andcommitted
Correct spelling and re-word x86 not supported message.
1 parent 45bfa04 commit 6847935

File tree

3 files changed

+59
-64
lines changed

3 files changed

+59
-64
lines changed

build/windows/installer/installer.nsi

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,12 @@ Section -Main SEC0000
6969
${nsProcess::KillProcess} "${APP_EXE}" $R4
7070

7171
${IfNot} ${RunningX64}
72-
MessageBox MB_OK "Starting from 2019.0.0 version RDM doesn't support 32-bit Windows"
72+
MessageBox MB_OK "Starting from version 2019.0.0, Redis Desktop Manager doesn't support 32-bit Windows"
7373
Quit
7474
${EndIf}
7575

76-
IfFileExists $INSTDIR\uninstall.exe alredy_installed not_installed
77-
alredy_installed:
76+
IfFileExists $INSTDIR\uninstall.exe already_installed not_installed
77+
already_installed:
7878
ExecWait '$INSTDIR\uninstall.exe /S'
7979
Sleep 3000
8080

docs/install.md

Lines changed: 27 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22

33
## Windows
44

5-
1. Install [Microsoft Visual C++ 2017 x64](https://aka.ms/vs/15/release/vc_redist.x64.exe) (If you have not already)
6-
2. Download Windows Installer from [http://redisdesktop.com/download](http://redisdesktop.com/download) **(Requires subscription)**
7-
3. Run downloaded installer
5+
1. Install [Microsoft Visual C++ 2017 x64](https://aka.ms/vs/15/release/vc_redist.x64.exe) (If you have not already).
6+
2. Download Windows Installer from [http://redisdesktop.com/download](http://redisdesktop.com/download). **(Requires subscription)**
7+
3. Run the downloaded installer.
88

99
## Mac OS X
1010

11-
1. Download dmg image from [http://redisdesktop.com/download](http://redisdesktop.com/download) **(Requires subscription)**
12-
2. Mount dmg image
13-
3. Run rdm.app
11+
1. Download dmg image from [http://redisdesktop.com/download](http://redisdesktop.com/download). **(Requires subscription)**
12+
2. Mount the DMG image.
13+
3. Run rdm.app.
1414

1515
## Ubuntu / ArchLinux / Debian / Fedora / CentOS / OpenSUSE / etc
1616

17-
1. Install RedisDesktopManager using [Snapcraft](https://snapcraft.io/redis-desktop-manager)
17+
1. Install RedisDesktopManager using [Snapcraft](https://snapcraft.io/redis-desktop-manager).
1818

1919
> !!! warning "SSH Keys"
2020
To be able to access your ssh keys from RDM please connect `ssh-key` interface:
@@ -27,9 +27,12 @@
2727

2828
### Get source
2929

30-
1. Install git
31-
2. Get source code:
32-
30+
1. Install git:
31+
```
32+
sudo apt install git
33+
```
34+
35+
2. Get the source code:
3336
```
3437
git clone --recursive https://github.com/uglide/RedisDesktopManager.git -b 2019 rdm && cd ./rdm
3538
```
@@ -41,30 +44,23 @@
4144
4245
### Build on OS X
4346
44-
1. Install [XCode](https://developer.apple.com/xcode/) with Xcode build tools
45-
2. Install [Homebrew](http://brew.sh/)
46-
3. Copy `cd ./src && cp ./resources/Info.plist.sample ./resources/Info.plist`
47+
1. Install [Xcode](https://developer.apple.com/xcode/) with Xcode build tools.
48+
2. Install [Homebrew](http://brew.sh/).
49+
3. Copy `cd ./src && cp ./resources/Info.plist.sample ./resources/Info.plist`.
4750
4. Building RDM dependencies require i.a. `openssl`, `cmake` and `python3`. Install them: `brew install openssl cmake python3`
48-
5. Install python requirements `pip3 install -t ../bin/osx/release -r py/requirements.txt`
51+
5. Install Python requirements `pip3 install -t ../bin/osx/release -r py/requirements.txt`
4952
6. Install [Qt 5.9](http://www.qt.io/download-open-source/#section-2). Add Qt Creator and under Qt 5.9.x add Qt Charts module.
50-
7. Open ./src/rdm.pro in Qt Creator
51-
8. Run build
53+
7. Open `./src/rdm.pro` in **Qt Creator**.
54+
8. Run build.
5255
5356
### Build on Windows
5457
55-
1. Install Visual Studio 2017 Community
56-
57-
2. Install [Qt 5.9](https://www.qt.io/download)
58-
59-
3. Go to `3rdparty/qredisclient/3rdparty/hiredis` and apply patch to fix compilation on Windows:
58+
1. Install Visual Studio 2017 Community Edition.
59+
2. Install [Qt 5.9](https://www.qt.io/download).
60+
3. Go to `3rdparty/qredisclient/3rdparty/hiredis` and apply the patch to fix compilation on Windows:
6061
`git apply ../hiredis-win.patch`
61-
62-
4. Go to `3rdparty/` folder and install zlib with `nuget`: `nuget install zlib-msvc14-x64 -Version 1.2.11.7795`
63-
64-
5. Install Python 3.7 amd64 to `C:\Python37-x64`
65-
66-
6. Install python requirements `pip3 install -r src/py/requirements.txt`
67-
68-
7. Open `./src/rdm.pro` in **Qt Creator**. Chooses `Desktop Qt 5.9.x MSVC2017 64bit > Release` profile.
69-
70-
8. Run build. ( Just hit `Ctrl-B` )
62+
4. Go to the `3rdparty/` folder and install zlib with `nuget`: `nuget install zlib-msvc14-x64 -Version 1.2.11.7795`
63+
5. Install Python 3.7 amd64 to `C:\Python37-x64`.
64+
6. Install Python requirements `pip3 install -r src/py/requirements.txt`.
65+
7. Open `./src/rdm.pro` in **Qt Creator**. Choose the `Desktop Qt 5.9.x MSVC2017 64bit > Release` build profile.
66+
8. Run build. (Just hit `Ctrl-B`)

docs/quick-start.md

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,53 +2,54 @@
22
***
33

44

5-
After you [install](install.md) RDM the first you need to do in order to start using it is create Connection to your Redis server. On the main screen press button **Connect to Redis Server**.
5+
After you've [installed](install.md) Redis Desktop Manager, the first thing you need to do in order to get going is to create a connection to your Redis server. On the main window, press the button labelled **Connect to Redis Server**.
66

77
![](http://redisdesktop.com/static/docs/rdm_main.png)
88

9-
## Connect to local or public redis-server
10-
On the first tab Connection Settings put general info regarding connection that you are creating.
9+
## Connect to a local or public redis-server
10+
On the first tab (Connection Settings), put in general information regarding the connection that you are creating.
1111

12-
* **Name** - name of new connection (example: my_local_redis)
12+
* **Name** - the name of new connection (example: my_local_redis)
1313
* **Host** - redis-server host (example: localhost)
1414
* **Port** - redis-server port (example: 6379)
15-
* **Auth** - redis-server authentication password ([http://redis.io/commands/AUTH](http://redis.io/commands/AUTH))
15+
* **Auth** - redis-server authentication password (if any) ([http://redis.io/commands/AUTH](http://redis.io/commands/AUTH))
1616

17-
## Connect to public redis-server with SSL
18-
If you want to connect to redis-server with SSL you need to enable SSL on the second tab and provide a public key in PEM format. Bellow you can find instructions for particular cloud services.
17+
## Connect to a public redis-server with SSL
18+
If you want to connect to a redis-server instance with SSL you need to enable SSL on the second tab and provide a public key in PEM format.
19+
Instructions for certain cloud services are below:
1920

2021
<img src="http://redisdesktop.com/static/docs/rdm_ssl.png" height="300" />
2122

2223

2324
### Windows Azure Redis Cache <br /> <img src="https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/media/index/redis-cache.svg" height="100" />
2425

25-
1. Create connection with all requested information
26+
1. Create a connection with all requested information.
2627
<br /> <img src="http://redisdesktop.com/static/docs/rdm_ssl_azure.png" width="300" />
27-
2. Make sure that "Use SSL Protocol" checkbox is enabled
28-
3. Your Azure Redis connection is ready to use
28+
2. Make sure that the "Use SSL Protocol" checkbox is enabled.
29+
3. Your Azure Redis connection is ready to use.
2930

3031
### Redis Labs <br /> <img src="https://upload.wikimedia.org/wikipedia/commons/7/75/Redis_Labs_Logo.png" height="75" />
31-
To connect Redis Labs instance with SSL/TLS encryption do following steps:
32+
To connect to a Redis Labs instance with SSL/TLS encryption, follow the steps below:
3233

33-
1. Make sure that SSL is enabled for your Redis instance in Redis Labs dashboard.
34-
2. Download and unzip `garantia_credentials.zip` from Redis Labs dashboard
35-
3. Select `garantia_user.crt` in "Public key" field
36-
4. Select `garantia_user_private.key` in "Private key" field
37-
5. Select `garantia_ca.pem` in "Authority" field
34+
1. Make sure that SSL is enabled for your Redis instance in the Redis Labs dashboard.
35+
2. Download and unzip `garantia_credentials.zip` from the Redis Labs dashboard.
36+
3. Select `garantia_user.crt` in the "Public key" field.
37+
4. Select `garantia_user_private.key` in the "Private key" field.
38+
5. Select `garantia_ca.pem` in the "Authority" field.
3839

3940

4041
## Connect to private redis-server via SSH tunnel
4142
### Basic SSH tunneling
42-
SSH tab is supposed to allow you using SSH tunnel. It's useful if your redis-server is not publicly accessible via a network.
43-
To use SSH tunnel select checkbox "Use SSH Tunnel". There are different security options: you can use a plain password or OpenSSH private key.
43+
SSH tab is supposed to allow you to use a SSH tunnel. It's useful if your redis-server is not publicly accessible.
44+
To use a SSH tunnel select checkbox "Use SSH Tunnel". There are different security options; you can use a plain password or OpenSSH private key.
4445

4546
>!!! note "for Windows users:"
46-
Your private key is must be in .pem format.
47+
Your private key must be in .pem format.
4748

4849
<img src="http://redisdesktop.com/static/docs/rdm_ssh.png" height="300" />
4950

5051
### Advanced SSH tunneling
51-
If you need advanced SSH tunneling you should setup SSH tunnel manually and connect via localhost:
52+
If you need advanced SSH tunneling you should setup a SSH tunnel manually and connect via localhost:
5253
```
5354
ssh SSH_HOST -L 7000:localhost:6379
5455
```
@@ -59,32 +60,30 @@ Follow instructions from [this blog post](https://userify.com/blog/howto-connect
5960
### How to connect to Redis ElastiCache with In-Transit Encryption through EC2
6061
#### Using RedisDesktopManager >=0.9.9
6162

62-
Click on "Enable TLS-over-SSH" in SSH connection settings and follow instructions from section [How to connect to Redis ElastiCache through EC2](#how-to-connect-to-redis-elasticache-through-ec2)
63+
Click on "Enable TLS-over-SSH" in the SSH connection settings and follow instructions from section [How to connect to Redis ElastiCache through EC2](#how-to-connect-to-redis-elasticache-through-ec2)
6364

6465

6566
#### Using RedisDesktopManager <0.9.9
66-
Follow instructions from [this documentation section to setup `stunnel` on EC2 instance](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/in-transit-encryption.html#connect-tls)
67+
Follow instructions from [this documentation section to setup `stunnel` on an EC2 instance](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/in-transit-encryption.html#connect-tls)
6768

68-
After that [connect to your Redis ElastiCache through EC2](#how-to-connect-to-redis-elasticache-through-ec2)
69+
After that [connect to your Redis ElastiCache through EC2](#how-to-connect-to-redis-elasticache-through-ec2).
6970

70-
## Connect to UNIX socket
71+
## Connect to a UNIX socket
7172

72-
Redis Desktop Manager [doesn't support UNIX sockets](https://github.com/uglide/RedisDesktopManager/issues/1751) directly, but you can use redirecting of local socket to the unix domain socket, for instance with [socat](https://sourceforge.net/projects/socat):
73+
Redis Desktop Manager [doesn't support UNIX sockets](https://github.com/uglide/RedisDesktopManager/issues/1751) directly, but you can use redirecting of the local socket to the UNIX domain socket, for instance with [socat](https://sourceforge.net/projects/socat):
7374

7475
```
7576
socat -v tcp-l:6379,reuseaddr,fork unix:/tmp/redis.sock
7677
```
7778

7879
## Advanced connection settings
79-
Use the next tab Advanced settings in order to setup Namespace separator or other settings.
80-
81-
80+
The **Advanced settings** tab allows you to customise the namespace separator and other advanced settings.
8281
<img src="http://redisdesktop.com/static/docs/rdm_advanced_settings.png" height="300" />
8382

8483
## Next steps
85-
Now you can test connection or create connection right away.
84+
Now you can test a connection or create a connection right away.
8685

87-
Congratulations, now you connected to your Redis Server. You should see something similar to what we showed on our screen.
86+
Congratulations, you've successfully connected to your Redis Server. You should see something similar to what we show above.
8887
![](http://redisdesktop.com/static/docs/rdm_main2.png)
8988

9089

0 commit comments

Comments
 (0)