NextGIS

https://docs.nextgis.com
Admin
NextGIS is a comprehensive suite of Geographic Information System (GIS) products, providing...
Tokens:98,291
Snippets:495
Trust Score:9.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run uWSGI Server for NextGIS Web

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Starts the uWSGI server using the provided configuration file (`config/uwsgi.ini`). This makes NextGIS Web accessible via HTTP, typically at `http://localhost:8080/`, and is a common way to run NextGIS Web in a production environment.

```Bash
uwsgi --ini config/uwsgi.ini
```

--------------------------------

### Manage NextGIS Web Systemd Services and Timers

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

These shell commands are used to apply the systemd configurations. `daemon-reload` reloads the systemd manager configuration. `enable` ensures the services and timers start automatically on boot, and `start` immediately activates them.

```Shell
# systemctl daemon-reload
# systemctl enable ngw.service ngw-maintenance.timer
# systemctl start ngw.service ngw-maintenance.timer
```

--------------------------------

### Install debugpy on Linux using apt

Source: https://docs.nextgis.com/docs_ngqgis/source/devtools

This command installs the python3-debugpy package on Debian/Ubuntu-based Linux systems using the apt package manager. This library is a required dependency for QGIS DevTools to function as a debugger.

```Shell
apt get install python3-debugpy
```

--------------------------------

### Install Node.js Dependencies and Build NextGIS Web Frontend

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Initializes the Node.js and Yarn project environment for NextGIS Web, installs necessary JavaScript dependencies, and then builds the frontend assets. This step prepares the web interface for the application.

```Bash
nextgisweb jsrealm install
$ mkdir dist
$ yarn run build
```

--------------------------------

### Run Built-in NextGIS Web HTTP Server

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Starts the built-in HTTP server for NextGIS Web, allowing access to the application via a web browser, typically at `http://localhost:8080`. This server is suitable for initial testing and verification but not for production use.

```Bash
nextgisweb server
```

--------------------------------

### Clone NextGIS Web Git Repository

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Creates a 'package' directory, changes into it, and then clones the NextGIS Web source code from its GitHub repository. This step fetches the application's core files, which are necessary for installation.

```Bash
mkdir package
$ cd package
$ git clone https://github.com/nextgis/nextgisweb.git
```

--------------------------------

### Switch to NextGIS Web User and Navigate to Home Directory

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Switches the current user to 'ngw' and then navigates to its home directory ('/srv/ngw'). This prepares the environment for subsequent installation steps, ensuring commands are executed under the correct user context.

```Bash
su ngw
$ cd
```

--------------------------------

### Install and Configure PostgreSQL/PostGIS for NextGIS Web

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

This snippet provides commands to install PostgreSQL, PostGIS, and related extensions on Ubuntu Linux 20.04. It then creates a dedicated PostgreSQL role and database for NextGIS Web, enabling necessary extensions like PostGIS and hstore, and assigning ownership of spatial tables.

```Shell
# apt install postgresql postgresql-contrib postgis
# su postgres -c psql
postgres=# CREATE ROLE nextgisweb LOGIN PASSWORD 'changeme';
postgres=# CREATE DATABASE nextgisweb OWNER nextgisweb
postgres-# ENCODING 'UTF-8' LC_COLLATE 'C.UTF-8' LC_CTYPE 'C.UTF-8';
postgres=# \connect nextgisweb
nextgisweb=# CREATE EXTENSION postgis;
nextgisweb=# ALTER TABLE spatial_ref_sys OWNER TO nextgisweb;
nextgisweb=# ALTER TABLE geography_columns OWNER TO nextgisweb;
nextgisweb=# ALTER TABLE geometry_columns OWNER TO nextgisweb;
nextgisweb=# CREATE EXTENSION hstore;
nextgisweb=# \quit
```

--------------------------------

### uWSGI Configuration for NextGIS Web (uwsgi.ini)

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Configures uWSGI to serve the NextGIS Web application. It specifies the HTTP binding, number of processes, thread enabling, and sets the `NEXTGISWEB_CONFIG` environment variable for the application. This setup is typical for production deployments.

```INI
[uwsgi]
http = 0.0.0.0:8080
master = true
processes = 4
lazy-apps = true
enable-threads = true
paste = config:%p
env = NEXTGISWEB_CONFIG=%d/config.ini

[app:main]
use = egg:nextgisweb
```

--------------------------------

### Persist Virtual Environment Activation and Config Path in .bashrc

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Adds commands to the `.bashrc` file for the 'ngw' user to automatically activate the Python virtual environment and set the `NEXTGISWEB_CONFIG` environment variable upon shell login. This simplifies future sessions by automating environment setup.

```Bash
echo ". ~/env/bin/activate" >> ~/.bashrc
$ echo "export NEXTGISWEB_CONFIG=~/config/config.ini" >> ~/.bashrc
```

--------------------------------

### Example HTTP Request and Response for Full Track Points

Source: https://docs.nextgis.com/tracker_hub_dev/source/main

Illustrates an example HTTP GET request to the /tracker/tracks/full endpoint, showing how to query for specific device IDs within a given time frame. The example includes the full HTTP request and a sample JSON response containing track data.

