0. About this guide

By the end of this chapter: You know what this guide covers and which topics need another guide.

Audience

  • Engineers who install and run GritDB 1.1 for the first time
  • This guide assumes experience with the Linux shell and basic PostgreSQL experience (connecting with psql and running SQL).

What this guide covers

Chapter Content Time
1 GritDB at a glance 10 min (reading)
2 Preparation and checks before installation 30 min
3 Installation 20 min
4 Start, check, and stop 30 min
5 Daily checks 10 min
6 Rules you must follow 10 min (reading)
7 When problems occur As needed
A Command reference card —

What this guide does not cover

Topic See
Change the installation directory, data volume, or port; install as root Admin, chapter 2
Reinitialization, upgrade, and removal Admin, chapter 3
Configuration and tuning by server size Admin, chapter 5
Monitoring thresholds, weekly checks, and monthly checks Admin, chapter 7
Backup and restore Admin, chapter 8
Full error list and in-depth diagnosis TroubleShooting

Standard paths

All commands in this guide assume the values below. To use other values, read Admin, chapter 2 first.

Item Value
Service account gritdb
Installation directory /home/gritdb/gritdb1 (~/gritdb1)
PostgreSQL port 5432
Location of delivered files /home/gritdb/pkg (~/pkg)

Conventions

  • Copy and run command blocks as they are. They do not include a prompt ($, #).
  • The run-as account appears right above the command block. If none appears, use the gritdb account.
  • Expected output is the screen you see when everything is normal. The <...> parts differ by environment.
  • For commands that print nothing, this guide writes “No output is normal.”
  • Numbers that start with GDB- are error entry numbers in chapter 7. TroubleShooting uses the same numbers.
  • ⚠ marks an action you cannot undo, or a prohibition.
  • Admin — general operations
  • TroubleShooting — failure diagnosis
  • Release notes — docs/RELEASE-NOTES.md in the installation directory

Support

If you cannot solve a problem, collect diagnostic data with the procedure in section 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.