NextGIS

https://docs.nextgis.ru
Admin
NextGIS is a comprehensive GIS platform offering a suite of software and services for geospatial...
Tokens:73,567
Snippets:373
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example NextGIS Web Configuration File (config.ini)

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

This snippet provides an example `config.ini` file for NextGIS Web, detailing essential configuration parameters. It includes settings for database connection (host, name, user, password) and the file system storage directory (`sdir`). This file is crucial for NextGIS Web to connect to its database and manage data.

```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
```

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

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

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

This snippet provides commands to install PostgreSQL, PostGIS, and their extensions on Ubuntu Linux. It then demonstrates how to create a dedicated PostgreSQL role and database for NextGIS Web, enable necessary extensions like PostGIS and hstore, and set ownership for spatial system tables. This setup is crucial for NextGIS Web's database operations.

```bash
# apt install postgresql postgresql-contrib postgis
# su postgres -c psql
```

```sql
CREATE ROLE nextgisweb LOGIN PASSWORD 'changeme';
CREATE DATABASE nextgisweb OWNER nextgisweb
ENCODING 'UTF-8' LC_COLLATE 'C.UTF-8' LC_CTYPE 'C.UTF-8';
\connect nextgisweb
CREATE EXTENSION postgis;
ALTER TABLE spatial_ref_sys OWNER TO nextgisweb;
ALTER TABLE geography_columns OWNER TO nextgisweb;
ALTER TABLE geometry_columns OWNER TO nextgisweb;
CREATE EXTENSION hstore;
\quit
```

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

### NextGIS Web Initial Directory Layout Example

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

Illustrates the assumed directory structure for a NextGIS Web installation, showing the placement of `env`, `data`, `config`, and `package` directories, including a `setup.py` file within a component.

```text
🗁 ~ngw
├── 🗀 env
├── 🗀 data
├── 🗀 config
└── 🗁 package
    ├── 🗀 nextgisweb
    └── 🗁 nextgisweb_foo
        ├── 🗁 nextgisweb_foo
        │   └── 🗀 bar
        └── 🗎 setup.py
```

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

### Manage NextGIS Web Systemd Services and Timers

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

These commands reload the systemd manager configuration, enable the NextGIS Web service and maintenance timer to start on boot, and then immediately start them. This ensures NextGIS Web runs as a background service and its maintenance tasks are scheduled.

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

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

### Run NextGIS Web with uWSGI Server

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

This command starts the uWSGI server using the specified configuration file (config/uwsgi.ini). It makes NextGIS Web accessible via HTTP, typically at http://localhost:8080, suitable for production use.

```Shell
uwsgi --ini config/uwsgi.ini
```

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

### Build Webpack Bundles and Start NextGIS Web Server

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

Commands to navigate to the NextGIS Web home directory, build Webpack bundles, and start the development web server.

```bash
$ cd ~ngw
$ yarn run build
$ nextgisweb server
```

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

### Initialize Node.js and Build NextGIS Web Frontend

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

These commands set up the Node.js and Yarn project environment, install necessary JavaScript dependencies, create a 'dist' directory, and then build the NextGIS Web frontend assets required for the application.

```Shell
nextgisweb jsrealm install
mkdir dist
yarn run build
```

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

### NextGIS Web Systemd Service Configuration

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

This systemd service file defines how to run NextGIS Web as a system service. It specifies the working directory, execution command (uWSGI), user, group, and restart policy, ensuring NextGIS Web starts automatically with the system.

```Systemd
[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
```

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

### Start NextGIS Web Docker Services

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

This command initiates the Docker Compose setup, pulling necessary images, creating containers, and starting all defined services in detached mode. It brings up the entire NextGIS Web stack, making it accessible via the configured ports.

```Shell
docker-compose up -d
```

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

### Clone NextGIS Web Source Code Repository

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

This snippet creates a `package` directory, navigates into it, and then clones the NextGIS Web source code repository from GitHub. This step retrieves the application's source files, which are necessary for installation and further configuration.

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

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

### Install NextGIS Web Core System Dependencies on Ubuntu

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

This snippet provides a series of `apt` commands to install essential system packages required for NextGIS Web. It includes tools like `curl` and `git`, adds NodeSource and Yarn package repositories, and installs Python development libraries, build tools, GDAL, and other critical dependencies. This step prepares the system environment for the NextGIS Web application.