```HTTP
GET /tracker/tracks/full?devices_id=14,23&date_time_from=2019-04-01T10:00:00.000Z&date_time_to=2019-04-01T15:00:00.000Z HTTP/1.1
Host: demo.nextgis.com
Accept: */*

{
    "14": [
        [
            {
                "lat": 52.08881305,
                "h": 146,
                "lon": 23.70545869,
                "packet": {
                    "c": null,
                    "sat_gp": 11,
                    "did": 14,
                    "s": 0,
                    "t": "2019-04-01T13:05:57+00:00",
                    "sat_gl": null
                }
            },
            {
                "lat": 52.08897581,
                "h": 169,
                "lon": 23.70549827,
                "packet": {
                    "c": null,
                    "sat_gp": 16,
                    "did": 14,
                    "s": 0,
                    "t": "2019-04-01T13:05:59+00:00",
                    "sat_gl": null
                }
            },
            {
                "lat": 52.08914306,
                "h": 194,
                "lon": 23.70550141,
                "packet": {
                    "c": null,
                    "sat_gp": 16,
                    "did": 14,
                    "s": 0,
                    "t": "2019-04-01T13:06:01+00:00",
                    "sat_gl": null
                }
            }
        ],
        [
            {
                "lat": 52.09637467,
                "h": 162,
                "lon": 23.74533841,
                "packet": {
                    "c": null,
                    "sat_gp": 13,
                    "did": 14,
                    "s": 0,
                    "t": "2019-04-01T17:27:01+00:00",
                    "sat_gl": null
                }
            },
            {
                "lat": 52.09631452,
                "h": 160,
                "lon": 23.7454654,
                "packet": {
                    "c": null,
                    "sat_gp": 16,
                    "did": 14,
                    "s": 3.7439998626708983,
                    "t": "2019-04-01T17:28:07+00:00",
                    "sat_gl": null
                }
            },
            {
                "lat": 52.09634283,
                "h": 162,
                "lon": 23.74561459,
                "packet": {
                    "c": null,
                    "sat_gp": 18,
                    "did": 14,
                    "s": 3.312000060081482,
                    "t": "2019-04-01T17:28:33+00:00",
                    "sat_gl": null
                }
            }
        ]
    ],
    "23": []
}
```

--------------------------------

### Start PostgreSQL Service and Create Database Dump

Source: https://docs.nextgis.com/docs_ngwdocker/doc/deployment

This sequence of commands starts only the PostgreSQL service and then creates a database dump. This dump is critical for restoring data after the PostgreSQL cluster has been recreated.

```bash
$ docker-compose up -d postgres
$ docker-compose exec postgres bin/postgres-dump
```

--------------------------------

### Initialize NextGIS Web Database Structure

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Executes the command to initialize the database schema required by NextGIS Web. This step creates all necessary tables and structures in the configured database, preparing it for application data.

```Bash
nextgisweb initialize_db
```

--------------------------------

### Start NextGIS Web Docker Containers

Source: https://docs.nextgis.com/docs_ngwdocker/doc/deployment

Command to pull Docker images, create, and start the NextGIS Web containers in detached mode using Docker Compose, bringing the application online.

```bash
docker-compose up -d
```

--------------------------------

### Install NextGIS Web Python Package in Editable Mode and Compile Translations

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Sets an environment variable for setuptools, then installs the NextGIS Web Python package into the virtual environment in editable mode. This allows for local development and ensures the application's Python dependencies are met. It also compiles internationalization (i18n) translations.

```Bash
export SETUPTOOLS_ENABLE_FEATURES=legacy-editable
$ pip install -e nextgisweb/
$ nextgisweb-i18n -p nextgisweb compile
```

--------------------------------

### Create Dedicated User for NextGIS Web Installation

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Creates a new system user 'ngw' with a dedicated home directory '/srv/ngw' and bash shell. This is recommended for NextGIS Web installation to isolate its environment and permissions from other system users.

```Bash
useradd --create-home --home-dir /srv/ngw --shell /bin/bash ngw
```

--------------------------------

### Install NextGIS Web System Dependencies (Debian/Ubuntu)

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Installs essential system packages required for NextGIS Web, including curl, git, Node.js, Yarn, Python, build tools, GDAL, PostgreSQL client, and image libraries on Debian/Ubuntu based systems. This ensures all underlying system requirements are met before application installation.

```Bash
apt install curl git
curl --silent https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | apt-key add -
add-apt-repository --yes --no-update "deb https://deb.nodesource.com/node_20.x nodistro main"
curl --silent https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add -
add-apt-repository --yes --no-update "deb https://dl.yarnpkg.com/debian/ stable main"
apt update
apt install python3 python3-dev python3-virtualenv
apt install build-essential libssl-dev libgdal-dev libgeos-dev \
  gdal-bin libxml2-dev libxslt1-dev zlib1g-dev libjpeg-turbo8-dev \
  postgresql-client libmagic-dev nodejs yarn
```

--------------------------------

