Configure#

Important

All steps in this section must be performed by the root user. If you use sudo to avoid mixing up the commands, we recommend first running sudo -i to get a fully functional root user session.

Changing endpoints#

Changing endpoints may be required if the the name of the DNS server where the system is deployed changes, or if you change the settings of the reverse proxy. To modify the endpoints edit the file docker-compose.yaml, you can find it in /srv/ngwdocker in the x-shared section. Then restart the stack.

$ cd /srv/ngwdocker
$ nano docker-compose.yaml
$ docker compose up -d

Storage usage accounting#

Unlike the cloud version of NextGIS Web, storage usage accounting is disabled by default in the on-premise version. To enable it, set the following environment variable in the services.app.environment section of the docker-compose.yaml file:

NEXTGISWEB__CORE__STORAGE__ENABLED: "true"

After modifying docker-compose.yaml, restart the stack to apply the new settings, then estimate the storage usage:

$ cd /srv/ngwdocker
$ docker compose up -d
$ docker compose run --rm app nextgisweb storage estimate

Storage usage information will then be available in the NextGIS Web interface.

Note that the reported value is an estimate of the data volume, not the actual disk space used. Actual disk usage is typically somewhat higher due to overhead.

Enabling raster mosaics#

The raster mosaic component lets you work with a set of rasters as a single resource and create a single coverage from them. Since the component is experimental, it is disabled by default: its functionality may change in future versions, and the component itself may be removed. To enable it, set the following environment variable in the services.app.environment section of docker-compose.yaml:

NEXTGISWEB__ENVIRONMENT__COMPONENT__RASTER_MOSAIC: "true"

Then stop the stack, apply the migrations, and start the stack again:

$ cd /srv/ngwdocker
$ docker compose down
$ docker compose run --rm app nextgisweb migration upgrade --no-dry-run
$ docker compose up -d

Configuring the LLM provider#

AI tools in NextGIS Web, such as generating filters for the feature table in natural language, work on the BYOK (Bring Your Own Key) principle. This means that to use these features, you need to provide your own access key to the OpenAI-compatible API of the LLM provider.

You can specify the connection parameters and the model used in docker-compose.yaml in the services.app.environment section using the following environment variables:

NEXTGISWEB__LLM_CORE__BASE_URL: "https://api.openai.com/v1"
NEXTGISWEB__LLM_CORE__API_KEY: "<API key>"
NEXTGISWEB__LLM_CORE__MODEL: "gpt-4o-mini"

After making changes, you need to restart the stack with the command docker compose up -d to apply the new settings. After that, AI tools will be available in the NextGIS Web interface.

Migrating to another server#

Steps:

  1. On the source server, create an offline backup following the Create backup instructions.

  2. On the new server, install NextGIS Web following the Installation instructions.

    Important

    The version installed on the new server must match the version on the source server. Restoring a backup across different versions is not supported.

  3. Copy the backup file to the new server, for example:

$ scp /var/lib/docker/volumes/ngwdocker_backup/_data/archivist-20260117-002345.tar.zst \
     root@new-server:/var/lib/docker/volumes/ngwdocker_backup/_data/

  1. Restore the data from the backup following the Restore from backup instructions.