```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
```

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

### Example Output from NextGIS Web Component Entrypoint

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

Shows the expected output in the browser console after executing the `greet` and `lorem` functions from the `faker` library.

```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.
```

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

### Run NextGIS Web Built-in HTTP Server

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

This command starts the NextGIS Web application using its built-in HTTP server, typically accessible at http://localhost:8080. It is suitable for initial testing and development but not recommended for production environments.

```Shell
nextgisweb server
```

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

### Example: HTTP GET Request for Resource Permissions

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

Provides an example HTTP GET request to the /api/resource/56/permission endpoint, demonstrating the required Host and Accept headers for retrieving resource permissions.

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

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

### Install NextGIS Web Python Package and Compile Translations

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

This snippet sets an environment variable required for editable installations, then installs the NextGIS Web Python package into the active virtual environment in editable mode. Finally, it compiles internationalization (i18n) translations for the application. This prepares the Python components of NextGIS Web for execution.

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

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

### Switch to NextGIS Web User and Change Directory

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

This snippet demonstrates how to switch to the newly created `ngw` user using `su` and then navigate to its home directory. All subsequent commands for NextGIS Web installation should be executed under this user to maintain proper permissions and environment isolation.

```bash
# su ngw
$ cd
```

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

### Persist Virtual Environment Activation and Configuration

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

These commands add lines to the ~/.bashrc file to automatically activate the Python virtual environment and set the NEXTGISWEB_CONFIG environment variable upon shell login for the 'ngw' user, ensuring consistent environment setup.

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

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

### Create NextGIS Web Configuration and Data Directories

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

This snippet navigates to the user's home directory and creates two new directories: `config` and `data`. These directories will be used to store NextGIS Web's configuration files and application data, respectively, organizing the installation files.

```bash
$ cd
$ mkdir config data
```

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

### Checkout Latest Stable NextGIS Web Version

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

This snippet navigates into the cloned `nextgisweb` directory and checks out the latest stable tagged version of the repository. It then displays the current tag, ensuring that the installation proceeds with a production-ready release rather than the potentially unstable `master` branch.

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

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

### Example HTTP GET Request for Resource Permissions

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

Demonstrates how to make an HTTP GET request to retrieve permission explanations for a resource with ID 56. It includes the necessary Host and Accept headers for the request.

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

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

### Install NextGIS Web JavaScript Realm

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

Commands to change the current directory to the NextGIS Web home and install the JavaScript realm, which integrates the new package into the Yarn workspace.

```bash
$ cd ~ngw
$ nextgisweb jsrealm install
```

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

### Install uWSGI into Virtual Environment

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

This command installs the uWSGI WSGI server into the active Python virtual environment. uWSGI is a common choice for production deployments of Python web applications like NextGIS Web.

```Shell
pip install uwsgi
```

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

### Initialize NextGIS Web Database Structure

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

This command initializes the database schema required for NextGIS Web to function. It sets up all necessary tables and structures, preparing the database for application use.

```Shell
nextgisweb initialize_db
```

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

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

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

Provides a concrete example of an HTTP GET request to the NextGIS Web tracker API, demonstrating how to query for track points of specific devices within a defined time window. The example includes the full HTTP request headers and a sample JSON response containing geographical and packet data for the track points.

```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": []
}
```

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

### Create Dedicated User for NextGIS Web Installation

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

This command creates a new system user named `ngw` with a home directory at `/srv/ngw` and sets `/bin/bash` as its default shell. It is recommended to run NextGIS Web under a separate, non-root user for security and isolation purposes. All subsequent installation steps will be performed under this user.

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

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

### Build and run NextGIS Web Docker containers

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

This snippet shows how to use the `ngwdocker` command to generate Docker configuration files, then build the Docker images using `docker-compose build`, and finally run the main application container with `docker-compose up app`. It also includes example output from these commands.

