Skip to content

Commit d38555a

Browse files
Update README.md
1 parent 3db638f commit d38555a

File tree

1 file changed

+25
-15
lines changed

1 file changed

+25
-15
lines changed

README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,35 @@
22

33
## Introduction
44

5-
This repository hosts a base geoCML deployment. A base geoCML deployment consists of the following microservices:
6-
- geocml-desktop (the user entry point for your deployment)
7-
- geocml-postgres
8-
- geocml-server
9-
- geocml-task-scheduler
5+
This repository hosts a base geoCML deployment. A base geoCML deployment consists of the following micro-services:
6+
- geocml-desktop (the primary user entry point for your deployment)
7+
- geocml-postgres (the primary data store for your deployment)
8+
- geocml-server (the secondary user entry point for your deployment)
9+
- geocml-task-scheduler (an automation service)
1010

11-
Each microservice in this deployment can communicate over an internal network called geocml-network. Each microservice can be customized to fit the needs of your use case.
11+
Each micro-service in this deployment can communicate over an internal network called geocml-network. Each micro-service can be customized to fit the needs of your use case.
1212

13-
## How to Use this Repo
13+
## Quick Deployment Guide
1414

15-
1. Clone this repo, giving the new repo a descriptive name for the workspace image to be created
16-
1. Run `docker-compose pull` to download the image or run `docker-compose build` to build the workspace image
17-
1. Run `docker network create geocml-network` to initialize the internal network that geoCML microservices will use to communicate with each other
15+
_Get up and running with geoCML in under 15 minutes!_
1816

19-
## Using the image locally
17+
geoCML deployments are multi-paradigm, offering a desktop, server, and web GIS experience with a single deployment. You may host your geoCML instance locally or in the cloud, depending on your needs.
2018

21-
Once built, the image can be run locally using docker-compose.
19+
Before instantiating a geoCML deployment, you must have Docker (https://www.docker.com/) and Docker Compose (https://docs.docker.com/compose/install/) installed on the machine you want to host geoCML on. You do not need any additional GIS software installed on the host machine. Once you have satisfied these conditions, please follow the following steps to deploy your geoCML instance.
2220

23-
- **Starting the image locally:** Run `docker-compose up -d`
24-
- **Stopping the image locally:** Run `docker-compose down`
21+
- Clone the geoCML source code from this repository
22+
- Open a terminal and cd into the source code directory
23+
- Copy `.env.example` into a new file called `.env`
24+
- Update your `.env` to include your deployment specific configuration variables
25+
- Run `sh build.sh` to build geoCML service images on your machine
26+
- Run `docker network create geocml-network`
27+
- Run `sh start.sh` to bring up the instance
28+
29+
That's it! You can access geoCML Desktop via {deployment host URL}:10000 or geoCML Server Portal via {deployment host URL}:80 using a web browser. Further configuration steps for each of these services are discussed in later topics.
30+
31+
### Using hosted geoCML images from GHCR
32+
33+
The geoCML development team hosts pre-built containers at our container registry on Github. These containers are a great way to demo geoCML, but please note that these services are _not production ready_, because they lack the required build arguments. If you want to use geoCML in production, please build your containers.
34+
35+
Please keep in mind that the GEOCML_DESKTOP_PASSWORD variable in the `.env` file must be set to access your deployment via geoCML Desktop.
2536

26-
When running locally, the geoCML Desktop can be accessed via at web browser at localhost:10000, geoCML Server can be accessed via a web browser at localhost:80

0 commit comments

Comments
 (0)