### Install uWSGI WSGI Server

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Installs the uWSGI WSGI server into the Python virtual environment. uWSGI is a production-ready application server commonly used with NextGIS Web for robust deployment.

```Bash
pip install uwsgi
```

--------------------------------

### Checkout Latest Stable Version of NextGIS Web

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Navigates into the cloned 'nextgisweb' directory and checks out the latest tagged stable version of the application. This is recommended for production environments to ensure stability, as the 'master' branch is for development. It also verifies the checked out tag.

```Bash
cd nextgisweb
$ git checkout $(git tag -l '*.*.*' | tail -1)
$ git describe --tags
4.3.2
$ cd ..
```

--------------------------------

### Verify Docker Installation

Source: https://docs.nextgis.com/docs_ngwdocker/doc/development/install

This snippet runs the `hello-world` Docker image to verify that Docker is correctly installed and configured on the system. A successful output, including 'Hello from Docker!', confirms Docker's basic functionality and connectivity.

```Shell
docker run hello-world
```

--------------------------------

### Start All NextGIS Docker Services

Source: https://docs.nextgis.com/docs_ngwdocker/doc/deployment

This command is used to start all defined services in the 'docker-compose.yaml' file in detached mode. It's typically executed after configuration changes, upgrades, or when bringing the entire NextGIS stack online.

```bash
$ docker-compose up -d
```

--------------------------------

### Stop Services and Start PostgreSQL for PostGIS Upgrade

Source: https://docs.nextgis.com/docs_ngwdocker/doc/deployment

To prepare for a PostGIS upgrade, all NextGIS services must first be stopped. Subsequently, only the PostgreSQL service is started, providing an isolated environment for the PostGIS upgrade process.

```bash
$ docker-compose down
$ docker-compose up -d postgres
```

--------------------------------

### Example Output of NextGIS Web Configuration Template

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/configure

This snippet provides an example of the output generated by the `nextgisweb-config` command. It shows a template for the `file_upload` component, including commented-out options with their default values, which can be uncommented and modified for configuration.

```ini
### Component 'file_upload'
[file_upload]

## Option: path (text)
; path =

## Option: max_size (size_in_bytes) (default: 8G)
; max_size = 8G

## Option: chunk_size (size_in_bytes) (default: 16M)
```

--------------------------------

### Create NextGIS Web Configuration and Data Directories

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Navigates back to the user's home directory and creates 'config' and 'data' directories. These directories will store application configuration files and user-generated data, respectively, organizing the application's persistent files.

```Bash
cd
$ mkdir config data
```

--------------------------------

### Install ngwdocker in Editable Virtual Environment for Development

Source: https://docs.nextgis.com/docs_ngwdocker/doc/development/install

This method is specifically for development purposes, allowing `ngwdocker` to be installed in 'editable' mode within a virtual environment. It starts by cloning the repository, then sets up and activates a virtual environment, and finally installs the package in editable mode using `pip install -e ./`.

```Shell
git clone git@github.com:nextgis/ngwdocker.git
cd ngwdocker
python3 -m venv env
. env/bin/activate
pip install -e ./
```

--------------------------------

### Install and Uninstall Database Tables for NextGIS Web Components

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/internal/migration

Provides NextGIS Web CLI commands to create database tables for a newly defined component and to drop tables for an existing component, managing component schema lifecycle.

```Shell
$ nextgisweb migration install --no-dry-run bar
```

```Shell
$ nextgisweb migration uninstall --no-dry-run bar
```

--------------------------------

### Implement Forward and Rewind Database Migrations with SQL

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/internal/migration

Provides examples of SQL code placed in forward (.fw.sql) and rewind (.rw.sql) migration files to add and drop columns respectively, including required metadata headers.

```SQL
/*** {
    "revision": "2c12ca17", "parents": ["00000000"],
    "date": "2021-01-09T21:57:55",
    "message": "Add other column"
} ***/

ALTER TABLE foo_model ADD COLUMN other text;
```

```SQL
/*** { "revision": "2c12ca17" } ***/

ALTER TABLE foo_model DROP COLUMN other;
```

--------------------------------

### Configure NextGIS Web Main Service with Systemd

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

This systemd unit file defines the main service for NextGIS Web. It specifies the working directory, the uWSGI command to execute, and the user/group under which the service runs. The service is configured to restart on failure and requires network availability.

```Systemd Unit File
[Unit]
Requires=network.target
After=network.target

[Service]
WorkingDirectory=/srv/ngw
ExecStart=/srv/ngw/env/bin/uwsgi --ini config/uwsgi.ini
User=ngw
Group=ngw
Restart=on-failure
KillSignal=SIGQUIT
Type=notify
NotifyAccess=all

[Install]
WantedBy=multi-user.target
```

--------------------------------

### Retrieve NextGIS Web Configuration Template via CLI

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/configure

These command-line examples demonstrate how to use the `nextgisweb-config` utility to obtain configuration templates. Users can request templates for specific sections like `environment` or `sentry`, or retrieve all available configuration options.

```bash
$ nextgisweb-config environment  # For environment section
$ nextgisweb-config sentry       # For sentry component
$ nextgisweb-config              # All available options
```