```bash
ngwdocker
2020-02-04 19:38:42.942 | WARNING  | ngwdocker.context:from_file:44 - File 'ngwdocker.yaml' not found! Using default configuration.
2020-02-04 19:38:42.943 | DEBUG    | ngwdocker.context:load_packages:89 - Loading <module 'nextgisweb.docker' from 'package/nextgisweb/docker.py'>
2020-02-04 19:38:42.943 | DEBUG    | ngwdocker.context:load_packages:89 - Loading <module 'nextgisweb_mapserver.docker' from 'package/nextgisweb_mapserver/docker.py'>
2020-02-04 19:38:42.944 | DEBUG    | ngwdocker.context:load_packages:89 - Loading <module 'nextgisweb_qgis.docker' from 'package/nextgisweb_qgis/docker.py'>
docker-compose build
docker-compose up app
Creating network "ngwdocker_default" with the default driver
Creating volume "ngwdocker_data" with default driver
Creating volume "ngwdocker_postgres" with default driver
Creating ngwdocker_postgres_1 ... done
Creating ngwdocker_app_1      ... done
( A lot of log messages )
```

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

### Restoring PostgreSQL Dump and Starting All Services

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

This snippet completes the PostgreSQL cluster recreation process by restoring the previously created database dump into the new cluster. After restoration, all other NextGIS Web services are started to bring the application back online.

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

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

### Starting PostgreSQL Service and Creating Database Dump

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

This snippet shows how to start only the PostgreSQL service in detached mode and then create a database dump from within the running container. This dump is essential for restoring data after the PostgreSQL cluster has been recreated.

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

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

### Start NextGIS Web System Services

Source: https://docs.nextgis.ru/docs_ngweb_dev/doc/admin/upgrade

This `systemctl` command is used to start the NextGIS Web core service (`ngw.service`) and its associated maintenance timer (`ngw-maintenance.timer`). It should be executed once all upgrade and migration steps are successfully completed to bring the NextGIS Web application back online.

```bash
# systemctl start ngw.service ngw-maintenance.timer
```

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

### NextGIS Web uWSGI Configuration File

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

This INI file configures uWSGI to serve the NextGIS Web application. It specifies the HTTP port, number of worker processes, thread enabling, and how to load the NextGIS Web application from its egg.

```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
```

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

### Stopping Services and Starting Only PostgreSQL for PostGIS Upgrade

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

This snippet prepares the environment for a PostGIS upgrade by stopping all NextGIS Web services. It then starts only the PostgreSQL container in detached mode, ensuring exclusive access for the PostGIS upgrade process.

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

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

### Verify Docker Installation

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

Run the `hello-world` Docker image to confirm that Docker is installed and configured correctly on the system. A successful execution indicates that the Docker daemon is running and accessible.

```Shell
$ docker run hello-world
Hello from Docker!
...(snipped)...
```

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

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

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

This snippet creates a Python virtual environment named `env` using `python3` and then activates it. Using a virtual environment isolates the project's Python dependencies from the system-wide Python installation, preventing conflicts and ensuring a clean development or deployment environment for NextGIS Web.

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

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

### Start NextGIS Web Service (systemd)

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

Once the restore process is complete, restart the NextGIS Web service to bring your application back online. This command, run as root, reactivates the `ngw.service`.

```bash
# systemctl start ngw.service
```

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

### Starting Services and Synchronizing PostGIS after Upgrade

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

This snippet concludes the PostGIS upgrade process by restarting all NextGIS Web services. It then runs a command to synchronize the PostGIS `spatial_ref_sys` table with NextGIS Web, ensuring data consistency and proper functioning after the upgrade.

```bash
$ docker-compose up -d
$ docker-compose run --rm app nextgisweb spatial_ref_sys sync_postgis
```

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

### Configure `package.json` for NextGIS Web Component

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

Example `package.json` content for a NextGIS Web component, defining its name, version, and module type. It highlights the use of `kebab-case` for Node package names.

```json
{
    "name": "@nextgisweb/bar",
    "version": "0.0.0",
    "type": "module"
}
```

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

### Starting NextGIS Web Docker Services

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

After performing upgrades, configuration changes, or maintenance, this command restarts all NextGIS Web services in detached mode. This allows the application to resume operation in the background.

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

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

### Implementing Basic Dynamic Imports in JavaScript

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

This example shows how to use the 'import()' function for dynamic module loading. It creates on-demand chunks, which are loaded asynchronously. However, this approach has limitations if the dynamically imported module becomes an entrypoint.

```JavaScript
async function doSomething() {
    const dynamic = await import("./some-module");
}
```

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

