Skip to content

move "Quick deployment guide" to its own section #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions topics/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ ifndef::imagesdir[:imagesdir: ./img/]

include::introduction.adoc[]

include::quick-deployment-guide.adoc[]

include::geocml-desktop.adoc[]

include::geocml-postgres.adoc[]
Expand Down
18 changes: 0 additions & 18 deletions topics/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,24 +33,6 @@ geoCML is currently limited in the following areas:

geoCML base deployments are customizable to fit your specific needs. You can customize your services however you'd like! If you would like to contribute to the development of geoCML, you can find the project on GitHub at https://github.com/geocml[github.com/geocml].

=== Quick deployment guide

_Get up and running with geoCML in under 15 minutes!_

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.

Before instantiating a geoCML deployment, you must have https://www.docker.com/[Docker] and https://docs.docker.com/compose/install/[Docker Compose] 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.

. Clone the geoCML source code from https://github.com/geocml/geocml-base-deployment[github.com/geocml/geocml-base-deployment]
. Open a terminal and cd into the source code directory
. Copy `.env.example` into a new file called `.env`
. Update your `.env` to include your deployment specific configuration variables
. Run `sh build.sh` to build geoCML service images on your machine.
. Run `docker network create geocml-network`
. Run `sh start.sh` to bring up the instance.

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.

=== Using hosted geoCML images from GHCR

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.
Expand Down
18 changes: 18 additions & 0 deletions topics/quick-deployment-guide.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
== Quick deployment guide

_Get up and running with geoCML in under 15 minutes!_

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.

Before instantiating a geoCML deployment, you must have https://www.docker.com/[Docker] and https://docs.docker.com/compose/install/[Docker Compose] 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.

. Clone the geoCML source code from https://github.com/geocml/geocml-base-deployment[github.com/geocml/geocml-base-deployment]
. Open a terminal and cd into the source code directory
. Copy `.env.example` into a new file called `.env`
. Update your `.env` to include your deployment specific configuration variables
. Run `sh build.sh` to build geoCML service images on your machine.
. Run `docker network create geocml-network`
. Run `sh start.sh` to bring up the instance.

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.