--------------------------------

### Generate and Run NextGIS Web Docker Containers

Source: https://docs.nextgis.com/docs_ngwdocker/doc/development/install

This sequence of commands uses `ngwdocker` to generate Docker configuration files, then `docker-compose build` to build the container images, and finally `docker-compose up app` to start the main application container. This process brings up the NextGIS Web application, making it accessible.

```Shell
ngwdocker
docker-compose build
docker-compose up app
```

--------------------------------

### Restore PostgreSQL Dump and Start Remaining Services

Source: https://docs.nextgis.com/docs_ngwdocker/doc/deployment

After recreating the PostgreSQL cluster and restarting the service, this command restores the previously created database dump. Following the restore, the rest of the NextGIS Docker stack is brought online.

```bash
$ docker-compose exec postgres bin/postgres-restore
$ docker-compose up -d
```

--------------------------------

### Create and Activate Python Virtual Environment for NextGIS Web

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Initializes a Python 3 virtual environment named 'env' within the 'ngw' user's home directory and activates it. This step isolates NextGIS Web's Python dependencies from the system-wide Python installation, preventing conflicts.

```Bash
virtualenv -p /usr/bin/python3 env
$ . env/bin/activate
```

--------------------------------

### NextGIS Web Core Configuration (config.ini)

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/install

Defines the core configuration for NextGIS Web in `config.ini`. This includes essential settings for database connection (host, name, user, password) and the file system storage directory for application data. An optional setting for default locale is also shown.

```INI
[core]

# Database connection settings
database.host = [database host]
database.name = [database name]
database.user = [database user]
database.password = [database password]

# File system storage settings
sdir = /srv/ngw/data

# To use Russian translation by default uncomment following line
# locale.default = ru
```

--------------------------------

### Set up NextGIS GeoServices Directory and Download Configuration

Source: https://docs.nextgis.com/docs_geoserv_prem/source/admin

This snippet outlines the initial steps for deploying NextGIS GeoServices, including creating the `/srv/geoservices` directory, navigating into it, and downloading/unpacking the Docker Compose configuration template from the official NextGIS on-premise server.

```bash
mkdir /srv/geoservices
cd /srv/geoservices
wget https://nextgis.com/onpremise/geoservices/docker-compose-2.18.0.tar.bz2
tar jxf docker-compose-2.18.0.tar.bz2
```

--------------------------------

### Example Request: Get TMS Geo Services with EPSG 3857

Source: https://docs.nextgis.com/qms_srv_dev/doc/api

Illustrates a sample HTTP GET request to retrieve TMS type geo services with EPSG code 3857, limited to 15 results starting from offset 0. This request targets the qms.nextgis.com host.

```HTTP
GET /api/v1/geoservices/?type=tms&epsg=3857&limit=15&offset=0 HTTP/1.1
Host: qms.nextgis.com
Accept: */*
```

--------------------------------

### Install Git on MacOS using Brew

Source: https://docs.nextgis.com/docs_ngwdocker/doc/development/install

This command installs the Git version control system on macOS using the Homebrew package manager. It is recommended for ensuring a modern version of Git is available for NextGIS Web Docker development.

```Shell
$ brew install git
```

--------------------------------

### Example HTTP Request for QML Style

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/misc

An example HTTP GET request demonstrating how to retrieve a QML style for resource ID 56 from the NextGIS Web server.

```HTTP
GET /api/resource/56/qml HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Example HTTP Request for CSV File

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/misc

An example HTTP GET request demonstrating how to retrieve a CSV file for resource ID 55 from the NextGIS Web server.

```HTTP
GET /api/resource/55/csv HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Specify NextGIS Web Configuration Files via Environment Variable or CLI

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/configure

These examples illustrate how to direct NextGIS Web to specific configuration files. Configuration paths can be set using the `NEXTGISWEB_CONFIG` environment variable or by providing the `--config` command-line option, which takes precedence. Multiple configuration files can be specified, separated by a colon, and are merged during loading, with the last file having higher priority.

```bash
# NEXTGISWEB_CONFIG environment variable
$ export NEXTGISWEB_CONFIG=some/config.ini:other/config.ini

# Or --config command-line option
$ nextgisweb --config some/config.ini:other/config.ini ...
```

--------------------------------

### Launch NextGIS Toolbox Docker Stack

Source: https://docs.nextgis.com/docs_toolbox_prem/source/admin

These commands sequentially launch the Docker Compose stack for NextGIS Toolbox. The first command starts only the 'postgres' service and waits for 30 seconds to ensure it's fully initialized, while the second command then starts all remaining services, respecting service dependencies.

```Shell
docker compose up -d postgres && sleep 30
docker compose up -d
```

--------------------------------

### Prepare NextGIS Toolbox Deployment Directory

Source: https://docs.nextgis.com/docs_toolbox_prem/source/admin

These commands prepare the server for NextGIS Toolbox installation. They create the designated deployment directory, navigate into it, download the Docker Compose configuration template from NextGIS, and then unpack the compressed archive.