### NextGIS Web Maintenance Systemd Service

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

This systemd service file defines a one-shot service for running the NextGIS Web maintenance task. It specifies the working directory, environment variables, and the command to execute the periodic maintenance script.

```Systemd
[Unit]
Description=NextGIS Web maintenance task
Wants=ngw-maintenance.timer

[Service]
Type=simple
WorkingDirectory=/srv/ngw
Environment="NEXTGISWEB_CONFIG=/srv/ngw/config/config.ini"
ExecStart=/srv/ngw/env/bin/nextgisweb maintenance
User=ngw
Group=ngw

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

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

### Example HTTP GET Request for Filtered Geo Services

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

Illustrates an example HTTP GET request to fetch TMS type geo services with EPSG 3857, limiting results to 15 and starting from the beginning (offset 0). The request includes standard HTTP headers.

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

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

### Example HTTP Request to Create Tracker

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

An example HTTP request demonstrating how to create a tracker resource using the POST /api/resource/ endpoint with a JSON payload. This example shows the structure of the `resource` and `tracker` objects.

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

 {
     "resource": {
         "cls": "wmsclient_layer",
         "parent": {
             "id": 0
         },
         "display_name": "layer1",
         "keyname": null,
         "description": null
     },
     "resmeta": {
         "items": {}
     },
     "tracker": {
         "unique_id": "test-001",
         "description": "test desc",
         "device_type": "ng_mobile",
         "consumption_lpkm": 5.0
    }
 }
```

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

### Query Capital Construction Object by Coordinates (Python)

Source: https://docs.nextgis.ru/docs_geoservices/source/geos_for_dev

This Python snippet demonstrates how to query the NextGIS PKK service to retrieve information about a capital construction object (OKS) at a specific geographical point. It uses the 'requests' library to make a GET request to the 'by_pos' endpoint, providing an API key, latitude, longitude, and type. The response is then parsed as JSON, and the first feature is printed.

```Python
import requests

url = 'https://geoservices.nextgis.com/pkk/features/by_pos?apikey=YOUR-API-KEY&lat=55.67927298459276&lon=37.591867175551606&type=5'

resp = requests.get(url)
data = resp.json()
print(data['features'][0])
```

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

### Install ngwdocker to User Profile

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

Install the `ngwdocker` package to the current user's Python profile using `pip`. This method places the executable in a user-specific directory. Commands are provided to find this directory and add it to the system's PATH environment variable for easy access.

```Shell
$ python3 -m pip install --user git+ssh://git@github.com/nextgis/ngwdocker.git
# Executable ngwdocker now located in python user directory. Binary
# directory location may vary on installation or platform. It can
# obtained with "echo $(python3 -m site --user-base)/bin" command.
# It can be added to PATH environment variable like this:
$ export PATH=$(python3 -m site --user-base)/bin:$PATH
$ mkdir ngwdocker
$ cd ngwdocker
```

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

### Registering NextGIS Web Components with setuptools

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

This Python code demonstrates how to register a NextGIS Web (NGW) component using setuptools entry points. It defines a `pkginfo` function that returns a dictionary mapping a component ID to its package path, and then uses this in the `setup` function's `entry_points` argument under `nextgisweb.packages`.

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

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

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

### Example: Get All Local Users HTTP Request and Response

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

Demonstrates an HTTP GET request to retrieve a list of all local users in the WebGIS system. The response is an array of user objects, with some output clipped for brevity.

```HTTP
GET /api/component/auth/user/
```

```JSON
[
  // ...
  {
    "id": 4,
    "system": false,
    "display_name": "Administrator",
    "description": null,
    "keyname": "administrator",
    "superuser": false,
    "disabled": false,
    "last_activity": "2020-08-07T01:27:52.870601",
    "oauth_subject": null,
    "oauth_tstamp": null,
    "member_of": [ 5 ]
  },
  {
    "id": 6,
    "system": true,
    "display_name": "Owner",
    "description": null,
    "keyname": "owner",
    "superuser": false,
    "disabled": false,
    "last_activity": null,
    "oauth_subject": null,
    "oauth_tstamp": null,
    "member_of": []
  },
  // ...
  {
    "id": 10,
    "system": false,
    "display_name": "Dear test user",
    "description": null,
    "keyname": "test_usera",
    "superuser": false,
    "disabled": true,
    "last_activity": null,
    "oauth_subject": null,
    "oauth_tstamp": null,
    "member_of": [ 5 ]
  }
]
```

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

