Skip to content

Commit b619b4c

Browse files
authored
Update README.md
1 parent eb186d5 commit b619b4c

1 file changed

Lines changed: 77 additions & 51 deletions

File tree

README.md

Lines changed: 77 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,83 @@ DistributedATS is a [**FIX Protocol-based**](https://www.fixtrading.org) alterna
1414
![N|Solid](https://raw.githubusercontent.com/mkipnis/DistributedATS/master/docs/Diagrams/CryptoCLOB.png?raw=true)
1515
[See: CryptoCLOB](https://github.com/mkipnis/DistributedATS/tree/master/MiscATS/CryptoCLOB)
1616

17+
### Examples
18+
#### Crypto CLOB/ATS – three matching engines, each handling a subset of instruments.
19+
* Users: CRYPTO_TRADER_1, CRYPTO_TRADER_2, CRYPTO_TRADER_3, CRYPTO_TRADER_4 : Password: TEST
20+
* http://localhost:8080/
21+
```
22+
services:
23+
fast_dds_discovery:
24+
container_name: fast_dds_discovery
25+
image: ghcr.io/mkipnis/distributed_ats:latest
26+
command: >
27+
bash -c "LD_LIBRARY_PATH=/usr/local/lib /usr/local/bin/fastdds discovery -q 51000"
28+
ports:
29+
- "51000:51000"
30+
31+
distributed_ats:
32+
container_name: distributed_ats
33+
image: ghcr.io/mkipnis/dats_crypto_clob:latest
34+
depends_on:
35+
- fast_dds_discovery
36+
command: >
37+
bash -c "cd /usr/local && source ./dats_env.sh && cd MiscATS && BASEDIR_ATS=`pwd`/CryptoCLOB python3 start_ats.py --ats CryptoCLOB/crypto_ats.json"
38+
volumes:
39+
- ./logs_ats:/usr/local/MiscATS/CryptoCLOB/logs
40+
ports: # FIX Gateways
41+
- "15001:15001"
42+
- "16001:16001"
43+
- "17001:17001"
44+
45+
distributed_ats_webtrader:
46+
container_name: distributed_ats_webtrader
47+
image: ghcr.io/mkipnis/distributed_ats_webtrader:latest
48+
depends_on:
49+
- distributed_ats
50+
volumes:
51+
- ./webtrader_logs:/usr/local/tomcat/logs
52+
ports:
53+
- "8080:8080"
54+
```
55+
56+
#### US Treasuries CLOB/ATS – one matching engine that handles hundreds of instruments.
57+
* Users: UST_TRADER_1, UST_TRADER_2, UST_TRADER_3, UST_TRADER_4 : Password: TEST
58+
* http://localhost:8080/
59+
```
60+
services:
61+
fast_dds_discovery:
62+
container_name: discovery_service
63+
image: ghcr.io/mkipnis/distributed_ats:latest
64+
command: >
65+
bash -c "LD_LIBRARY_PATH=/usr/local/lib /usr/local/bin/fastdds discovery -q 51000"
66+
ports:
67+
- "51000:51000"
68+
69+
distributed_ats:
70+
container_name: distributed_ats
71+
image: ghcr.io/mkipnis/dats_ust_clob:latest
72+
depends_on:
73+
- fast_dds_discovery
74+
command: >
75+
bash -c "cd /usr/local && source ./dats_env.sh && cd MiscATS && BASEDIR_ATS=`pwd`/USTreasuryCLOB python3 start_ats.py --ats USTreasuryCLOB/ust_ats.json"
76+
volumes:
77+
- ./logs_ats:/usr/local/MiscATS/USTreasuryCLOB/logs
78+
ports: # FIX Gateways
79+
- "15001:15001"
80+
- "16001:16001"
81+
82+
# WebTrader Front-End
83+
distributed_ats_webtrader:
84+
container_name: distributed_ats_webtrader
85+
image: ghcr.io/mkipnis/distributed_ats_webtrader:latest
86+
depends_on:
87+
- distributed_ats
88+
volumes:
89+
- ./webtrader_logs:/usr/local/tomcat/logs
90+
ports:
91+
- "8080:8080"
92+
```
93+
1794
### Dependencies
1895

1996
|Dependency|Component|
@@ -71,54 +148,3 @@ DistributedATS is a [**FIX Protocol-based**](https://www.fixtrading.org) alterna
71148
### Autogeneration of IDL from QuickFIX XML
72149
[GenTools](https://github.com/mkipnis/DistributedATS/tree/master/GenTools) is a utility that generates DDS IDL, FIX to IDL, and IDL to FIX adapters and IDL logger helper classes from QuickFIX's XML data dictionary.
73150

74-
### Building Distributed ATS and its dependencies
75-
76-
To download and build all necessary dependencies, use the provided script:
77-
78-
[download_deps_and_build_all.sh](https://github.com/mkipnis/DistributedATS/blob/master/download_deps_and_build_all.sh)
79-
80-
To build the base Docker image:
81-
82-
[Docker.Build_Distributed_ATS](https://github.com/mkipnis/DistributedATS/blob/master/docker/Docker.Build_Distributed_ATS)
83-
84-
85-
## Basic ATS Examples
86-
### Crypto Central Limit Order Book
87-
- Docker Image: [Docker.Crypto_CLOB](https://github.com/mkipnis/DistributedATS/blob/master/docker/Docker.Crypto_CLOB)
88-
- Docker Compose: [docker-compose-crypto.yml](https://github.com/mkipnis/DistributedATS/blob/master/docker/docker-compose-crypto.yml)
89-
```
90-
sudo docker-compose -f docker-compose-crypto.yml up -d
91-
```
92-
Upon starting the dockerized instance, open in the browser:
93-
* http://localhost:8080
94-
95-
#####
96-
Users:
97-
- CRYPTO_TRADER_1
98-
- CRYPTO_TRADER_2
99-
- CRYPTO_TRADER_3
100-
- CRYPTO_TRADER_4
101-
102-
Password:
103-
- TEST
104-
#####
105-
106-
### US Treasuries Central Limit Order Book
107-
108-
- Docker Image: [Docker.UST_CLOB](https://github.com/mkipnis/DistributedATS/blob/master/docker/Docker.UST_CLOB)
109-
- Docker Compose: [docker-compose-ust.yml](https://github.com/mkipnis/DistributedATS/blob/master/docker/docker-compose-ust.yml)
110-
```
111-
sudo docker-compose -f docker-compose-ust.yml up -d
112-
```
113-
Upon starting the dockerized instance, open in the browser:
114-
* http://localhost:8080
115-
#####
116-
Users:
117-
- UST_TRADER_1
118-
- UST_TRADER_2
119-
- UST_TRADER_3
120-
- UST_TRADER_4
121-
122-
Password:
123-
- TEST
124-
######

0 commit comments

Comments
 (0)