Commit e8a85ee5 authored by Patrik Meijer's avatar Patrik Meijer
Browse files

Update README

parent c493207e

README.md

+7 −4
Original line number Diff line number Diff line
@@ -44,11 +44,11 @@ These are addressde in the [docker-compose.yml in the examples folder](/examples 
### TL;DR

Back-end services:

```

docker run --rm --name caid -p 3000:3000 -p 5150:5150 -p 8888:8888 git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-tools:latest

docker run -d --name caid -p 3000:3000 -p 5150:5150 -p 8888:8888 git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-tools:latest

```

Front-end services:

```

docker run --rm --name caid-fe -p 4000:4000 --network="host" git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-front-end:latest

docker run -d --name caid-fe -p 4000:4000 --network="host" git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-front-end:latest

```

Visit `http://localhost:4000` from your browser.
@@ -60,8 +60,11 @@ The fasted way to get started is to use the monolithic docker image, `caid-tools 
### Back-end Services

Start the back-end services first using the monolithic docker-image based on the `Dockerfile` here in this directory.

```

docker run --rm --name caid -p 3000:3000 -p 5150:5150 -p 8888:8888 git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-tools:latest

docker run -d --name caid -p 3000:3000 -p 5150:5150 -p 8888:8888 git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-tools:latest

```



(To stop and restart the service `docker stop caid` and `docker start caid` respectively.)



The following services are running within the monolithic caid-tools container (see `examples/docker-compose.yml` for a more realistic deployment setup with individual containers for the different services).



- **depi-server** is the main server that tracks resources across different tools. In the monolithic Docker container, it persists the state in JSON files, which does not necessarily scale well. For non-demo purposes, the depi-server also supports [Dolt DB](https://github.com/dolthub/dolt) as a persistent layer.
@@ -82,7 +85,7 @@ For the client user interface, you can either [install vscode](https://code.visu 
#### Theia based image

Then the theia IDE with the extensions.

```

docker run --rm --name caid-fe -p 4000:4000 --network="host" git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-front-end:latest

docker run -d --name caid-fe -p 4000:4000 --network="host" git.isis.vanderbilt.edu:5050/aa-caid/caid-tools/caid-front-end:latest

```



Once up and running go to: [http://localhost:4000](http://localhost:4000) using your browser (tested with Chrome).