### NextGIS Web Configuration File Example

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

Demonstrates a typical NextGIS Web configuration file structure for a component, illustrating how 'first.key' and 'second.key' are defined within the '[some_component]' section.

```INI
[some_component]
first.key = foo
second.key = bar

```

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

### Example: Get User by ID HTTP Request

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

Illustrates an HTTP GET request to retrieve details for a specific user using their ID (e.g., 10). It includes standard headers like Host and Accept.

```HTTP
GET /api/component/auth/user/10 HTTP/1.1
Host: ngw_url
Accept: */*
```

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

### Example HTTP Request for NextGIS Web Schema

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

An example HTTP GET request to the `/resource/schema` endpoint. It demonstrates the required `Host` and `Accept` headers for the request, specifically `Accept: */*`.

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

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

### NextGIS Web Component 'bar' Directory with `nodepkg`

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

Illustrates the updated directory structure for component 'bar' after creating the `nodepkg` directory and `package.json` file.

```text
🗁 ~ngw/package/nextgisweb_foo/nextgisweb_foo/bar
├── 🗀 amd
├── 🗁 nodepkg
│   └── 🗎 package.json
└── 🗎 __init__.py
```

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

### Execute NextGIS Web Component Entrypoint in Browser Console

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

JavaScript code to be executed in the browser's developer console, demonstrating how to load the `@nextgisweb/bar/entrypoint` module using `require` and call its `greet` and `lorem` functions.

```javascript
require(["@nextgisweb/bar/entrypoint"], function (entrypoint) {
    entrypoint.greet();
    entrypoint.lorem();
})
```

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

### Example HTTP Request for Map Web Interface

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

An example HTTP GET request demonstrating how to retrieve the full web map user interface for a specific resource (resource ID 42).

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

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

### Example HTTP Request for Single Feature

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

This is an example HTTP GET request to retrieve a single feature with ID 8 from resource ID 1878. It specifies the host and accepts any content type.

```HTTP
GET api/resource/1878/feature/8 HTTP/1.1
Host: ngw_url
Accept: */*

```

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

### Retrieve Resource Properties (HTTP GET Request)

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

This snippet shows an example HTTP GET request to retrieve the properties of a resource using its ID. It specifies the endpoint, host, and accepted content type.

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

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

### Example: Get Group by ID HTTP Request and Response

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

Illustrates an HTTP GET request to retrieve information for a specific group using its ID (e.g., 20). The response includes group details like display name, keyname, and members.

```HTTP
GET /api/component/auth/group/20
```

```JSON
{
  "id": 20,
  "system": false,
  "display_name": "Test group",
  "description": null,
  "keyname": "test_group",
  "register": false,
  "members": [ 10 ]
}
```

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

### Example Requests for Creating WMS Layer

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

Provides practical examples of creating a WMS layer using both raw HTTP POST and a cURL command, demonstrating the required JSON payload and authentication.

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

 {
     "resource": {
         "cls": "wmsclient_layer",
         "parent": {
             "id": 0
         },
         "display_name": "layer1",
         "keyname": null,
         "description": null
     },
     "resmeta": {
         "items": {}
     },
     "wmsclient_layer": {
         "connection": {
             "id": 18
         },
         "srs": {
             "id": 3857
         },
         "imgformat": "image/png",
         "wmslayers": "1,2",
         "vendor_params": {
            "key1": "value1"
         }
     }
 }
```

```cURL
$ curl --user "login:password" -H "Accept: */*" -X POST
-d '{"resource":{"cls":"wmsclient_layer","parent":{"id":0},
"display_name":"layer1","keyname":null,"description":null},
"resmeta":{"items":{}},"wmsclient_layer":{"connection":{"id":18},
"srs":{"id":3857},"imgformat":"image/png","wmslayers":"1,2"}}'
http://demo.nextgis.com/api/resource/

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

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

### Create NextGIS Web Component JavaScript Entrypoint

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

JavaScript code for `bar/nodepkg/entrypoint.js`, demonstrating how to import and use the `faker` library, and defining `greet` and `lorem` functions. The `/** @entrypoint */` JSDoc tag is crucial for Webpack.

