-
Notifications
You must be signed in to change notification settings - Fork 38
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add Geonode Apps to Cartoview apps launcher * Docker build locally (#231) * Use separate environment file for postgis docker image * Build image locally * Use geonode docker build steps * Update cherrypy to fix can't parse server.socket_host * Add missing docker environment variables * Update docs to 1.33.0 (#232) * Update Cartoview version to 1.33.0 in docs * Update windows installer docs * Update install app image in docs * Add troubleshooting section for the installer in docs * Update docker installation to 1.33.0 in docs * Fix old URL for apps page * Bump to 1.33.0 final * Fix what is missing in docs due to merge Co-authored-by: Ahmed Nour Eldeen <[email protected]>
- Loading branch information
1 parent
df0d798
commit 1f2c65a
Showing
36 changed files
with
218 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
__version__ = (1, 33, 0, 'unstable', 0) | ||
__version__ = (1, 33, 0, 'final', 0) | ||
__compatible_with__ = [] | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+229 KB
(290%)
docs/img/installation/Installer/admin-configuration-1.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+457 KB
(310%)
docs/img/installation/Installer/admin-configuration-2.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+4.34 KB
(140%)
docs/img/installation/Installer/db-mode.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+2.88 KB
(130%)
docs/img/installation/Installer/domain-ip.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+2.39 KB
(120%)
docs/img/installation/Installer/installation-location.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+2.82 KB
(130%)
docs/img/installation/Installer/installing.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified
BIN
+3.61 KB
(130%)
docs/img/installation/Installer/server-details.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ | |
## Introduction | ||
Cartoview has a Windows installer that gives you an up and running instance, having Cartoview, GeoNode, GeoServer, and PostgreSQL (PostGIS) installed on the fly. | ||
|
||
This guide describes the steps of installing and running Cartoview installer **v1.31.0**. | ||
This guide describes the steps of installing and running Cartoview installer **v1.33.0**. | ||
|
||
--- | ||
|
||
|
@@ -15,17 +15,31 @@ The installer can be requested and downloaded from [here](https://cartoview.net/ | |
|
||
You just need to provide your information, select a version of Cartoview to download, and you should get an e-mail with the installer download link. | ||
|
||
!!! note | ||
It's recommended to stick with the latest version which is selected by default. | ||
|
||
Download the installer on your Windows machine. You should get an executable file like that, **Cartoview_1.31.0.exe**. | ||
Download the installer on your Windows machine. You should get an executable file like that, **Cartoview_1.33.0.exe**. | ||
|
||
### Installer Steps | ||
Proceed with the steps to install and run Cartoview. | ||
|
||
!!! note | ||
It's optional whether to stick with the default configurations during this installation or make changes according to your needs. | ||
|
||
Specify whether to use the database with **Express** mode which installs and runs PostgreSQL on the fly or **Advanced** mode which uses an already running instance of PostgreSQL on your machine. | ||
|
||
!!! note | ||
If you select the **Advanced** mode, you will be required to provide the installation directory of PostgreSQL on your machine, the credentials and databases names. | ||
|
||
![Current running PostgreSQL directory](../img/installation/Installer/postgres-dir.png "Current running PostgreSQL directory") | ||
|
||
![Current running PostgreSQL credentials](../img/installation/Installer/postgres-credentials.png "Current running PostgreSQL credentials") | ||
|
||
![Cartoview Web Database](../img/installation/Installer/web-db.png "Cartoview Web Database") | ||
|
||
![Cartoview GIS Database](../img/installation/Installer/gis-db.png "Cartoview GIS Database") | ||
|
||
We will stick with **Express** mode. | ||
|
||
![DB Mode](../img/installation/Installer/db-mode.png "DB Mode") | ||
|
||
Specify whether you want to use a **domain name** (e.g. localhost, example.com) or an **IP** (e.g. 192.168.10.1). We will stick with the default **domain name** to run on localhost. | ||
|
||
![Domain or IP](../img/installation/Installer/domain-ip.png "Domain or IP") | ||
|
@@ -41,14 +55,6 @@ PostgreSQL Port: Database port. | |
|
||
![Server Details](../img/installation/Installer/server-details.png "Server Details") | ||
|
||
Specify whether to use the database with **Express** mode which installs and runs PostgreSQL on the fly or **Advanced** mode which uses a running instance of PostgreSQL. | ||
|
||
If you select the **Advanced** mode, you will be required to provide the installation directory of PostgreSQL on your machine, the database server credentials (e.g. domain, port, username, and password) and databases names. | ||
|
||
We will stick with **Express** mode. | ||
|
||
![DB Mode](../img/installation/Installer/db-mode.png "DB Mode") | ||
|
||
Select location of installation on your machine. | ||
|
||
![Installation Location](../img/installation/Installer/installation-location.png "Installation Location") | ||
|
@@ -78,13 +84,19 @@ And the [Admin](http://localhost:4040/docs/admin.html) page. | |
|
||
Congratulations! Cartoview is now installed successfully. | ||
|
||
You can upload layers, create maps, and install Cartoview apps to visualize and interact with these maps. | ||
You can upload layers, create maps, and interact with the pre-installed Cartoview apps to visualize these maps. | ||
|
||
### Cartoview Apps | ||
|
||
Once Cartoview is installed, You can navigate to the [apps](http://localhost:4040/cv_apps/) page and explore the available pre-installed apps. | ||
|
||
![Cartoview Apps](../img/installation/Installer/apps.png "Cartoview Apps") | ||
|
||
### Install Apps | ||
|
||
Once Cartoview is installed, You can navigate to [http://localhost:4040/apps/](http://localhost:4040/apps/) to check and install all available apps from the [App Store](https://appstore.cartoview.net/). | ||
Once Cartoview is installed, You can navigate to the [Manage Apps](http://localhost:4040/cv_apps/manage/) to check and install all available apps from the [App Store](https://appstore.cartoview.net/). | ||
|
||
After installing any app, you may need to restart the running **Apache Windows service** if you can't see your app in `/apps`. | ||
After installing any app, you may need to restart the running **Apache Windows service** if you can't see your app in the apps page. | ||
|
||
![Services](../img/installation/Installer/services.png "Services") | ||
|
||
|
@@ -102,14 +114,42 @@ For more information regarding Cartoview & GeoNode theming, please follow [this | |
|
||
### Quick Links | ||
|
||
![Admin Configuration](../img/installation/Installer/admin-configuration-1.png "Quick Links") | ||
![Admin Configuration](../img/installation/Installer/admin.png "Quick Links") | ||
|
||
### Admin Configuration | ||
|
||
You can find at the [Admin Configuration](http://localhost:4040/docs/docs.html) page the details of each installed service (e.g. Default credentials, Windows service name, and installed version). | ||
|
||
![Admin Configuration](../img/installation/Installer/admin-configuration-2.png "Installed Services") | ||
![Admin Configuration](../img/installation/Installer/admin-configuration-1.png "Installed Services") | ||
|
||
And a guide about how to publish Cartoview on a Windows server. | ||
|
||
![Publish Cartoview on Windows server](../img/installation/Installer/admin-configuration-3.png "Publish Cartoview on Windows server") | ||
![Publish Cartoview on Windows server](../img/installation/Installer/admin-configuration-2.png "Publish Cartoview on Windows server") | ||
|
||
--- | ||
|
||
## Troubleshooting | ||
|
||
Sometimes, the installation of Cartoview Windows installer may fail due to different reasons. Here we will try to cover the potential errors and how to troubleshoot them. | ||
|
||
If you got an error like for instance, the site `http://localhost:4040/` can't be reached or failed to upload data to Cartoview or any other kind of errors, you will need to check the logs of Cartoview Windows services as the installer consists of three services, **Apache**, **PostgreSQL**, and **Tomcat**. | ||
|
||
![Cartoview Services](../img/installation/Installer/cartoview-services.png "Cartoview Services") | ||
|
||
These services must appear as **running** as shown above. If you find one that is not, you can try to start again. | ||
|
||
Right-click on a service and select start to start it again. | ||
|
||
![Restart Service](../img/installation/Installer/restart-service.png "Restart Service") | ||
|
||
Each service has its own log file and usually these logs should contain useful information for developers to acknowledge the current issue and may provide a fix. | ||
|
||
You can find each log file in the following directories. | ||
|
||
- **Apache**: `Cartoview/Apache24/logs/error.log` | ||
- **Tomcat**: `Cartoview/Tomcat 9.0/logs/catalina.out` | ||
|
||
!!! note | ||
PostgreSQL doesn't have a log file by default. to enable it please check the PostgreSQL guide on [how to register event log on Windows](https://www.postgresql.org/docs/13/event-log-registration.html). | ||
|
||
If you got an error that you can't fix it on your own, please send the log files with a clear description about what happened exactly to [[email protected]](mailto:[email protected]). |
Oops, something went wrong.