Merge pull request #29 from geoCML/4.0-docs

Update documentation for geoCML 4.0

Author: TristanDamron

topics/geocml-desktop.adoc

@@ -2,7 +2,7 @@
 
 image::geoCML-Desktop-Logo.png["geoCML Desktop Logo", 250, 250]
 
-geoCML Desktop is the primary access point for your geoCML deployment. geoCML Desktop provides you with a desktop environment allowing you to prepare, visualize, and analyze your GIS data. The geocml-desktop container is based on Ubuntu Linux and comes installed with the XPRA, allowing you to view running applications in a web browser. geoCML Desktop comes preinstalled with https://www.qgis.org/en/site/[QGIS], a best-in-class open-source desktop GIS application. geoCML Desktop is password protected. You must set a password within your deployment's `.env` file.
+geoCML Desktop is the primary access point for your geoCML deployment. geoCML Desktop provides you with a desktop environment allowing you to prepare, visualize, and analyze your GIS data. The geocml-desktop container is based on Ubuntu Linux and comes installed with the XPRA, allowing you to view running applications in a web browser. geoCML Desktop comes preinstalled with https://www.qgis.org/en/site/[QGIS], a best-in-class open-source 
 
 === Connecting to geoCML Desktop
 

topics/geocml-postgres.adoc

@@ -23,18 +23,6 @@ geoCML Postgres creates a database named geocml_db, which is the primary datasto
 - via geoCML Desktop and QGIS (over the internal geocml-network)
 - via a PostgreSQL data explorer (over port {deployment host URL}:5432)
 
-The default credentials for accessing your database are:
-
-- Username: geocml
-- Password: geocml
-
-geoCML Postgres also configures an admin user for your data store. The default credentials for accessing your data store as an admin are:
-
-- Username: postgres
-- Password: admin
-
-You can change the default password for both the geocml and postgres users in your deployment's `.env` file. Note that these are build-time arguments; you must rebuild your containers to commit these changes.
-
 === Current limitations of the geoCML Postgres service
 
 In geoCML v0.3.0, there are known limitations with the geoCML Postgres service. Currently, geoCML Postgres does not support the following data:

topics/geocml-server.adoc

@@ -37,3 +37,12 @@ geoCML Server Portal features:
 
 geoCML Server exposes all API functionality for QGIS Server via cfcgi and Apache. Learn more about QGIS Server here: https://docs.qgis.org/3.34/en/docs/server_manual/index.html
 
+
+=== Quantitative Analysis Using Dashboards
+
+geoCML Server Portal allows you to create custom dashboards, allowing you to perform quantitative analysis on your GIS data.
+
+The following dashboard widgets are currently supported:
+- Raw Counts
+- Bar Chart
+- Pie Chart

topics/index.adoc

@@ -4,7 +4,7 @@
 
 ifndef::imagesdir[:imagesdir: ./img/]
 
-= geoCML v0.3.1 Documentation
+= geoCML v4.0 Documentation
 
 include::introduction.adoc[]
 

topics/introduction.adoc

@@ -28,32 +28,21 @@ geoCML is currently limited in the following areas:
 - Integration with ArcGIS proprietary deployments and extensions
 - Database version management
 - Backup domain values in a database
-- Support for storing raster data in geocml-postgres
 - MySQL support, SQL Server support, etc (base deployments only support PostgreSQL/PostGIS)
 
 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.
+Before instantiating a geoCML deployment, you must have git (https://git-scm.com/downloads), 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.
 
-. 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.
+- In your favorite terminal, run the following command: `sh <(curl https://raw.githubusercontent.com/geocml/geocml-base-deployment/main/install.sh)`
+- Follow the on-screen prompts to configure and deploy a geoCML instance to your machine.
 
 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.
-
-Please keep in mind that the GEOCML_DESKTOP_PASSWORD variable in the `.env` file must be set to access your deployment via geoCML Desktop.
-