diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..92358f4 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +version: "2" + +build: + os: "ubuntu-22.04" + tools: + python: "3.10" + +python: + install: + - requirements: docs/requirements.txt + +sphinx: + configuration: docs/source/conf.py + +formats: all diff --git a/QuartzMap.png b/QuartzMap.png new file mode 100644 index 0000000..6ade6d6 Binary files /dev/null and b/QuartzMap.png differ diff --git a/README.md b/README.md index ff7b19d..4b6033a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ -# QWC2-Docs +# QuartzMap +![GeoSync](QuartzMap.png) + +## Install +Install software dependencies and setup database, service, etc. + + $ cd qgis2web_app + $ ./installer/postgres.sh + $ ./installer/app-install.sh + + $ ./installer/gui-installer.sh + +Run setup http://10.0.39.2/admin/setup.php and login with admin@admin.com/1234 + +## Links + - [Sidebar Icons](https://pictogrammers.com/library/mdi/) + - [Action Icons](https://fonts.google.com/icons) \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..9534b01 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/qatmaps-small.png b/docs/qatmaps-small.png new file mode 100644 index 0000000..d4a9aac Binary files /dev/null and b/docs/qatmaps-small.png differ diff --git a/docs/qatmaps.png b/docs/qatmaps.png new file mode 100644 index 0000000..b50901c Binary files /dev/null and b/docs/qatmaps.png differ diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..53fc1f3 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx==7.1.2 +sphinx-rtd-theme==1.3.0rc1 diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css new file mode 100644 index 0000000..4340393 --- /dev/null +++ b/docs/source/_static/css/custom.css @@ -0,0 +1,13 @@ +.wy-nav-content { + max-width: 1350px; +} +.wy-side-nav-search { + display: block; + width: 300px; + padding: .809em; + margin-bottom: .809em; + z-index: 200; + background-color: #fff; + text-align: center; + color: #fcfcfc; +} \ No newline at end of file diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css new file mode 100644 index 0000000..0c213d5 --- /dev/null +++ b/docs/source/_static/custom.css @@ -0,0 +1,14 @@ +.wy-nav-content { + max-width: 1350px; +} + +.wy-side-nav-search { + display: block; + width: 300px; + padding: .809em; + margin-bottom: .809em; + z-index: 200; + background-color: #fff; + text-align: center; + color: #fcfcfc; +} \ No newline at end of file diff --git a/docs/source/_static/quartzmap-logo-min.png b/docs/source/_static/quartzmap-logo-min.png new file mode 100644 index 0000000..ec82414 Binary files /dev/null and b/docs/source/_static/quartzmap-logo-min.png differ diff --git a/docs/source/_static/quartzmap-logo.png b/docs/source/_static/quartzmap-logo.png new file mode 100644 index 0000000..5dd0784 Binary files /dev/null and b/docs/source/_static/quartzmap-logo.png differ diff --git a/docs/source/api.rst b/docs/source/api.rst new file mode 100644 index 0000000..ec94338 --- /dev/null +++ b/docs/source/api.rst @@ -0,0 +1,7 @@ +API +=== + +.. autosummary:: + :toctree: generated + + lumache diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..c0fce8e --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,56 @@ +# Configuration file for the Sphinx documentation builder. + +# -- Project information + +project = 'QuartzMap' +copyright = '2024, Cited, Inc.' +author = 'Cited Inc' + +release = '2.1' +version = '0.1.0' + +# -- General configuration + +extensions = [ + 'sphinx.ext.duration', + 'sphinx.ext.doctest', + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.intersphinx', +] + +intersphinx_mapping = { + 'python': ('https://docs.python.org/3/', None), + 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), +} +intersphinx_disabled_domains = ['std'] + +templates_path = ['_templates'] + +# -- Options for HTML output + +html_theme = 'sphinx_rtd_theme' + +# -- Options for EPUB output +epub_show_urls = 'footnote' + + +formats: all + + +html_static_path = ['_static'] + +# These paths are either relative to html_static_path +# or fully qualified paths (eg. https://...) +html_css_files = [ + 'css/custom.css', +] + +pygments_style = "sphinx" + + +html_logo = "quartzmap-logo.png" +html_theme_options = { + 'logo_only': True, + 'display_version': False, +} \ No newline at end of file diff --git a/docs/source/createdb.rst b/docs/source/createdb.rst new file mode 100644 index 0000000..f98e1a1 --- /dev/null +++ b/docs/source/createdb.rst @@ -0,0 +1,44 @@ +Create Database +====================== + +If you do not have an existing PostGIS database, you can create one from your QGIS Project. + + + +1. Export your layer(s) +------------------------ + +Right click on layer > Export > Save As > GeoPackage + + .. image:: images/create-db-1.png + + + +2. Upload GeoPackages +------------------------- + +Go to Data Sources > Create and upload your GeoPackage(s). + + .. image:: images/create-db-2.png + + +3. Set Layers to Data Source +------------------------------- + +Set your map layer(s) to use your new Data Source + + .. image:: images/select-data.png + + +4. Change QGIS Data Source +------------------------------- + +Optionally, you can now also set your QGIS Project to use your new database as well. + +Just right click on the layer(s) > Change Data Source + +Select the PostGIS data source you created above. + + + .. image:: images/create-db-3.png + diff --git a/docs/source/css.rst b/docs/source/css.rst new file mode 100644 index 0000000..9a00ea2 --- /dev/null +++ b/docs/source/css.rst @@ -0,0 +1,50 @@ +CSS +======= + + +Quartz provides CSS overrides at map level. + +To override the default CSS, enter your CSS into the Map CSS box on the map edit page. + + + .. image:: images/CSS.png + + +Example: Image Sizing +-------------------------------- + +To change pop-up image sizing, you can use something like below. + +.. code-block:: css + + .leaflet-popup-content > table img {width: 300px;} + .leaflet-popup-content > img { width: 300px;} + + +Example: Modal Info Box +------------------------------------------ + +To change Modal Info Box, you can use something like below. + +.. code-block:: css + + .modal-content { + position: relative; + display: flex; + flex-direction: column; + width: fit-content; + pointer-events: auto; + background-clip: padding-box; + border-radius: 20px; + outline: 0; + background-color: cadetblue; + color: #fff; + } + + + +There is no need to add "!important" to CSS elements as map.css is loaded last and has precendence. + + + + \ No newline at end of file diff --git a/docs/source/dashboard.rst b/docs/source/dashboard.rst new file mode 100644 index 0000000..b37c4f3 --- /dev/null +++ b/docs/source/dashboard.rst @@ -0,0 +1,12 @@ +Dashboard +===== + +The Dashboard can be accessed by clicking the "Administration" link at top once logged in. + +Usage +------------ + +The Dashboard provides links to services as well as links to Documentation and Support. + + .. image:: images/quartz-dashboard.png + diff --git a/docs/source/extras.rst b/docs/source/extras.rst new file mode 100644 index 0000000..1ffef67 --- /dev/null +++ b/docs/source/extras.rst @@ -0,0 +1,454 @@ +Enable geolocation +================== + +The automatic geolocation provided by Lizmap relies on Google services. To enable it, your webGIS must be placed under a secure protocol, like HTTPS. See for more details: + +https://sites.google.com/a/chromium.org/dev/Home/chromium-security/deprecating-powerful-features-on-insecure-origins + +https://www.digitalocean.com/community/tutorials/how-to-create-a-self-signed-ssl-certificate-for-apache-in-ubuntu-16-04 + +.. _install-data-folder: + +Create directories for data +=========================== + +QGIS files and other cache files will be stored into these directories. + +.. code-block:: bash + + mkdir /home/data + mkdir /home/data/cache/ + +Spatial Database: PostgreSQL +============================ + +.. note:: This section is optional. Please read :ref:`prerequisites-postgresql`. + +PostgreSQL and PostGIS can be very useful to manage spatial data centralized manner on the server. + +Install +------- + + +On Debian 11, you'll find PostgreSQL 13. + +First install packages: + +.. code-block:: bash + + apt install postgresql postgresql-contrib postgis pgtune + + +You may have to recreate the cluster on a fresh install, in order to set the locale. +You can jump this step if the locale is correctly set, or if you already have +databases. Careful: these instructions destroy any existing databases! + +.. code-block:: bash + + service postgresql stop + pg_dropcluster --stop 13 main + pg_createcluster 13 main --locale fr_FR.UTF8 -p 5432 --start + +Now You can create a user and a database for Lizmap, into Postgresql. + + +Adapting the PostgreSQL configuration +------------------------------------- + +We will use ``pgtune``, an utility program that can automatically generate a PostgreSQL configuration file +adapted to the properties of the server (memory, processors, etc.) + +https://pgtune.leopard.in.ua/ + +.. code-block:: bash + + # PostgreSQL Tuning with pgtune + pgtune -i /etc/postgresql/13/main/postgresql.conf -o /etc/postgresql/13/main/postgresql.conf.pgtune --type Web + cp /etc/postgresql/13/main/postgresql.conf /etc/postgresql/13/main/postgresql.conf.backup + cp /etc/postgresql/13/main/postgresql.conf.pgtune /etc/postgresql/13/main/postgresql.conf + nano /etc/postgresql/13/main/postgresql.conf + # Restart to check any problems + service postgresql restart + # If error messages, increase the linux kernel configuration variables + echo "kernel.shmall = 4294967296" >> /etc/sysctl.conf # to increase shred buffer param in kernel + echo "kernel.shmmax = 4294967296" >> /etc/sysctl.conf + echo 4294967296 > /proc/sys/kernel/shmall + echo 4294967296 > /proc/sys/kernel/shmmax + sysctl -a | sort | grep shm + # Restart PostgreSQL + service postgresql restart + +For installing Lizmap tables into the PostgreSQL database (instead of SqLite by default), you can continue until the next section +below when you need to edit the file :file:`lizmap/var/config/profiles.ini.php`. + +Installing sources of Lizmap Web Client +======================================= + +Retrieve the latest available stable version from our `Github release page `_. + +.. warning:: + Do not use the automatic ZIP file created by GitHub on the website. Only use ZIP attached to a release. + +We first set some variable to ease instructions. Let's set the version and +the location where Lizmap will be installed. Adjust these values to your +requirements. + +.. code-block:: bash + + VERSION=3.6.5 + LOCATION=/var/www + +Then you can install the zip file: + +.. code-block:: bash + + cd $LOCATION + wget https://github.com/3liz/lizmap-web-client/releases/download/$VERSION/lizmap-web-client-$VERSION.zip + # Unzip archive + unzip lizmap-web-client-$VERSION.zip + + # virtual link for http://localhost/lizmap/ + ln -s $LOCATION/lizmap-web-client-$VERSION/lizmap/www/ /var/www/html/lizmap + # Remove archive + rm lizmap-web-client-$VERSION.zip + + +Configure Lizmap with the database support +========================================== + +Lizmap needs a database to store its own data and to access to data used in your +Qgis projects, with its editing tool. + +Create :file:`profiles.ini.php` into :file:`lizmap/var/config` by copying :file:`profiles.ini.php.dist`. + +.. code-block:: bash + + cd lizmap/var/config + cp profiles.ini.php.dist profiles.ini.php + cd ../../.. + +PostgreSQL +---------- + +For the editing of PostGIS layers in Web Client Lizmap operate, install PostgreSQL support for PHP. No configuration file need to be edited +to edit PostgreSQL layer. You must **only** check that the Lizmap server can access the database with credentials which are stored in the QGIS project +(or with a PostgreSQL service file). + +.. code-block:: bash + + apt install php7.4-pgsql + service php7.4-fpm restart + +For Lizmap logs, users and groups, it can be either stored in SqLite or PostgreSQL. To store these information in +PostgreSQL, follow these instructions. + +Into a fresh copy of :file:`lizmap/var/config/profiles.ini.php`, you should have: + +.. code-block:: ini + + [jdb:jauth] + driver=sqlite3 + database="var:db/jauth.db" + + [jdb:lizlog] + driver=sqlite3 + database="var:db/logs.db" + +This is the configuration by default to use Sqlite. You should change these +sections to use Postgresql, and indicate several parameters to access to your +Postgresql database: + +.. code-block:: ini + + [jdb:jauth] + driver=pgsql + host=localhost + port=5432 + database="your_database" + user=my_login + password=my_password + search_path=public + + [jdb:lizlog] + driver=pgsql + host=localhost + port=5432 + database="your_database" + user=my_login + password=my_password + search_path=public + + +You can use a specific schema to store lizmap tables. And you may want that lizmap +could access to other schema. You then have to set search_path correctly. Example: + +.. code-block:: ini + + search_path=lizmap,my_schema,public + +If you have setup a service file for postgresql onto your server, you may want to +indicate a postgresql service instead of indicating login, password and so on. +Use then the service parameter: + +.. code-block:: ini + + [jdb:jauth] + driver=pgsql + service=my_service + database="your_database" + search_path=lizmap,public + + [jdb:lizlog] + driver=pgsql + service=my_service + database="your_database" + search_path=lizmap,public + +Spatialite +---------- + +Enable Spatialite extension +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +To use editing on layers spatialite,you have to add the spatialite extension in PHP. You can follow these instructions to do so: +http://www.gaia-gis.it/gaia-sins/spatialite-cookbook-fr/html/php.html + +Lizmap Web Client tests whether the spatialite support is enabled in PHP. If it is not, then spatialite layers will not be used in the editing tool. You can always use PostgreSQL data for editing. + +Give the appropriate rights to the directory containing Spatialite databases +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +So that Lizmap Web Client can modify the data contained in databases Spatialite, we must ensure that **the webserver user (www-data) has well write access to the directory containing each Spatialite file** + +For example, if a directory contains a QGIS project, which uses a Spatialite database placed in a **db** directory at the same level as the QGIS project: + +.. code-block:: bash + + /path/to/a/lizmap_directory + |--- mon_projet.qgs + |--- bdd + |--- my_spatialite_file.sqlite + +So you have to give the rights in this way: + +.. code-block:: bash + + chown :www-data /path/to/a/lizmap_directory -R + chmod 775 /path/to/a/lizmap_directory -R + +.. note:: + So if you want to install Lizmap to provide access to multiple map publishers, you should tell them to + always create a **db** directory at the same level as the QGIS projects in the Lizmap Web Client directory. + This will facilitate the admin work that just have to change the rights of this unique directory. + + + +Configuring Lizmap and launching the installer +================================================ + +Give the appropriate rights to directories and files +-------------------------------------------------------------- + +Set rights for Nginx/Apache, so PHP scripts could write some temporary files or do changes. + +.. code-block:: bash + + cd /var/www/lizmap-web-client-$VERSION/ + lizmap/install/set_rights.sh www-data www-data + + +Setup configuration +------------------- + + +Create :file:`lizmapConfig.ini.php`, :file:`localconfig.ini.php` and edit them +to set parameters specific to your installation. You can modify :file:`lizmapConfig.ini.php` +to set the url of qgis map server and other things. + +.. code-block:: bash + + cd lizmap/var/config + cp lizmapConfig.ini.php.dist lizmapConfig.ini.php + cp localconfig.ini.php.dist localconfig.ini.php + cd ../../.. + +Launching the installer +----------------------- + +After creating configuration files, you can launch the installer + +.. code-block:: bash + + php lizmap/install/installer.php + +It will finished the installation, and will create all SQL tables needed by Lizmap. + +Adding some demonstration projects +---------------------------------- + +If you want to test Lizmap with some demonstration projects, you must install ``unzip`` and either ``wget`` or ``curl``. + +.. code-block:: bash + + lizmap/install/reset.sh --keep-config --demo + +First test +---------- + +For testing launch: ``http://localhost/lizmap`` in your browser. + +In case you get a ``500 - internal server error``, run again: + +.. code-block:: bash + + cd /var/www/lizmap-web-client-$VERSION/ + lizmap/install/set_rights.sh www-data www-data + + +.. note:: Replace ``localhost`` with the address or IP number of your server. + +In the administration panel, you should check the :guilabel:`QGIS server version` and the :guilabel:`WMS server URL` with the URL of QGIS Server. + +.. warning:: + Before trying to have a QGIS project working in Lizmap, you **must** have the communication between QGIS Server and Lizmap Web Client working properly. + Versions about QGIS Server plugins **must** be visible from the administration interface. Please read :ref:`lizmap-server-plugin`. + +If you didn't install the demo, you can check that you have well installed Lizmap and configured QGIS Server within Lizmap by checking the ``qgis_server`` section in this URL: +http://localhost/lizmap/index.php/view/app/metadata + +.. code-block:: json + + { + "qgis_server":{ + "test":"OK", + "mime_type":"text\/xml; charset=utf-8" + } + } + +Lizmap is accessible, without further configurations, also as WMS and WFS server from a browser: + +http://localhost/lizmap/index.php/lizmap/service/?repository=montpellier&project=montpellier&VERSION=1.3.0&SERVICE=WMS&REQUEST=GetCapabilities + +http://localhost/lizmap/index.php/lizmap/service/?repository=montpellier&project=montpellier&SERVICE=WFS&REQUEST=GetCapabilities + +and from QGIS: + +http://localhost/lizmap/index.php/lizmap/service/?repository=montpellier&project=montpellier&VERSION=1.3.0& + +http://localhost/lizmap/index.php/lizmap/service/?repository=montpellier&project=montpellier& + +.. note:: + Access to the WMS and WFS servers can be limited by assigning privileges to specific repositories, see + the administration section. + +Lizmap modules +============== + +Previously, we explained how we could add QGIS Server plugins to add more features to QGIS Server. Now that +we have Lizmap Web Client up and running, we can add some Lizmap modules to add again some features. + +The list is available in the Lizmap :ref:`introduction`. On their GitHub repository, +their is usually their install instructions. You should follow them. However +here are the main instructions to install a module. + + +Installing modules with Composer +-------------------------------- + +You can install modules with Composer, the package manager for +PHP. Of course it is possible only if the author of the module has created +a package of his module. A such package has a name, for example `lizmap/lizmap-pgmetadata-module``. +The documentation of the module should indicate it. + +You must install Composer. See instructions on its web site http://getcomposer.org. + +You must create a :file:`composer.json` file into :file:`lizmap/my-packages/` +by copying the :file:`composer.json.dist` from this directory. And launching +a first time Compose + + +.. code-block:: bash + + cp -n lizmap/my-packages/composer.json.dist lizmap/my-packages/composer.json + composer install --working-dir=lizmap/my-packages + + +Then you can install the package of the module + +.. code-block:: bash + + composer require --working-dir=lizmap/my-packages "lizmap/lizmap-pgmetadata-module" + + +If you want to install a new version of the module, execute: + +.. code-block:: bash + + composer update --working-dir=lizmap/my-packages + +Read the documentation of the module to know if there are additional steps to +configure it. + +You will have at least to launch the configurator of the module with this command: + +.. code-block:: bash + + php lizmap/install/configurator.php name_of_the_module + # example: + php lizmap/install/configurator.php pgmetadata + +To finish the installation, run again the installer of Lizmap: + +.. code-block:: bash + + php lizmap/install/installer.php + lizmap/install/clean_vartmp.sh + lizmap/install/set_rights.sh + + +installing modules without Composer +----------------------------------- + +To install a module without Composer, retrieve the zip file of the module. + +* Extract the module into :file:`lizmap/lizmap-modules/`. For instance, for the module + ``PgMetadata`` : + +.. code-block:: bash + + $ ls -hl lizmap/lizmap-modules/pgmetadata/ + total 44K + drwxrwxr-x 2 etienne etienne 4,0K nov. 17 12:38 classes + drwxrwxr-x 2 etienne etienne 4,0K nov. 4 12:50 controllers + drwxrwxr-x 2 etienne etienne 4,0K nov. 4 10:09 daos + -rw-rw-r-- 1 etienne etienne 146 nov. 4 10:38 events.xml + drwxrwxr-x 2 etienne etienne 4,0K nov. 4 10:09 forms + drwxrwxr-x 2 etienne etienne 4,0K nov. 4 12:50 install + drwxrwxr-x 4 etienne etienne 4,0K nov. 4 10:09 locales + -rw-rw-r-- 1 etienne etienne 789 nov. 19 16:02 module.xml + drwxrwxr-x 2 etienne etienne 4,0K nov. 4 10:09 templates + -rw-rw-r-- 1 etienne etienne 106 nov. 4 10:39 urls.xml + drwxrwxr-x 2 etienne etienne 4,0K nov. 17 12:38 www + + +* Read the documentation of the module to know if there are additional steps to + configure it. + +You will have at least to launch the configurator of the module with this command: + +.. code-block:: bash + + php lizmap/install/configurator.php name_of_the_module + # example: + php lizmap/install/configurator.php pgmetadata + + +* Run the installation : + +.. code-block:: bash + + php lizmap/install/installer.php + lizmap/install/clean_vartmp.sh + lizmap/install/set_rights.sh + + diff --git a/docs/source/frontend.rst b/docs/source/frontend.rst new file mode 100644 index 0000000..acf0df0 --- /dev/null +++ b/docs/source/frontend.rst @@ -0,0 +1,10 @@ +Front End +===== + +The Front End is what End Users see when they log into your map portal. + +They will see only those maps that they have access to. + +Similarly, there is no link (or access) to the Administration section. + + .. image:: images/FrontEnd-App.png diff --git a/docs/source/geoserver.rst b/docs/source/geoserver.rst new file mode 100644 index 0000000..8486a3d --- /dev/null +++ b/docs/source/geoserver.rst @@ -0,0 +1,30 @@ +Connect to GeoServer +====================== + +This section shows how to connect map layer(s) to GeoServer. + + +1. Create or Edit Map +--------------------------- + +Add a new map or edit an existing map. + + .. image:: images/data-source-4.png + + + +2. Set Layer to GeoServer +--------------------------- + +Click layer(s) and set to GeoServer layer you wish to use. + + .. image:: images/geoserver-1.png + + +Click the Update button. + +Your map is now connected to your GeoServer and will update when GeoServer updates. + + + .. image:: images/Quick-Start-Login-22-min.png + diff --git a/docs/source/groups.rst b/docs/source/groups.rst new file mode 100644 index 0000000..75179b2 --- /dev/null +++ b/docs/source/groups.rst @@ -0,0 +1,26 @@ +User Groups +========= + +The User Groups page is used to add and edit User Groups. + +All map permissions are Group based, so End Users you add to a User Group will have access to those map(s) + +Add a Group +------------ + +To create a User Group, click the "Add New" button at top. + + .. image:: images/Access-Groups.png + +Enter a name for the Group and, optionally, select the Users to include in your Group. + + .. image:: images/Access-Groups-Add.png + +Once a User Group is created, you can add, edit, and remove Users via the Users page as well. + + .. image:: images/Access-Groups-Add-2.png + +The Public Group +------------ + +When select, the Public Group will have access to maps without a log in required. diff --git a/docs/source/images/Access-Groups-Add-2.png b/docs/source/images/Access-Groups-Add-2.png new file mode 100644 index 0000000..d7c739a Binary files /dev/null and b/docs/source/images/Access-Groups-Add-2.png differ diff --git a/docs/source/images/Access-Groups-Add.png b/docs/source/images/Access-Groups-Add.png new file mode 100644 index 0000000..faf0ee2 Binary files /dev/null and b/docs/source/images/Access-Groups-Add.png differ diff --git a/docs/source/images/Access-Groups.png b/docs/source/images/Access-Groups.png new file mode 100644 index 0000000..fc21fcb Binary files /dev/null and b/docs/source/images/Access-Groups.png differ diff --git a/docs/source/images/Add-Map.png b/docs/source/images/Add-Map.png new file mode 100644 index 0000000..af50692 Binary files /dev/null and b/docs/source/images/Add-Map.png differ diff --git a/docs/source/images/Add-New-User.png b/docs/source/images/Add-New-User.png new file mode 100644 index 0000000..478e08e Binary files /dev/null and b/docs/source/images/Add-New-User.png differ diff --git a/docs/source/images/CSS.png b/docs/source/images/CSS.png new file mode 100644 index 0000000..7e4fcdd Binary files /dev/null and b/docs/source/images/CSS.png differ diff --git a/docs/source/images/Data-Table.png b/docs/source/images/Data-Table.png new file mode 100644 index 0000000..d2aec26 Binary files /dev/null and b/docs/source/images/Data-Table.png differ diff --git a/docs/source/images/Dynamic-1.png b/docs/source/images/Dynamic-1.png new file mode 100644 index 0000000..a41ea69 Binary files /dev/null and b/docs/source/images/Dynamic-1.png differ diff --git a/docs/source/images/Dynamic-2.png b/docs/source/images/Dynamic-2.png new file mode 100644 index 0000000..e91e4ad Binary files /dev/null and b/docs/source/images/Dynamic-2.png differ diff --git a/docs/source/images/Dynamic-3.png b/docs/source/images/Dynamic-3.png new file mode 100644 index 0000000..fcda83c Binary files /dev/null and b/docs/source/images/Dynamic-3.png differ diff --git a/docs/source/images/Dynamic-4.png b/docs/source/images/Dynamic-4.png new file mode 100644 index 0000000..8debab5 Binary files /dev/null and b/docs/source/images/Dynamic-4.png differ diff --git a/docs/source/images/End-Users.png b/docs/source/images/End-Users.png new file mode 100644 index 0000000..71a1c09 Binary files /dev/null and b/docs/source/images/End-Users.png differ diff --git a/docs/source/images/FTP-Login.png b/docs/source/images/FTP-Login.png new file mode 100644 index 0000000..66bba66 Binary files /dev/null and b/docs/source/images/FTP-Login.png differ diff --git a/docs/source/images/FTP-Username.png b/docs/source/images/FTP-Username.png new file mode 100644 index 0000000..c186771 Binary files /dev/null and b/docs/source/images/FTP-Username.png differ diff --git a/docs/source/images/FTP-qgis2web.png b/docs/source/images/FTP-qgis2web.png new file mode 100644 index 0000000..0465c41 Binary files /dev/null and b/docs/source/images/FTP-qgis2web.png differ diff --git a/docs/source/images/FTP-username-min.png b/docs/source/images/FTP-username-min.png new file mode 100644 index 0000000..dadad74 Binary files /dev/null and b/docs/source/images/FTP-username-min.png differ diff --git a/docs/source/images/First-Map-min.png b/docs/source/images/First-Map-min.png new file mode 100644 index 0000000..0aa6c54 Binary files /dev/null and b/docs/source/images/First-Map-min.png differ diff --git a/docs/source/images/FrontEnd-App.png b/docs/source/images/FrontEnd-App.png new file mode 100644 index 0000000..6f3cc46 Binary files /dev/null and b/docs/source/images/FrontEnd-App.png differ diff --git a/docs/source/images/Info-Box.png b/docs/source/images/Info-Box.png new file mode 100644 index 0000000..cfcf7bf Binary files /dev/null and b/docs/source/images/Info-Box.png differ diff --git a/docs/source/images/Main.png b/docs/source/images/Main.png new file mode 100644 index 0000000..d58af19 Binary files /dev/null and b/docs/source/images/Main.png differ diff --git a/docs/source/images/Map-10-PostGIS.png b/docs/source/images/Map-10-PostGIS.png new file mode 100644 index 0000000..1874cb1 Binary files /dev/null and b/docs/source/images/Map-10-PostGIS.png differ diff --git a/docs/source/images/Map-11.png b/docs/source/images/Map-11.png new file mode 100644 index 0000000..e82bfb7 Binary files /dev/null and b/docs/source/images/Map-11.png differ diff --git a/docs/source/images/Map-12.png b/docs/source/images/Map-12.png new file mode 100644 index 0000000..9633c48 Binary files /dev/null and b/docs/source/images/Map-12.png differ diff --git a/docs/source/images/Map-13-Dashboard.png b/docs/source/images/Map-13-Dashboard.png new file mode 100644 index 0000000..0f1be69 Binary files /dev/null and b/docs/source/images/Map-13-Dashboard.png differ diff --git a/docs/source/images/Map-14-Login.png b/docs/source/images/Map-14-Login.png new file mode 100644 index 0000000..e0515cd Binary files /dev/null and b/docs/source/images/Map-14-Login.png differ diff --git a/docs/source/images/Map-15-View.png b/docs/source/images/Map-15-View.png new file mode 100644 index 0000000..86d4544 Binary files /dev/null and b/docs/source/images/Map-15-View.png differ diff --git a/docs/source/images/Map-2.png b/docs/source/images/Map-2.png new file mode 100644 index 0000000..7bcdd37 Binary files /dev/null and b/docs/source/images/Map-2.png differ diff --git a/docs/source/images/Map-3.png b/docs/source/images/Map-3.png new file mode 100644 index 0000000..dacd23d Binary files /dev/null and b/docs/source/images/Map-3.png differ diff --git a/docs/source/images/Map-4-Data-Table.png b/docs/source/images/Map-4-Data-Table.png new file mode 100644 index 0000000..403aa34 Binary files /dev/null and b/docs/source/images/Map-4-Data-Table.png differ diff --git a/docs/source/images/Map-5-Create.png b/docs/source/images/Map-5-Create.png new file mode 100644 index 0000000..73975f9 Binary files /dev/null and b/docs/source/images/Map-5-Create.png differ diff --git a/docs/source/images/Map-6-Success.png b/docs/source/images/Map-6-Success.png new file mode 100644 index 0000000..fec3d5c Binary files /dev/null and b/docs/source/images/Map-6-Success.png differ diff --git a/docs/source/images/Map-7-Select-Source.png b/docs/source/images/Map-7-Select-Source.png new file mode 100644 index 0000000..1600a01 Binary files /dev/null and b/docs/source/images/Map-7-Select-Source.png differ diff --git a/docs/source/images/Map-8-Select-Type.png b/docs/source/images/Map-8-Select-Type.png new file mode 100644 index 0000000..f488338 Binary files /dev/null and b/docs/source/images/Map-8-Select-Type.png differ diff --git a/docs/source/images/Map-9-PostGIS.png b/docs/source/images/Map-9-PostGIS.png new file mode 100644 index 0000000..b7ef970 Binary files /dev/null and b/docs/source/images/Map-9-PostGIS.png differ diff --git a/docs/source/images/Name-Desc.png b/docs/source/images/Name-Desc.png new file mode 100644 index 0000000..7834ea3 Binary files /dev/null and b/docs/source/images/Name-Desc.png differ diff --git a/docs/source/images/Name.png b/docs/source/images/Name.png new file mode 100644 index 0000000..47fa3b1 Binary files /dev/null and b/docs/source/images/Name.png differ diff --git a/docs/source/images/Permalink-1.png b/docs/source/images/Permalink-1.png new file mode 100644 index 0000000..caa8eda Binary files /dev/null and b/docs/source/images/Permalink-1.png differ diff --git a/docs/source/images/Permalink-4.png b/docs/source/images/Permalink-4.png new file mode 100644 index 0000000..2b8bc2b Binary files /dev/null and b/docs/source/images/Permalink-4.png differ diff --git a/docs/source/images/Permalinks-2.png b/docs/source/images/Permalinks-2.png new file mode 100644 index 0000000..508fa58 Binary files /dev/null and b/docs/source/images/Permalinks-2.png differ diff --git a/docs/source/images/Permalinks-3.png b/docs/source/images/Permalinks-3.png new file mode 100644 index 0000000..5413267 Binary files /dev/null and b/docs/source/images/Permalinks-3.png differ diff --git a/docs/source/images/PostGIS-Add-Connection.png b/docs/source/images/PostGIS-Add-Connection.png new file mode 100644 index 0000000..ea5fdb8 Binary files /dev/null and b/docs/source/images/PostGIS-Add-Connection.png differ diff --git a/docs/source/images/PostGIS-Select-min.png b/docs/source/images/PostGIS-Select-min.png new file mode 100644 index 0000000..0b6c6ee Binary files /dev/null and b/docs/source/images/PostGIS-Select-min.png differ diff --git a/docs/source/images/PostGIS-Select.png b/docs/source/images/PostGIS-Select.png new file mode 100644 index 0000000..ba02c4a Binary files /dev/null and b/docs/source/images/PostGIS-Select.png differ diff --git a/docs/source/images/QGIS-Project-File.png b/docs/source/images/QGIS-Project-File.png new file mode 100644 index 0000000..0eab193 Binary files /dev/null and b/docs/source/images/QGIS-Project-File.png differ diff --git a/docs/source/images/Quartz-Dashboard-Main.png b/docs/source/images/Quartz-Dashboard-Main.png new file mode 100644 index 0000000..445735d Binary files /dev/null and b/docs/source/images/Quartz-Dashboard-Main.png differ diff --git a/docs/source/images/Quick-Start-FTP.png b/docs/source/images/Quick-Start-FTP.png new file mode 100644 index 0000000..17a096c Binary files /dev/null and b/docs/source/images/Quick-Start-FTP.png differ diff --git a/docs/source/images/Quick-Start-Login-10.png b/docs/source/images/Quick-Start-Login-10.png new file mode 100644 index 0000000..e997234 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-10.png differ diff --git a/docs/source/images/Quick-Start-Login-11.png b/docs/source/images/Quick-Start-Login-11.png new file mode 100644 index 0000000..4172168 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-11.png differ diff --git a/docs/source/images/Quick-Start-Login-12.png b/docs/source/images/Quick-Start-Login-12.png new file mode 100644 index 0000000..615bca2 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-12.png differ diff --git a/docs/source/images/Quick-Start-Login-13.png b/docs/source/images/Quick-Start-Login-13.png new file mode 100644 index 0000000..985136a Binary files /dev/null and b/docs/source/images/Quick-Start-Login-13.png differ diff --git a/docs/source/images/Quick-Start-Login-14.png b/docs/source/images/Quick-Start-Login-14.png new file mode 100644 index 0000000..50b67b2 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-14.png differ diff --git a/docs/source/images/Quick-Start-Login-2.png b/docs/source/images/Quick-Start-Login-2.png new file mode 100644 index 0000000..7c98fcd Binary files /dev/null and b/docs/source/images/Quick-Start-Login-2.png differ diff --git a/docs/source/images/Quick-Start-Login-22-min.png b/docs/source/images/Quick-Start-Login-22-min.png new file mode 100644 index 0000000..1f19491 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-22-min.png differ diff --git a/docs/source/images/Quick-Start-Login-22.png b/docs/source/images/Quick-Start-Login-22.png new file mode 100644 index 0000000..4486f87 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-22.png differ diff --git a/docs/source/images/Quick-Start-Login-23.png b/docs/source/images/Quick-Start-Login-23.png new file mode 100644 index 0000000..52925ea Binary files /dev/null and b/docs/source/images/Quick-Start-Login-23.png differ diff --git a/docs/source/images/Quick-Start-Login-24.png b/docs/source/images/Quick-Start-Login-24.png new file mode 100644 index 0000000..58eb488 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-24.png differ diff --git a/docs/source/images/Quick-Start-Login-3.png b/docs/source/images/Quick-Start-Login-3.png new file mode 100644 index 0000000..75be826 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-3.png differ diff --git a/docs/source/images/Quick-Start-Login-4.png b/docs/source/images/Quick-Start-Login-4.png new file mode 100644 index 0000000..63c3339 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-4.png differ diff --git a/docs/source/images/Quick-Start-Login-5.png b/docs/source/images/Quick-Start-Login-5.png new file mode 100644 index 0000000..67172b9 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-5.png differ diff --git a/docs/source/images/Quick-Start-Login-6.png b/docs/source/images/Quick-Start-Login-6.png new file mode 100644 index 0000000..822182b Binary files /dev/null and b/docs/source/images/Quick-Start-Login-6.png differ diff --git a/docs/source/images/Quick-Start-Login-7.png b/docs/source/images/Quick-Start-Login-7.png new file mode 100644 index 0000000..a4820cc Binary files /dev/null and b/docs/source/images/Quick-Start-Login-7.png differ diff --git a/docs/source/images/Quick-Start-Login-8.png b/docs/source/images/Quick-Start-Login-8.png new file mode 100644 index 0000000..5700a05 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-8.png differ diff --git a/docs/source/images/Quick-Start-Login-9.png b/docs/source/images/Quick-Start-Login-9.png new file mode 100644 index 0000000..07415d2 Binary files /dev/null and b/docs/source/images/Quick-Start-Login-9.png differ diff --git a/docs/source/images/Quick-Start-Login.png b/docs/source/images/Quick-Start-Login.png new file mode 100644 index 0000000..91a05b7 Binary files /dev/null and b/docs/source/images/Quick-Start-Login.png differ diff --git a/docs/source/images/Quick-Start-Signup-2.png b/docs/source/images/Quick-Start-Signup-2.png new file mode 100644 index 0000000..0501a19 Binary files /dev/null and b/docs/source/images/Quick-Start-Signup-2.png differ diff --git a/docs/source/images/Quick-Start-Signup-3.png b/docs/source/images/Quick-Start-Signup-3.png new file mode 100644 index 0000000..2c375e2 Binary files /dev/null and b/docs/source/images/Quick-Start-Signup-3.png differ diff --git a/docs/source/images/Quick-Start-Signup-4.png b/docs/source/images/Quick-Start-Signup-4.png new file mode 100644 index 0000000..3722acc Binary files /dev/null and b/docs/source/images/Quick-Start-Signup-4.png differ diff --git a/docs/source/images/Quick-Start-Signup.png b/docs/source/images/Quick-Start-Signup.png new file mode 100644 index 0000000..93aba2a Binary files /dev/null and b/docs/source/images/Quick-Start-Signup.png differ diff --git a/docs/source/images/Quick-Start-Verified-2.png b/docs/source/images/Quick-Start-Verified-2.png new file mode 100644 index 0000000..2a96f88 Binary files /dev/null and b/docs/source/images/Quick-Start-Verified-2.png differ diff --git a/docs/source/images/Quick-Start-Verified.png b/docs/source/images/Quick-Start-Verified.png new file mode 100644 index 0000000..27a3083 Binary files /dev/null and b/docs/source/images/Quick-Start-Verified.png differ diff --git a/docs/source/images/Security-1.png b/docs/source/images/Security-1.png new file mode 100644 index 0000000..cbaee34 Binary files /dev/null and b/docs/source/images/Security-1.png differ diff --git a/docs/source/images/Security-Group.png b/docs/source/images/Security-Group.png new file mode 100644 index 0000000..f978712 Binary files /dev/null and b/docs/source/images/Security-Group.png differ diff --git a/docs/source/images/Set-Security.png b/docs/source/images/Set-Security.png new file mode 100644 index 0000000..7647d44 Binary files /dev/null and b/docs/source/images/Set-Security.png differ diff --git a/docs/source/images/Share-Link.png b/docs/source/images/Share-Link.png new file mode 100644 index 0000000..1c215d7 Binary files /dev/null and b/docs/source/images/Share-Link.png differ diff --git a/docs/source/images/Show-Data-Table.png b/docs/source/images/Show-Data-Table.png new file mode 100644 index 0000000..fe4dab0 Binary files /dev/null and b/docs/source/images/Show-Data-Table.png differ diff --git a/docs/source/images/Thumbnail.png b/docs/source/images/Thumbnail.png new file mode 100644 index 0000000..281d042 Binary files /dev/null and b/docs/source/images/Thumbnail.png differ diff --git a/docs/source/images/admin-1.png b/docs/source/images/admin-1.png new file mode 100644 index 0000000..9db01f7 Binary files /dev/null and b/docs/source/images/admin-1.png differ diff --git a/docs/source/images/admin-11.png b/docs/source/images/admin-11.png new file mode 100644 index 0000000..4adba73 Binary files /dev/null and b/docs/source/images/admin-11.png differ diff --git a/docs/source/images/admin-13.png b/docs/source/images/admin-13.png new file mode 100644 index 0000000..bb999d8 Binary files /dev/null and b/docs/source/images/admin-13.png differ diff --git a/docs/source/images/admin-14.png b/docs/source/images/admin-14.png new file mode 100644 index 0000000..0447659 Binary files /dev/null and b/docs/source/images/admin-14.png differ diff --git a/docs/source/images/admin-15.png b/docs/source/images/admin-15.png new file mode 100644 index 0000000..04db89e Binary files /dev/null and b/docs/source/images/admin-15.png differ diff --git a/docs/source/images/admin-17.png b/docs/source/images/admin-17.png new file mode 100644 index 0000000..709a56d Binary files /dev/null and b/docs/source/images/admin-17.png differ diff --git a/docs/source/images/admin-2.png b/docs/source/images/admin-2.png new file mode 100644 index 0000000..013cc23 Binary files /dev/null and b/docs/source/images/admin-2.png differ diff --git a/docs/source/images/admin-3.png b/docs/source/images/admin-3.png new file mode 100644 index 0000000..c52aaf7 Binary files /dev/null and b/docs/source/images/admin-3.png differ diff --git a/docs/source/images/admin-4.png b/docs/source/images/admin-4.png new file mode 100644 index 0000000..a7d4925 Binary files /dev/null and b/docs/source/images/admin-4.png differ diff --git a/docs/source/images/admin-5.png b/docs/source/images/admin-5.png new file mode 100644 index 0000000..e3d05d2 Binary files /dev/null and b/docs/source/images/admin-5.png differ diff --git a/docs/source/images/admin-6.png b/docs/source/images/admin-6.png new file mode 100644 index 0000000..ea0d5a5 Binary files /dev/null and b/docs/source/images/admin-6.png differ diff --git a/docs/source/images/admin-7.png b/docs/source/images/admin-7.png new file mode 100644 index 0000000..9555db0 Binary files /dev/null and b/docs/source/images/admin-7.png differ diff --git a/docs/source/images/admin-8.png b/docs/source/images/admin-8.png new file mode 100644 index 0000000..5e18b35 Binary files /dev/null and b/docs/source/images/admin-8.png differ diff --git a/docs/source/images/admin-9.png b/docs/source/images/admin-9.png new file mode 100644 index 0000000..1f274f4 Binary files /dev/null and b/docs/source/images/admin-9.png differ diff --git a/docs/source/images/create-db-1.png b/docs/source/images/create-db-1.png new file mode 100644 index 0000000..c07b7f8 Binary files /dev/null and b/docs/source/images/create-db-1.png differ diff --git a/docs/source/images/create-db-2.png b/docs/source/images/create-db-2.png new file mode 100644 index 0000000..8477a20 Binary files /dev/null and b/docs/source/images/create-db-2.png differ diff --git a/docs/source/images/create-db-3.png b/docs/source/images/create-db-3.png new file mode 100644 index 0000000..3910c31 Binary files /dev/null and b/docs/source/images/create-db-3.png differ diff --git a/docs/source/images/data-source-4.png b/docs/source/images/data-source-4.png new file mode 100644 index 0000000..ea7a147 Binary files /dev/null and b/docs/source/images/data-source-4.png differ diff --git a/docs/source/images/ebird.png b/docs/source/images/ebird.png new file mode 100644 index 0000000..6f17b68 Binary files /dev/null and b/docs/source/images/ebird.png differ diff --git a/docs/source/images/geoserver-1.png b/docs/source/images/geoserver-1.png new file mode 100644 index 0000000..abbd5fb Binary files /dev/null and b/docs/source/images/geoserver-1.png differ diff --git a/docs/source/images/geosync-admin.png b/docs/source/images/geosync-admin.png new file mode 100644 index 0000000..f533f92 Binary files /dev/null and b/docs/source/images/geosync-admin.png differ diff --git a/docs/source/images/geosync-service.png b/docs/source/images/geosync-service.png new file mode 100644 index 0000000..ad847ac Binary files /dev/null and b/docs/source/images/geosync-service.png differ diff --git a/docs/source/images/geosync.png b/docs/source/images/geosync.png new file mode 100644 index 0000000..ff2cd86 Binary files /dev/null and b/docs/source/images/geosync.png differ diff --git a/docs/source/images/installer-2.png b/docs/source/images/installer-2.png new file mode 100644 index 0000000..6a547f8 Binary files /dev/null and b/docs/source/images/installer-2.png differ diff --git a/docs/source/images/print-1.png b/docs/source/images/print-1.png new file mode 100644 index 0000000..3fee076 Binary files /dev/null and b/docs/source/images/print-1.png differ diff --git a/docs/source/images/print-2.jpg b/docs/source/images/print-2.jpg new file mode 100644 index 0000000..0f428c2 Binary files /dev/null and b/docs/source/images/print-2.jpg differ diff --git a/docs/source/images/public-map.png b/docs/source/images/public-map.png new file mode 100644 index 0000000..cd6e888 Binary files /dev/null and b/docs/source/images/public-map.png differ diff --git a/docs/source/images/public-users.jpg b/docs/source/images/public-users.jpg new file mode 100644 index 0000000..d402c2b Binary files /dev/null and b/docs/source/images/public-users.jpg differ diff --git a/docs/source/images/quartz-dashboard.png b/docs/source/images/quartz-dashboard.png new file mode 100644 index 0000000..20ca87b Binary files /dev/null and b/docs/source/images/quartz-dashboard.png differ diff --git a/docs/source/images/quartzmap-logo-min.png b/docs/source/images/quartzmap-logo-min.png new file mode 100644 index 0000000..ec82414 Binary files /dev/null and b/docs/source/images/quartzmap-logo-min.png differ diff --git a/docs/source/images/quartzmap-logo.png b/docs/source/images/quartzmap-logo.png new file mode 100644 index 0000000..5dd0784 Binary files /dev/null and b/docs/source/images/quartzmap-logo.png differ diff --git a/docs/source/images/select-data.png b/docs/source/images/select-data.png new file mode 100644 index 0000000..89978b9 Binary files /dev/null and b/docs/source/images/select-data.png differ diff --git a/docs/source/images/sentinel-1.jpg b/docs/source/images/sentinel-1.jpg new file mode 100644 index 0000000..5a3da89 Binary files /dev/null and b/docs/source/images/sentinel-1.jpg differ diff --git a/docs/source/images/sentinel-2.jpg.png b/docs/source/images/sentinel-2.jpg.png new file mode 100644 index 0000000..3f55626 Binary files /dev/null and b/docs/source/images/sentinel-2.jpg.png differ diff --git a/docs/source/images/signup.png b/docs/source/images/signup.png new file mode 100644 index 0000000..803f5ba Binary files /dev/null and b/docs/source/images/signup.png differ diff --git a/docs/source/images/threejs-map-print.jpg b/docs/source/images/threejs-map-print.jpg new file mode 100644 index 0000000..b783d36 Binary files /dev/null and b/docs/source/images/threejs-map-print.jpg differ diff --git a/docs/source/images/threejs-map.jpg b/docs/source/images/threejs-map.jpg new file mode 100644 index 0000000..36b850e Binary files /dev/null and b/docs/source/images/threejs-map.jpg differ diff --git a/docs/source/images/users-2.jpg b/docs/source/images/users-2.jpg new file mode 100644 index 0000000..38fc388 Binary files /dev/null and b/docs/source/images/users-2.jpg differ diff --git a/docs/source/images/users-3.jpg b/docs/source/images/users-3.jpg new file mode 100644 index 0000000..0adf464 Binary files /dev/null and b/docs/source/images/users-3.jpg differ diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..95209a4 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,33 @@ +QuartzMap +=================================== + +**QuartzMap** transforms your qgis2web maps into secure, dynamic maps. + + .. image:: images/admin-2.png + + + +Contents +-------- + +.. toctree:: + + intro + quickstart + quick-dynamic + geoserver + createdb + dashboard + users + groups + maps + css + pdf + permalinks + sentinel + qgis2threejs + frontend + + + + diff --git a/docs/source/intro.rst b/docs/source/intro.rst new file mode 100644 index 0000000..1167916 --- /dev/null +++ b/docs/source/intro.rst @@ -0,0 +1,29 @@ +Introduction +===== + + .. image:: images/admin-2.png + + +Overview +------------ + +QuartzMap transforms your qgis2web maps into secure, dynamic maps. + + +QuartzMap transforms your qgis2web maps into secure, dynamic maps. + +Your maps are secured via your portal and can be connected to their original PostGIS or GeoServer data source, so your maps are updated when your data is updated. No need to republish your maps. + + + .. image:: images/Quick-Start-Login-22.png + + +Authors +------------ + +QuartzMap is from AcuGIS and produced by Cited, Inc. + +qgis2web is an indepedent project. + +Learn more about qgis2web at https://github.com/qgis2web/qgis2web + diff --git a/docs/source/maps.rst b/docs/source/maps.rst new file mode 100644 index 0000000..52b41c3 --- /dev/null +++ b/docs/source/maps.rst @@ -0,0 +1,134 @@ +Maps +===== + +The Maps page allows you to create and edit Maps. + +Create Map +------------ + +To create a Map, click on "Add New" button. + + .. image:: images/Add-Map.png + + +There are two options for creating a Map. + +Option 1: FTP Uploads. +~~~~~~~~~~~~~~~~~~~~~ + +FTP Uploads are qgis2web maps you have uploaded directly via FTP. + +It can also maps you uploaded via any FTP client. + + .. image:: images/Map-2.png + + +Option 2: Archive +~~~~~~~~~~~~~~ + +Archive is a zipped archive file you can upload. + + + .. image:: images/Map-3.png + + + +Map Options +-------------- + +Below are the options availble for each map. + + +Name +-------------- + +Give your map a name. The name will appear as the map title on the dashboard. + +.. image:: images/Name-Desc.png + + +Description +-------------- + +The Description is the text that will appear at the bottom of the map link + +.. image:: images/Name.png + + + +Data +-------------- + +The Data section is where you can connect your map layers to their Data Sources to make them dynamic. + +.. image:: images/PostGIS-Select.png + + +QGIS Project File: +-------------- + +You can upload your QGIS Project file in order to use WMS, WFS, and WMTS + +.. image:: images/QGIS-Project-File.png + +Map CSS: +-------------- + +Enter any custom CSS for your map that wish to. + +.. image:: images/CSS.png + +Thumbnail Image: +-------------- + +Upload a thumbnail image for your map to be displayed on the home page. + +.. image:: images/Thumbnail.png + +Data Tables: +-------------- + +Check the "Show Data Tables" box in order to provide users with data in table format. + +.. image:: images/Show-Data-Table.png + + +Info Box. +-------------- + +The InfoBox is a modal information box you can display to map users. + +.. image:: images/Info-Box.png + + +Security +-------------- + +Maps can be Private or Public. + +The Security section is where you assign permissions to your map. + +Security is Group based, so any users belonging to the Group will be able to view the map. + +.. image:: images/users-3.jpg + +1. Private Maps + +Private maps can be viewed by the user logging into your map portal or via Secure Share link (for temporary access) + +For example, since we gave access to the Group containing user Jane Doe, when she logs in she will see only the two maps she has permissions to + +.. image:: images/users-2.jpg + +2. Public Maps + +You can also tick the “Public” box to make your map public. + +.. image:: images/public-users.jpg + +If your map is “Public”, you can use the map url to display the map. + +By default, the map is full screen. You can also use an iframe like below: + +.. image:: images/public-map.png + diff --git a/docs/source/pdf.rst b/docs/source/pdf.rst new file mode 100644 index 0000000..21c46eb --- /dev/null +++ b/docs/source/pdf.rst @@ -0,0 +1,35 @@ +PDF Printing +========= + +QuartzMap provides two options for PDF printing. + +1. Browser Print +2. QGIS Print Layout + +Browser Print. +------------ + +Browser Print is enabled by default and appears in the left control section. + + .. image:: images/print-1.png + +QGIS Print Layout +------------ + +To enable Print Layouts, you must upload your QGIS Project (Map > Edit > Upload Project). + +Select the Print Layout you wish to use from the drop down + +When an area is selected on the map, users will have the option of generating a PDF, GeoPDF, or PNG + + .. image:: images/print-2.jpg + +Simply click the appropriate option to download in that format + + + .. note:: + GeoPDF option can take a long time to generate with larger data sets. + + + + diff --git a/docs/source/permalinks.rst b/docs/source/permalinks.rst new file mode 100644 index 0000000..1147b29 --- /dev/null +++ b/docs/source/permalinks.rst @@ -0,0 +1,23 @@ +Permalinks +===== + +.. _installation: + +Usage +------------ + +To get a secure Share link, click the Share icon on the map: + + .. image:: images/Permalink-1.png + +Copy the url + + .. image:: images/Permalink-4.png + +.. note:: + By default, links are good for one day and one use. + +To change this for your link, go to Permalinks + + .. image:: images/Permalinks-3.png + diff --git a/docs/source/profile.rst b/docs/source/profile.rst new file mode 100644 index 0000000..0e430d4 --- /dev/null +++ b/docs/source/profile.rst @@ -0,0 +1,25 @@ +Profile +===== + +The Profile page allows you to edit your profile. + + +Manage Profile +---------------- + +To edit your Profile, click Profile on the left menu. + + .. image:: images/admin-13.png + +Name: The display name for the user. + +Email: The user email (used for log in) + +Password: The user password + + + + + + + diff --git a/docs/source/qgis2threejs.rst b/docs/source/qgis2threejs.rst new file mode 100644 index 0000000..44f2816 --- /dev/null +++ b/docs/source/qgis2threejs.rst @@ -0,0 +1,34 @@ +qgis2threejs +===== + +QuartzMap supports publishing of qgis2threejs as well as qgis2web. Currently, dynamic data sources are not supported. + +To publish your qgis2threejs maps, simply FTP or upload as you would with qgis2web. + + .. image:: images/threejs-map-print.jpg + +QuartzMap adds PDF Print functionality, as shown below. + + .. image:: images/threejs-map.jpg + +To publsih your qgis2threejs maps, follow below: + +Publishing +------------ + +1. In QGIS, open the Project you wish to publish and start qgis2threejs + +2. Export your map to a location on your desktop as normal + +3. FTP the map using FTP or use the "Upload" function to upload. + +4. Go to Maps > Add New + +Give your map a name and description. + +Select the qgis2threejs map you wish to publish. + +Your qgis2threejs map is now published + + .. image:: images/threejs-map-print.jpg + \ No newline at end of file diff --git a/docs/source/quartz.css b/docs/source/quartz.css new file mode 100644 index 0000000..20431fb --- /dev/null +++ b/docs/source/quartz.css @@ -0,0 +1,3 @@ +.wy-nav-content { + max-width: 90%; +} \ No newline at end of file diff --git a/docs/source/quartzmap-logo.png b/docs/source/quartzmap-logo.png new file mode 100644 index 0000000..5dd0784 Binary files /dev/null and b/docs/source/quartzmap-logo.png differ diff --git a/docs/source/quick-dynamic.rst b/docs/source/quick-dynamic.rst new file mode 100644 index 0000000..aab3230 --- /dev/null +++ b/docs/source/quick-dynamic.rst @@ -0,0 +1,56 @@ + +Connect to PostGIS +====================== + +This section is a Quick Start to connecting your published maps to their original Data Source to make them dynamic. + +You can connect to a PostGIS Data Source or GeoServer Data Source. + +1. Go to Connections +--------------------------- + +On the Connections page, enter the connection details for your PostGIS or Server connection(s) + + .. image:: images/PostGIS-Add-Connection.png + + + +2. Go to Maps and click the edit link +--------------------------- + + .. image:: images/Dynamic-1.png + + +3. In Data section click on layer +--------------------------- + + .. image:: images/Dynamic-2.png + + +4. Select Connection, Schema, and Table +--------------------------- + + + .. image:: images/PostGIS-Select.png + + +.. note:: + Optionally, you can set Caching for each layer. Cache can be cleared via the Clear Cache link on the Map page or by disabling Cache. + + +Click the Update button. + +That's it! +~~~~~~~~~~~~~ + +Your map is now connected to your original Data Source and is fully dynamic. + + +.. image:: images/Quick-Start-Login-22.png + + +To test, try editing or udpating some data + + +.. image:: images/Quick-Start-Login-23.png + diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst new file mode 100644 index 0000000..db7c922 --- /dev/null +++ b/docs/source/quickstart.rst @@ -0,0 +1,78 @@ + +Quick Start +===== + +1. Register for a free account. +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + .. image:: images/Quick-Start-Signup.png + + +2. Check your email for a verification link +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + .. image:: images/Quick-Start-Signup-4.png + + +3. Click the link to verify and log in +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +.. note:: + Your FTP username is displayed on the Users page. Your FTP password is your login password. + + + .. image:: images/FTP-username-min.png + + + +4. In QGIS, open the Project you wish to publish and start qgis2web +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + +Enter your FTP information: + + .. image:: images/FTP-qgis2web.png + + +.. note:: + The name you enter in the 'Remote folder' field will be created for you. Use your map name or something similar for easy organization. + + +5. Go to Maps > Add New +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Give your map a name and description. + +Select the map you wish to publish. + + .. image:: images/Quick-Start-Login-10.png + +There are a large number of features and options, but for now, just go scroll down to Security and select the existing User Group + + .. image:: images/Quick-Start-Login-12.png + +Click Create +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +ON the home page, click the link to your new map: + + .. image:: images/Quick-Start-Login-14.png + + +Voila! Your map has been published! +~~~~~~~~~~~~~~~~~~~~~~~~~~ + + .. image:: images/Main.png + + + + + +Next: Make Your Maps Dynamic +------------ + +Connecting to Data Sources. + + + diff --git a/docs/source/sentinel.rst b/docs/source/sentinel.rst new file mode 100644 index 0000000..9eefa95 --- /dev/null +++ b/docs/source/sentinel.rst @@ -0,0 +1,24 @@ +Sentinel Hub +===== + +QuartzMap supports dates, date ranges, and date comparison for Sentinel Hub. + +You can use either the Sentinel Hub QGIS plugin or standard WMS. + +Publish your map as normal: + +1. In QGIS, open the Project you wish to publish and start qgis2web + +2. FTP the map using FTP or use the "Upload" function to upload. + + .. image:: images/sentinel-1.jpg + +QuartzMap will detect the date and range and use the start/end as default. + +Users can then select data comparisons to view. + +You can also limit the range via the Map setting as shown below + + .. image:: images/sentinel-2.jpg.png + +You can also enable proxy of your Sentinel Hub url to protect the url. \ No newline at end of file diff --git a/docs/source/source/_static/my.css b/docs/source/source/_static/my.css new file mode 100644 index 0000000..20431fb --- /dev/null +++ b/docs/source/source/_static/my.css @@ -0,0 +1,3 @@ +.wy-nav-content { + max-width: 90%; +} \ No newline at end of file diff --git a/docs/source/usage.rst b/docs/source/usage.rst new file mode 100644 index 0000000..924afcf --- /dev/null +++ b/docs/source/usage.rst @@ -0,0 +1,34 @@ +Usage +===== + +.. _installation: + +Installation +------------ + +To use Lumache, first install it using pip: + +.. code-block:: console + + (.venv) $ pip install lumache + +Creating recipes +---------------- + +To retrieve a list of random ingredients, +you can use the ``lumache.get_random_ingredients()`` function: + +.. autofunction:: lumache.get_random_ingredients + +The ``kind`` parameter should be either ``"meat"``, ``"fish"``, +or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients` +will raise an exception. + +.. autoexception:: lumache.InvalidKindError + +For example: + +>>> import lumache +>>> lumache.get_random_ingredients() +['shells', 'gorgonzola', 'parsley'] + diff --git a/docs/source/users.rst b/docs/source/users.rst new file mode 100644 index 0000000..33445b3 --- /dev/null +++ b/docs/source/users.rst @@ -0,0 +1,39 @@ +Users +===== + +.. _installation: + +User Roles +------------ + +Users can have one of two Roles: Admin or User + +Admins can publish maps. Users (End Users) can view maps which Admins give them access to. + +The Community Edition is limited to a single Admin. The Commercial Edition allows unlimited Admins. + +Both Editions allow unlimited End Users. + + +Add User +---------------- + +You can add, edit, and delete users via the Users page. + + .. image:: images/Add-New-User.png + + +Users created via the Users page are automatically activated and do not required email verification. + + +For Commercial Edition, you can also enable Self Registration: + + + .. image:: images/signup.png + + +Users will receive a verification links via email. + + + + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..b84be89 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,8 @@ +[build-system] +requires = ["flit_core >=3.2,<4"] +build-backend = "flit_core.buildapi" + +[project] +name = "QWC2-Docs" +authors = [{name = "AcuGIS", email = "hello@citedcorp.com"}] +dynamic = ["version", "description"]