```Shell
mkdir /srv/toolbox
cd /srv/toolbox
wget https://nextgis.com/onpremise/toolbox/docker-compose-24.10.0.tar.bz2
tar jxf docker-compose-24.10.0.tar.bz2
```

--------------------------------

### NextGIS Web API: Get Features Ordered by Fields

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

Example HTTP GET request to retrieve features ordered by one or more fields. This example shows ordering by `NAME` in ascending order and `LEISURE` in descending order.

```HTTP
GET /api/resource/197/feature/?order_by=NAME,-LEISURE HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Example HTTP Request for TMS Tile

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/misc

An example HTTP GET request demonstrating how to retrieve a TMS tile for resource ID 234 at zoom level 7, x=84, y=42 from the NextGIS Web server.

```HTTP
GET /api/component/render/tile?z=7&x=84&y=42&resource=234 HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Example HTTP Request: Get Resource Permission Explanation

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/auth

Illustrates a sample HTTP GET request to query the /api/resource/{id}/permission/explain endpoint for resource ID 56. This example demonstrates the necessary Host and Accept headers for the request.

```HTTP
GET /api/resource/56/permission/explain HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Example HTTP Request: Get Resource Permissions

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/auth

Provides a practical example of an HTTP GET request to query the permissions for a resource with a specific ID (e.g., 56). This demonstrates the correct format for the request line, host, and Accept header.

```HTTP
GET /api/resource/56/permission HTTP/1.1
Host: ngw_url
Accept: */*

```

--------------------------------

### Example: Fetch MVT Vector Tiles (Deprecated)

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/misc

An example HTTP GET request to fetch MVT data using the deprecated endpoint for resource ID 56 at zoom level 11, x-coordinate 1234, and y-coordinate 543.

```HTTP
GET /api/resource/56/11/1234/543.mvt HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Define NextGIS Web Component Entry Point in Python

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/internal/component

This snippet demonstrates how to define a NextGIS Web (NGW) component using Python's setuptools entry points. It shows the `pkginfo` function which returns a dictionary mapping a component ID to its Python path, and how `setup()` is configured to register this package as an NGW component. This mechanism allows NGW to discover and load modular components.

```Python
def pkginfo():
    return dict(components=dict(
        somecomp='somepackage.somecomp'))

setup(
    name = 'somepackage',
    entry_points = {'nextgisweb.packages':
        'somepackage = somepackage:somemod:pkginfo'}
)
```

--------------------------------

### Example: Fetch MVT Vector Tiles (New)

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/misc

An example HTTP GET request to fetch MVT data for resource ID 56 at zoom level 11, x-coordinate 1234, and y-coordinate 543 using the new API endpoint.

```HTTP
GET /api/component/feature_layer/mvt?resource=56&z=11&x=1234&y=543 HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Example Output from NextGIS Web Entrypoint Functions

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/internal/jsrealm

Illustrates the expected console output after executing the `greet` and `lorem` functions from the `@nextgisweb/bar/entrypoint` module, showing dynamically generated text from Faker.js.

```Text
Hello, Stephen Hagenes!
Nobis porro officiis natus id ex hic blanditiis
commodi tenetur. Sint sed et voluptatibus ratione non quo natus. Odio dolorem
ipsum sapiente dolores autem modi. Deleniti eos possimus minima vitae dolore.
```

--------------------------------

### Create NextGIS Docker Working Directories

Source: https://docs.nextgis.com/docs_ngwdocker/doc/deployment

Instructions to create the base working directory and a dedicated backup directory on the Docker host for NextGIS Web, preparing the environment for Docker Compose deployment.

```bash
mkdir /srv/ngwdocker
cd /srv/ngwdocker
```

```bash
mkdir /srv/ngwdocker/backup
```

--------------------------------

### GET Geo Service Details by ID

Source: https://docs.nextgis.com/qms_srv_dev/doc/api

Documents the API endpoint for retrieving comprehensive details about a specific Geo Service using its unique integer ID. This endpoint provides information such as URL, GUID, name, type, EPSG code, and status. It includes an example HTTP request and the corresponding JSON response structure, demonstrating the expected data format.

```HTTP
GET /api/v1/geoservices/465/ HTTP/1.1
Host: qms.nextgis.com
Accept: */*
```

```HTTP
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
     "id": 465,
     "cumulative_status": "works",
     "url": "http://maps.kosmosnimki.ru/TileService.ashx?Request=gettile&LayerName=04C9E7CE82C34172910ACDBF8F1DF49A&apikey=U96GP973UH&crs=epsg:3857&z={z}&x={x}&y={y}",
     "alt_urls": [],
     "origin_url": "http://maps.kosmosnimki.ru/TileService.ashx?Request=gettile&LayerName=04C9E7CE82C34172910ACDBF8F1DF49A&apikey=U96GP973UH&crs=epsg:3857&z={z}&x={x}&y={y}",
     "guid": "cd71471d-4899-4e95-b2e5-5c7e8dd55fce",
     "name": "Kosmosnimki.ru Satellite",
     "desc": "",
     "type": "tms",
     "epsg": 3857,
     "license_name": "",
     "license_url": "",
     "copyright_text": "",
     "copyright_url": "",
     "terms_of_use_url": "",
     "created_at": "2016-11-14T18:08:04.486371Z",
     "updated_at": "2016-11-14T18:08:04.486371Z",
     "source": null,
     "source_url": null,
     "extent": null,
     "boundary": null,
     "boundary_area": null,
     "z_min": null,
     "z_max": 19,
     "y_origin_top": true,
     "icon": 77,
     "submitter": null,
     "last_status": 442280
}
```

--------------------------------

### Example HTTP Request for NextGIS Web Resource Schema

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

An example HTTP GET request demonstrating how to query the /resource/schema endpoint. It includes the required 'Host' and 'Accept' headers for a successful request.

```HTTP
GET /resource/schema HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### NextGIS Web API: Get Features Without Geometry

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