```javascript
/** @entrypoint */
import faker from "faker";

export function greet() {
    console.log(`Hello, ${faker.name.findName()}!`);
}
export function lorem() {
    console.log(faker.lorem.paragraph());
}
```

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

### Example HTTP Request: Create PostGIS Layer

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

An example HTTP POST request demonstrating how to create a PostGIS layer. It includes the necessary headers and a sample JSON payload conforming to the API specification, showing typical values for creating a 'roads' layer.

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

 {
   "postgis_layer": {
     "column_geom": "wkb_geometry",
     "column_id": "ogc_fid",
     "connection": {
       "id": 31
     },
     "fields": "update",
     "geometry_type": null,
     "schema": "thematic",
     "srs": {
       "id": 3857
     },
     "table": "roads"
   },
   "resource": {
     "cls": "postgis_layer",
     "description": null,
     "display_name": "test",
     "keyname": null,
     "parent": {
       "id": 0
     }
   }
 }
```

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

### Stopping Services and Backing Up NextGIS Web Docker for Upgrade

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

This snippet outlines the initial steps for upgrading a NextGIS Web Docker deployment. It involves stopping all running services to ensure data consistency and then performing a full backup using the `archivist` tool before proceeding with the upgrade.

```bash
$ docker-compose stop
$ docker-compose run --rm archivist backup
```

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

### Example: Get Current User JSON Response

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

Shows the JSON response containing the keyname, display name, and ID of the currently authenticated user.

```JSON
{
    "keyname": "administrator",
    "display_name": "Admin",
    "id": 4
}
```

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

### Network Requests for NextGIS Web Module Loading

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

Illustrates the network requests made by the browser when loading the NextGIS Web entrypoint and its associated chunks.

```text
GET .../main/@nextgisweb/bar/entrypoint.js          [HTTP/1.1 200 OK  2ms]
GET .../main/chunk/vendors-...-eb4fd9.js            [HTTP/1.1 200 OK  3ms]
GET .../main/chunk/vendors-...-faker_index_js.js    [HTTP/1.1 200 OK 27ms]
```

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

### Example ngwdocker.yaml Configuration File

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

This YAML configuration file defines settings for the NextGIS Web Docker environment. It allows specifying the operating mode (development/production), the base Docker image, and enabling or disabling various NextGIS packages.

```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
```

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

### Example Geo Service Data Structure (JSON Array)

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

This snippet provides an example of the JSON structure for multiple geo service entries, typically returned by a list API endpoint. Each object represents a single geo service with properties like GUID, name, description, type, and status.

```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
    }
]
```

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

### NextGIS Web Component 'bar' Directory Structure

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

Shows the directory structure for a component named 'bar', including its 'amd' directory for Dojo-based JavaScript code and an '__init__.py' file.

```text
🗁 ~ngw/package/nextgisweb_foo/nextgisweb_foo/bar
├── 🗁 amd
│   └── 🗁 ngw-bar
│       ├── 🗎 module-one.js
│       └── 🗎 module-two.js
└── 🗎 __init__.py
```

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

### Clone NextGIS Web package sources

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

This section describes how to create a 'package' directory and clone the core NextGIS Web, NextGIS Web QGIS, and NextGIS Web MapServer repositories into it. These sources are required for building the Docker images.

```bash
mkdir -p package
git clone git@github.com:nextgis/nextgisweb.git package/nextgisweb
git clone git@github.com:nextgis/nextgisweb_qgis.git package/nextgisweb_qgis
git clone git@github.com:nextgis/nextgisweb_mapserver.git package/nextgisweb_mapserver
```

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

### Example: Get User by ID JSON Response

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

Presents the detailed JSON response containing all information for a user retrieved by their ID, including system status, display name, keyname, and group memberships.

```JSON
{
  "id": 10,
  "system": false,
  "display_name": "Test user",
  "description": null,
  "keyname": "test_usera",
  "superuser": false,
  "disabled": false,
  "last_activity": null,
  "oauth_subject": null,
  "oauth_tstamp": null,
  "member_of": [ 5 ]
}
```

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

### Configure Webpack Modules in `package.json`

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

Example `package.json` snippet demonstrating how to declare additional Webpack modules under `nextgisweb.webpackConfigs`, mapping a module name to its configuration file.

```json
{
    "nextgisweb": {
        "webpackConfigs": {
            "stylesheet": "webpack.stylesheet.cjs"
        }
    }
}
```

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

### Example HTTP Request to Create a PostGIS Connection

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

This example demonstrates a standard HTTP POST request to the `/api/resource/` endpoint for creating a new PostGIS connection. It includes the necessary HTTP headers and the JSON payload specifying both the resource properties and the PostGIS connection details.

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

 {
   "postgis_connection": {
     "database": "postgis",
     "hostname": "localhost",
     "password": "secret",
     "username": "user"
   },
   "resource": {
     "cls": "postgis_connection",
     "description": "The localhost PostGIS Connection",
     "display_name": "localhost",
     "keyname": "localhost_key",
     "parent": {
       "id": 0
     }
   }
 }
```

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

