Skip to content

Commit 7624de5

Browse files
committed
main README update
1 parent 50a027d commit 7624de5

File tree

1 file changed

+28
-12
lines changed

1 file changed

+28
-12
lines changed

README.md

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -64,47 +64,63 @@ changed-data events from heterogeneous data platforms to multi-model [Redis Ente
6464

6565
### Download
6666

67-
Download [latest release](https://github.com/redis-field-engineering/redis-connect-dist/releases) and untar redis-connect-`<version>.<build>`.tar.gz archive<br>
68-
<b>[ [🐳 Hub](https://hub.docker.com/r/redislabs/redis-connect)
69-
]
70-
</b>
67+
Download [latest release](https://github.com/redis-field-engineering/redis-connect-dist/releases) for `Linux` or `Windows` operating system and unarchive redis-connect-`<version>.<build>`.[tar.gz|zip] archive<br>
68+
Docker image can be found at [DockerHub](https://hub.docker.com/r/redislabs/redis-connect)
7169

70+
Linux:
7271
```bash
7372
tar vxf <tarfile name>
7473
```
74+
Windows:
75+
```cmd
76+
unzip <zipfile name>
77+
```
7578

7679
The following subdirectories will be extracted under /redis-connect -
77-
<br>/bin – Startup scripts
78-
<br>/lib – Dependencies
79-
<br>/config – Credentials property files, jobmanager.properties, and job-config (JSON) examples
80-
<br>/extlib – Custom/External dependencies e.g. [custom stage](https://github.com/redis-field-engineering/redis-connect-custom-stage-demo), source-database drivers, etc.
80+
<br>bin – Startup scripts
81+
<br>lib – Dependencies
82+
<br>config – Credentials property files, jobmanager.properties, and job-config (JSON) examples
83+
<br>extlib – Custom/External dependencies e.g. [custom stage](https://github.com/redis-field-engineering/redis-connect-custom-stage-demo), source-database drivers, etc.
8184

8285
### Getting Started
8386

8487
**Review options by running Redis Connect startup script** <br>
88+
Linux:
8589
```bash
8690
redis-connect/bin$ ./redisconnect.sh
8791
-------------------------------
8892
Redis Connect startup script.
8993
*******************************
90-
Please ensure that the value of REDISCONNECT_JOB_MANAGER_CONFIG_PATH points to the correct jobmanager.properties in redisconnect.conf before executing any of the options below
94+
Please ensure that the value of REDISCONNECT_JOB_MANAGER_CONFIG_PATH points to the correct jobmanager.properties in /home/viragtripathi/qa/vm/redis-connect/bin/redisconnect.conf before executing any of the options below
95+
Check the value of redis.connection.url and credentials.file.path in jobmanager.properties e.g.
96+
redis.connection.url=redis://redis-19836.c9.us-east-1-2.ec2.cloud.redislabs.com:19836
97+
credentials.file.path=/var/secrets/redis
9198
*******************************
9299
Usage: [-h|cli|start]
93100
options:
94101
-h: Print this help message and exit.
95-
cli: starts redis-connect-cli
96-
start: init Redis Connect Instance
102+
cli: init Redis Connect CLI
103+
start: init Redis Connect Instance (Cluster Member)
97104
-------------------------------
98105
```
106+
Windows:
107+
```cmd
108+
redis-connect\bin> redisconnect.bat
109+
```
99110

100111
| Prerequisite Configuration :exclamation: |
101112
|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
102113
| Update `credentials.file.path` and `redis.connection.url` within `/config/jobmanager.properties`<br/> Example - <a href="/examples/postgres/demo/config/jobmanager.properties">jobmanager.properties</a> |
103114

104-
**Start Redis Connect Instance**
115+
**Start Redis Connect Instance**<br>
116+
Linux:
105117
```bash
106118
redis-connect/bin$ ./redisconnect.sh start
107119
```
120+
Windows:
121+
```cmd
122+
redis-connect\bin> redisconnect.bat start
123+
```
108124
<img src="/images/Redis Connect Start Log.png" style="float: right;" width = 700px height = 250px/>
109125

110126
**Open browser to access Swagger UI -** [http://localhost:8282/swagger-ui/index.html]()

0 commit comments

Comments
 (0)