Example HTTP GET request to retrieve features from a resource but exclude their geometry data from the response by setting the `geom` parameter to `no`. This is useful for attribute-only queries.

```HTTP
GET api/resource/442/feature/?geom=no HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### NextGIS Web API: Get Features Intersecting a Polygon

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

Example HTTP GET request to retrieve features that intersect a specified polygon geometry. The polygon coordinates are URL-encoded within the `intersects` query parameter.

```HTTP
GET api/resource/442/feature/?intersects=POLYGON((4692730.0186502402648329%206500222.2378559196367859,4692731.0186502402648330%206500222.2378559196367859,4692730.0186502402648331%206500222.2378559196367861,4692730.0186502402648329%206500222.2378559196367861,4692730.0186502402648329%206500222.2378559196367859)) HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Example: Identify Features by Polygon Response

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/misc

An example JSON response showing identified features, including feature count, fields, ID, label, and layer ID, grouped by layer.

```JSON
{
  "2": {
    "featureCount": 1,
    "features": [
      {
        "fields": {
          "Id": 25,
          "name": "Church 1514-1925"
        },
        "id": 3,
        "label": "#3",
        "layerId": 2
      }
    ]
  },
  "5": {
    "featureCount": 0,
    "features": []
  },
  "featureCount": 1
}
```

--------------------------------

### Example Requests for Creating WMS Connection

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/create

Provides practical examples of how to make a request to the /api/resource/ endpoint to create a WMS client connection, shown as a raw HTTP request and a curl command.

```HTTP
POST /api/resource/ HTTP/1.1
Host: ngw_url
Accept: */*

 {
     "resource": {
         "cls": "wmsclient_connection",
         "parent": {
             "id": 0
         },
         "display_name": "test connection",
         "keyname": null,
         "description": null
     },
     "resmeta": {
         "items": {}
     },
     "wmsclient_connection": {
         "url": "http://pkk5.rosreestr.ru/arcgis/services/Cadastre/CadastreWMS/MapServer/WMSServer",
         "username": null,
         "password": null,
         "version": "1.1.1",
         "capcache": "query"
     }
 }
```

```Shell
$ curl --user "login:password" -H "Accept: */*" -X POST
-d '{"resource":{"cls":"wmsclient_connection","parent":{"id":0},
"display_name":"test connection","keyname":null,"description":null},
"resmeta":{"items":{}},"wmsclient_connection":{"url":"http://pkk5.rosreestr.ru/arcgis/services/Cadastre/CadastreWMS/MapServer/WMSServer",
"username":null,"password":null,"version":"1.1.1","capcache":"query"}}'
http://demo.nextgis.com/api/resource/

{"id": 131, "parent": {"id": 0}}
```

--------------------------------

### NextGIS Web API: Get Features Filtered by Field Value

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

Example HTTP GET request to retrieve features from a specific resource, filtered by a field value (e.g., `fld_ondatr_set=3.0`). This demonstrates basic attribute-based filtering.

```HTTP
GET api/resource/442/feature/?fld_ondatr_set=3.0 HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Example Request for Full Map Web Interface

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

An example HTTP GET request demonstrating how to access the full web map user interface for a resource with ID 42. It specifies the host and accepted content types.

```HTTP
GET resource/42/display HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Install NextGIS iOS SDK dependencies with Carthage

Source: https://docs.nextgis.com/ngmobile_dev/source/ngmiv3

This command executes Carthage to download and install all necessary components for the NextGIS iOS SDK, specifically targeting the iOS platform. It fetches the frameworks defined in the `Cartfile`.

```Shell
carthage update --platform "iOS"
```

--------------------------------

### Example: Identify Features by Polygon Request

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/misc

An example HTTP POST request to identify features within a specified polygon (WKT format) and spatial reference system (SRS) for given layers.

```HTTP
POST /feature_layer/identify HTTP/1.1
Host: ngw_url
Accept: */*

{
    "srs":3857,
    "geom":"POLYGON((4188625.8318882 7511123.3382522,4188683.1596594 7511123.
                     3382522,4188683.1596594 7511180.6660234,4188625.8318882
                     7511180.6660234,4188625.8318882 7511123.3382522))",
    "layers":[2,5]
}
```

