0. About this guide

By the end of this chapter: You know what the Admin guide covers and which chapter to use for each task.

Audience

Engineers who operate GritDB 1.1 on their own
This guide assumes that you have completed all chapters of QuickStart. That is, you have done the installation, start, stop, and daily check once.

Chapter	Content
1	Installation planning — setup types, specifications, OS settings, disk layout, and bringing in files
2	Installation details — all options, paths, data volume, port, and installing as root
3	Reinitialization, upgrade, and removal
4	Start and stop operations
5	Configuration
6	Database and table operations — registration, analytics setup, and analytics session
7	Monitoring and routine checks
8	Backup and restore
9	Log management
10	Limitations
11	Security
A	Reference — options, configuration, SQL functions, logs, directories, diagnostic queries, and glossary

Task map

When you first take over operations, read the chapters in this order: 1 → 2 → 5 → 11 → 10 → 6 → 7 → 8. Chapter 10 covers where GritDB behaves differently from PostgreSQL, and the operating rules you must follow.
Order for a new installation on a production server: chapter 1 (planning, OS settings, and the 1.9 checklist) → QuickStart, chapter 2 (account, verification of the delivered files, and server checklist) → installation command (the line below the 1.9 table, and chapter 2) → QuickStart 3.2 and 3.3 (confirm the installation) → 2.10 (start, authentication, permissions, configuration, start at boot, and backup)
Chapter numbers are fixed as the numbers that QuickStart points to.

Task	When	Command and tool	Chapter
Choose the server and setup	Before installation	Planning checklist	1
Non-standard installation	At installation	`install_gritdb.sh` options	2
Set up authentication and remote connections	Right after installation	`pg_hba.conf` and `listen_addresses`	11
Change the configuration	As needed	`ALTER SYSTEM` and `config/grit_*.config`	5
Register tables and connect an analytics setup	As needed	`register_gritsurfer_table` and `CREATE SUBSCRIPTION`	6
Load data and manage analytic queries	As needed	`COPY` and `get_gritsurfer_active_queries()`	6.8 and 6.9
Checks and maintenance	Daily, weekly, and monthly	Routine checklist, diagnostic queries, and VACUUM monitoring	7 and A.6
OS patches and reboot	At a planned time	Normal stop → work → start	4.7
Backup	On a set schedule	Stop, then copy `datafiles/`	8
Log and core file cleanup	Weekly or monthly	Rotation and cleanup	9
Patch and upgrade	New installation package	`install_gritdb.sh` in the newly extracted directory	3
Moving to another server and standby servers	At a planned time	Offline backup, restore, and take the analytics setup again	8.7
Security check and audit	Before production and periodically	Security checklist and log settings	11.9 and 11.10
Failure	When it occurs	QuickStart, chapter 7 → save the state → contact support (chapter 0)	“If a problem occurs” in chapter 7, and 9.7

What this guide does not cover

Topic	See
Standard procedure for a first installation	QuickStart
All error entries, diagnosis by symptom, and details of diagnostic data collection	TroubleShooting
Changes by version	`docs/RELEASE-NOTES.md` in the installation directory

If you did not receive TroubleShooting, read references to it in this guide as contact support (“Contact support” below).

Conventions

The conventions are the same as in QuickStart, chapter 0. A section that uses values other than the standard paths (the gritdb account, ~/gritdb1, and port 5432) states them at the start of the section.

Applicable version

This guide is based on the GritDB 1.1 installation package for official release (release).
To check the version number of the installation, run jq -r .product_version ~/gritdb1/share/gritdb/manifest.json. It returns 1.1.
The PostgreSQL version included in GritDB 1.1 is PostgreSQL 17.11. You do not install it separately. To check, run jq -r .db_version ~/gritdb1/share/gritdb/manifest.json. It returns 17.11.
For behavior, configuration keys, and commands that PostgreSQL defines, see the official PostgreSQL 17 documentation. Each chapter links to it at the relevant place. This guide describes where GritDB behaves differently from PostgreSQL (10.3).
gritsurfer_version() returns the version of the extension SQL. It can differ from the version number, so check the version number with the command above.

Confirm that the installation is an official release.

jq -r .channel ~/gritdb1/share/gritdb/manifest.json
ls -d ~/gritdb1/run/gritdb ~/gritdb1/tools ~/gritdb1/.bashrc ~/gritdb1/build 2>/dev/null

It is normal if the first command prints release and the second command prints nothing.
If you see dev, or if the second command prints a path, it is a development package. Do not use that package. Get the official release installation package from where you bought GritDB.

License and open source notices

1.1 has no license key, license file, or license check communication. On a network without internet access, you install and operate GritDB with the same procedures.
The subscription scope (number of servers, Units) follows the contract documents.
The included open source licenses are in licenses/THIRD_PARTY_LICENSES in the installation directory. They are the same as licenses/ in the installation package.

Revision history

Edition	Changes
GritDB 1.1, first edition	First published

The procedure to upgrade from 1.0 is in 3.4 and 3.5.

Contact support

If you cannot solve a problem, collect diagnostic data with the procedure in QuickStart 7.4, then contact Datagrit. If you bought GritDB from a distributor or partner, contact that company first. That company escalates the problem to Datagrit when needed.

The contact is the technical support contact you received when you bought GritDB or signed the contract. If you bought GritDB from a distributor or partner, the contact is that company.
Report the record from QuickStart 7.4 step 3, the version number, and the name of the bundle you send. Check the version number with jq -r .product_version ~/gritdb1/share/gritdb/manifest.json. The bundle name is $S.masked.tar.gz from 9.7.

In this guide, “contact support (chapter 0)” means the route in this section.