### Example Curl Command to Create WMS Connection

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

Demonstrates how to use the curl command-line tool to send a POST request for creating a WMS connection, including authentication, headers, and the JSON payload.

```bash
$ 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}}
```

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

### Upgrade NextGIS Web Package and Recompile Translations

Source: https://docs.nextgis.ru/docs_ngweb_dev/doc/admin/upgrade

This set of commands guides the user through upgrading the NextGIS Web package. It involves navigating to the package directory, pulling the latest changes from Git, listing available version tags, checking out a specific version (e.g., 4.4.0), installing the package in the virtual environment, and recompiling i18n translations.

```Shell
$ cd package/nextgisweb
$ git pull
$ git tag -l '*.*.*'
4.3.0
4.3.1
4.3.2
4.4.0
$ git checkout 4.4.0
$ cd ..
$ pip install -e nextgisweb
$ nextgisweb-i18n -p nextgisweb compile
```

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

### NextGIS Web Maintenance Systemd Timer

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

This systemd timer file schedules the 'ngw-maintenance.service' to run periodically. It is configured to execute the maintenance task every Monday at 00:30:00, ensuring regular cleanup.

```Systemd
[Unit]
Description=NextGIS Web maintenance timer
Requires=ngw-maintenance.service

[Timer]
OnCalendar=Mon *-*-* 00:30:00
Unit=ngw-maintenance.service

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

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

### Set NextGIS Web Configuration Environment Variable

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

This command sets the NEXTGISWEB_CONFIG environment variable to point to the NextGIS Web configuration file. This variable is crucial for the application to locate its settings during runtime.

```Shell
export NEXTGISWEB_CONFIG=/srv/ngw/config/config.ini
```

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

### Create Docker Working and Backup Directories

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

These commands create the primary working directory for NextGIS Web Docker setup and a dedicated subdirectory for storing backups directly on the Docker host. This ensures persistent storage for application data and backups outside of Docker volumes.

```Shell
mkdir /srv/ngwdocker
cd /srv/ngwdocker
```

```Shell
mkdir /srv/ngwdocker/backup
```

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

### Execute NextGIS Web Maintenance Task

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

This command runs the NextGIS Web maintenance task, which cleans up unused data such as old file uploads. It is recommended to run this command periodically to maintain system health and performance.

```Shell
nextgisweb maintenance
```

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

### Use ngwdocker with custom configuration files

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

This snippet demonstrates how to invoke the `ngwdocker` command with one or more custom YAML configuration files. This allows users to override default settings and provide specific configurations for their Docker setup.

```bash
ngwdocker ngwdocker_custom.yaml ngwdocker_additional.yaml
```

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

### Install NextGIS Web Component Database Tables

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

This shell command uses `nextgisweb migration install` to create database tables for a new NextGIS Web component (`bar`) based on its model definition. The `--no-dry-run` option ensures the changes are applied.

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

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

### Example: Create User HTTP Request

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

Demonstrates an HTTP POST request to create a new user, including the Host header and a JSON body with user details like display name, keyname, password, disabled status, and group membership.

```HTTP
POST /api/component/auth/user/ HTTP/1.1
Host: ngw_url
Accept: */*

{
   "display_name": "Test user",
   "keyname": "test_user",
   "password":"secret",
   "disabled": false,
   "member_of": [ 5 ]
}
```
Tokens:
Raw