--------------------------------

### Start All Docker Compose Services

Source: https://docs.nextgis.com/docs_ngwdocker/doc/backup_restore

Starts all services defined in the docker-compose.yml file. Use this command to bring the NextGIS Docker environment back online after maintenance.

```Shell
docker-compose start
```

--------------------------------

### NextGIS Web API: Get Features with Large Geometry (curl)

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

Example `curl` command demonstrating how to send a large geometry (e.g., a MULTIPOLYGON) in the request body for a GET request. This is an alternative to URL parameters for complex geometries.

```curl
curl --request GET "http://sandbox.nextgis.com/api/resource/1234/feature/" --header "Content-Type: application/json" --data-raw "{\"intersects\": \"MULTIPOLYGON (((3821804.05999104725196958 5744803.73564852681010962, 3756055.8574127024039626 5562813.06612514425069094, 3927526.96338468883186579 5635924.2469089291989803, 3821804.05999104725196958 5744803.73564852681010962)))\"}"
```

--------------------------------

### MOLUSCE Plugin: Inputs Tab Workflow

Source: https://docs.nextgis.com/docs_ngqgis/source/molusce

Describes the initial steps within the MOLUSCE plugin's 'Inputs' tab, focusing on selecting required raster layers and performing a geometry check to proceed with model training.

```APIDOC
Inputs Tab Workflow:
  - From the list of raster layers in the project:
    - Select the initial state map.
    - Select the final state map.
  - In the bottom right part of the tab:
    - Add spatial variables.
  - Action:
    - Press "Check geometry" button.
  - Outcome:
    - Upon successful geometry check, other plugin tabs become available.
```

--------------------------------

### NextGIS Web API: Get Features Without Extensions

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

Example HTTP GET request to retrieve features from a resource while excluding any extension data (like descriptions or attachments) from the response by setting the `extensions` parameter to an empty string.

```HTTP
GET api/resource/442/feature/?extensions= HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Start NextGIS Web Service with systemctl

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/admin/backup_restore

This command, executed as root, starts the 'ngw.service' systemd service. It is typically run after a successful restore operation and any necessary database migrations to bring the NextGIS Web application back online.

```Shell
# systemctl start ngw.service
```

--------------------------------

### NextGIS Web API: Get Features with GeoJSON Geometry and Specific SRS

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

Example HTTP GET request to retrieve features with their geometry formatted as GeoJSON and reprojected to a specific Spatial Reference System (SRS), in this case, EPSG:4326.

```HTTP
GET /api/resource/197/feature/?geom_format=geojson&srs=4326 HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Example ngwdocker.yaml Configuration

Source: https://docs.nextgis.com/docs_ngwdocker/doc/development/configuration

This YAML configuration file is used by the `ngwdocker` executable to define its behavior. It allows setting the operational mode (e.g., 'production'), specifying the base Docker image (e.g., 'ubuntu:22.04'), and enabling or disabling individual NextGIS packages like `nextgisweb` or `nextgisweb_qgis`.

```YAML
# By default 'development' mode is used. To enable production mode
# uncomment line below.
# mode: production

# By default 'ubutu:22.04' base image is used. Possible values are:
#   * ubuntu:22.04
# base_image: ubuntu:22.04

# Packages their configuration
package:

  ngwdocker:
  nextgisweb:

  nextgisweb_qgis:
    # Temporary disable nextgisweb_qgis package.
    # enabled: false

  # Another way to temporary disable package.
  # nextgisweb_mapserver: false
```

--------------------------------

### Starting New Minor Development Version

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/internal/versioning

After creating a release, this snippet shows how to immediately start a new development cycle by incrementing the minor version and appending the 'dev0' suffix. This prepares the repository for future development while maintaining a clear version history.

```bash
bump2version --commit minor
cat VERSION
```

--------------------------------

### Launch NextGIS GeoServices PostgreSQL with Docker Compose

Source: https://docs.nextgis.com/docs_geoserv_prem/source/admin

This command initiates the PostgreSQL service for NextGIS GeoServices using Docker Compose in detached mode. A 30-second delay is included to ensure the database service is fully up and running before other services are launched, preventing potential startup issues.

```bash
docker compose up -d postgres && sleep 30
```

--------------------------------

### Curl Example: Create Lookup Table

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/create

A curl command example demonstrating how to create a lookup table resource using basic authentication, specifying the request headers and the JSON payload directly in the command line.

```Bash
$ curl --user "user:password" -H 'Accept: */*' -X POST -d '{"resource":{"cls":"lookup_table",
"parent":{"id":381},"display_name":"test_3","keyname":null,"description":null},"resmeta":
{"items":{}},"lookup_table":{"items":{"cat":"\u041c\u0430\u0448\u0438\u043d\u0430"}}}'
http://demo.nextgis.com/api/resource/

{"id": 385, "parent": {"id": 381}}
```

--------------------------------

### NextGIS Web API: Get Features Filtered by Date and Selected Fields

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

Example HTTP GET request to retrieve features filtered by a date field (`fld_dataunreal`) and to limit the returned fields to `Desman_ID` and `Year_1`. This shows combined filtering and field selection.

```HTTP
GET api/resource/442/feature/?fld_dataunreal=2018-04-15&fields=Desman_ID,Year_1 HTTP/1.1
Host: ngw_url
Accept: */*
```

--------------------------------

### Define and Evolve Python Database Models for NextGIS Web Components

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/internal/migration

Illustrates how to define SQLAlchemy-like models for NextGIS Web components, showing initial definitions, schema evolution by adding columns, and models for new components.

```Python
class FooModel(Base):
    __tablename__ = 'foo_model'
    id = db.Column(db.Integer, primary_key=True)
    some = db.Column(db.Unicode)
```

```Python
class FooModel(Base):
    __tablename__ = 'foo_model'
    id = db.Column(db.Integer, primary_key=True)
    some = db.Column(db.Unicode)
    other = db.Column(db.Unicode)
```

```Python
class BarModel(Base):
    __tablename__ = 'bar_model'
    id = db.Column(db.Integer, primary_key=True)
    some = db.Column(db.Unicode)
```

--------------------------------

### Example Geo Service Data Structure

Source: https://docs.nextgis.com/qms_srv_dev/doc/api

An example JSON array representing details for two different Geo Services. This structure illustrates the typical format of service objects, including properties like GUID, name, description, type, EPSG code, and status. It serves as a reference for understanding the data returned by Geo Service API endpoints.

```JSON
[
            {
            "guid": "10df7a62-a447-4eb5-bbf4-040360d09b04",
            "name": "Australia - Tasmania LIST Orthophoto",
            "desc": "Tasmania State Orthophoto compilation. Coverage compiled from latest aerial photos sourced from DPIPWE, Southern Councils, and individual projects. The resolution of the raster capture varies, with many urban areas at a higher resolution.For Services Terms and Conditions, please see the LIST Web Services Terms and Conditions (http://listdata.thelist.tas.gov.au/public/LISTWebServicesTermsConditions.pdf)",
            "type": "tms",
            "epsg": 3857,
            "icon": null,
            "submitter": "d06765ea-95dd-497d-8963-42ff5affa4fe",
            "created_at": "2016-11-25T19:54:24.700639Z",
            "updated_at": "2016-11-25T19:54:24.700639Z",
            "cumulative_status": "works",
            "extent": null
        },
        {
            "id": 636,
            "guid": "24f06d38-64ad-4467-b80d-82ad5cfc1cd1",
            "name": "Australia - Tasmania LIST Topographic",
            "desc": "Tasmania Topographic base map. Different map scales used to represent the map. Created from vector data.For Services Terms and Conditions, please see the LIST Web Services Terms and Conditions (http://listdata.thelist.tas.gov.au/public/LISTWebServicesTermsConditions.pdf)",
            "type": "tms",
            "epsg": 3857,
            "icon": null,
            "submitter": "d06765ea-95dd-497d-8963-42ff5affa4fe",
            "created_at": "2016-11-25T19:47:57.742223Z",
            "updated_at": "2016-11-25T19:47:57.742223Z",
            "cumulative_status": "works",
            "extent": null
        }
    ]
```

--------------------------------

### Example NextGIS Web Feature Response (MFC Data with Attachments)

Source: https://docs.nextgis.com/docs_ngweb_dev/doc/developer/resource

A JSON response example for a spatial feature representing an MFC (Multifunctional Center), including official and short names, area, windows, start date, address, phone, opening hours, director, description, services, issue info, website, and extensions for description and image attachments.

```JSON
{
     "id": 1,
     "geom": "MULTIPOINT (14690369.3387846201658249 5325725.3689366327598691)",
     "fields": {
         "name_official": "Краевое государственное автономное учреждение...",
         "name_short": "МФЦ Приморского края",
         "square": "702",
         "windows": "16",
         "start_date": "2013/12/30",
         "addr": "690080, Приморский край. г. Владивосток, ул. Борисенко д. 102",
         "phone_consult": "(423) 201-01-56",
         "opening_hours": "пн: 09:00-18:00 (по предварительной записи)вт: 09:00-20:00ср: 11:00-20:00чт: 09:00-20:00пт: 09:00-20:00 сб: 09:00-13:00 вс: выходной",
         "director": "Александров Сергей Валерьевич",
         "desc": "Центр создан в целях ...",
         "services_info": "Ознакомиться с перечнем можно ...",
         "issue_info": "ответственность должностных лиц ...",
         "website": "http://mfc-25.ru"
       },
     "extensions": {
         "description": " Описание объекта в ...",
         "attachment": [
             {
                 "id": 1,
                 "name": "fyADeqvXtXo.jpg",
                 "size": 107458,
                 "mime_type": "image/jpeg",
                 "description": null,
                 "is_image": true
             },
             {
                 "id": 2,
                 "name": "0_12cb49_b02b5fb0_orig.jpg",
                 "size": 65121,
                 "mime_type": "image/jpeg",
                 "description": "Текст подписи к фото",
                 "is_image": true
             }
         ]
     }
 }
```
Tokens:
Raw