]> git.proxmox.com Git - pmg-api.git/blame - src/templates/postgresql.conf.in
adapt postgresql.conf template to variable version
[pmg-api.git] / src / templates / postgresql.conf.in
CommitLineData
2005e4b3 1[% TAGS <* *> -%]
e6e4b9ac
DM
2# -----------------------------
3# PostgreSQL configuration file
4# -----------------------------
5#
6# This file consists of lines of the form:
7#
8# name = value
9#
10# (The "=" is optional.) Whitespace may be used. Comments are introduced with
11# "#" anywhere on a line. The complete list of parameter names and allowed
12# values can be found in the PostgreSQL documentation.
13#
14# The commented-out settings shown in this file represent the default values.
15# Re-commenting a setting is NOT sufficient to revert it to the default value;
16# you need to reload the server.
17#
18# This file is read on server startup and when the server receives a SIGHUP
19# signal. If you edit the file on a running system, you have to SIGHUP the
20# server for the changes to take effect, or use "pg_ctl reload". Some
21# parameters, which are marked below, require a server shutdown and restart to
22# take effect.
23#
24# Any parameter can also be given as a command-line option to the server, e.g.,
25# "postgres -c log_connections=on". Some parameters can be changed at run time
26# with the "SET" SQL command.
27#
28# Memory units: kB = kilobytes Time units: ms = milliseconds
29# MB = megabytes s = seconds
30# GB = gigabytes min = minutes
31# TB = terabytes h = hours
32# d = days
33
34
35#------------------------------------------------------------------------------
36# FILE LOCATIONS
37#------------------------------------------------------------------------------
38
39# The default values of these variables are driven from the -D command-line
40# option or PGDATA environment variable, represented here as ConfigDir.
41
2005e4b3 42data_directory = '/var/lib/postgresql/<* postgres.version *>/main' # use data in another directory
e6e4b9ac 43 # (change requires restart)
2005e4b3 44hba_file = '/etc/postgresql/<* postgres.version *>/main/pg_hba.conf' # host-based authentication file
e6e4b9ac 45 # (change requires restart)
2005e4b3 46ident_file = '/etc/postgresql/<* postgres.version *>/main/pg_ident.conf' # ident configuration file
e6e4b9ac
DM
47 # (change requires restart)
48
49# If external_pid_file is not explicitly set, no extra PID file is written.
2005e4b3 50external_pid_file = '/var/run/postgresql/<* postgres.version *>-main.pid' # write an extra PID file
e6e4b9ac
DM
51 # (change requires restart)
52
53
54#------------------------------------------------------------------------------
55# CONNECTIONS AND AUTHENTICATION
56#------------------------------------------------------------------------------
57
58# - Connection Settings -
59
60#listen_addresses = 'localhost' # what IP address(es) to listen on;
61 # comma-separated list of addresses;
62 # defaults to 'localhost'; use '*' for all
63 # (change requires restart)
64port = 5432 # (change requires restart)
65max_connections = 100 # (change requires restart)
66#superuser_reserved_connections = 3 # (change requires restart)
67unix_socket_directories = '/var/run/postgresql' # comma-separated list of directories
68 # (change requires restart)
69#unix_socket_group = '' # (change requires restart)
70#unix_socket_permissions = 0777 # begin with 0 to use octal notation
71 # (change requires restart)
72#bonjour = off # advertise server via Bonjour
73 # (change requires restart)
74#bonjour_name = '' # defaults to the computer name
75 # (change requires restart)
76
77# - Security and Authentication -
78
79#authentication_timeout = 1min # 1s-600s
80ssl = true # (change requires restart)
81#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers
82 # (change requires restart)
83#ssl_prefer_server_ciphers = on # (change requires restart)
84#ssl_ecdh_curve = 'prime256v1' # (change requires restart)
85ssl_cert_file = '/etc/ssl/certs/ssl-cert-snakeoil.pem' # (change requires restart)
86ssl_key_file = '/etc/ssl/private/ssl-cert-snakeoil.key' # (change requires restart)
87#ssl_ca_file = '' # (change requires restart)
88#ssl_crl_file = '' # (change requires restart)
89#password_encryption = on
90#db_user_namespace = off
91#row_security = on
92
93# GSSAPI using Kerberos
94#krb_server_keyfile = ''
95#krb_caseins_users = off
96
97# - TCP Keepalives -
98# see "man 7 tcp" for details
99
100#tcp_keepalives_idle = 0 # TCP_KEEPIDLE, in seconds;
101 # 0 selects the system default
102#tcp_keepalives_interval = 0 # TCP_KEEPINTVL, in seconds;
103 # 0 selects the system default
104#tcp_keepalives_count = 0 # TCP_KEEPCNT;
105 # 0 selects the system default
106
107
108#------------------------------------------------------------------------------
109# RESOURCE USAGE (except WAL)
110#------------------------------------------------------------------------------
111
112# - Memory -
113
114shared_buffers = 128MB # min 128kB
115 # (change requires restart)
116#huge_pages = try # on, off, or try
117 # (change requires restart)
118#temp_buffers = 8MB # min 800kB
119#max_prepared_transactions = 0 # zero disables the feature
120 # (change requires restart)
121# Caution: it is not advisable to set max_prepared_transactions nonzero unless
122# you actively intend to use prepared transactions.
123#work_mem = 4MB # min 64kB
124#maintenance_work_mem = 64MB # min 1MB
125#replacement_sort_tuples = 150000 # limits use of replacement selection sort
126#autovacuum_work_mem = -1 # min 1MB, or -1 to use maintenance_work_mem
127#max_stack_depth = 2MB # min 100kB
128dynamic_shared_memory_type = posix # the default is the first option
129 # supported by the operating system:
130 # posix
131 # sysv
132 # windows
133 # mmap
134 # use none to disable dynamic shared memory
135
136# - Disk -
137
138#temp_file_limit = -1 # limits per-process temp file space
139 # in kB, or -1 for no limit
140
141# - Kernel Resource Usage -
142
143#max_files_per_process = 1000 # min 25
144 # (change requires restart)
145#shared_preload_libraries = '' # (change requires restart)
146
147# - Cost-Based Vacuum Delay -
148
149#vacuum_cost_delay = 0 # 0-100 milliseconds
150#vacuum_cost_page_hit = 1 # 0-10000 credits
151#vacuum_cost_page_miss = 10 # 0-10000 credits
152#vacuum_cost_page_dirty = 20 # 0-10000 credits
153#vacuum_cost_limit = 200 # 1-10000 credits
154
155# - Background Writer -
156
157#bgwriter_delay = 200ms # 10-10000ms between rounds
158#bgwriter_lru_maxpages = 100 # 0-1000 max buffers written/round
159#bgwriter_lru_multiplier = 2.0 # 0-10.0 multiplier on buffers scanned/round
57cbf057 160#bgwriter_flush_after = 512kB # measured in pages, 0 disables
e6e4b9ac
DM
161
162# - Asynchronous Behavior -
163
164#effective_io_concurrency = 1 # 1-1000; 0 disables prefetching
165#max_worker_processes = 8 # (change requires restart)
166#max_parallel_workers_per_gather = 0 # taken from max_worker_processes
167#old_snapshot_threshold = -1 # 1min-60d; -1 disables; 0 is immediate
57cbf057
DM
168 # (change requires restart)
169#backend_flush_after = 0 # measured in pages, 0 disables
e6e4b9ac
DM
170
171
172#------------------------------------------------------------------------------
173# WRITE AHEAD LOG
174#------------------------------------------------------------------------------
175
176# - Settings -
177
178#wal_level = minimal # minimal, replica, or logical
179 # (change requires restart)
180#fsync = on # flush data to disk for crash safety
181 # (turning this off can cause
182 # unrecoverable data corruption)
183#synchronous_commit = on # synchronization level;
184 # off, local, remote_write, remote_apply, or on
185#wal_sync_method = fsync # the default is the first option
186 # supported by the operating system:
187 # open_datasync
188 # fdatasync (default on Linux)
189 # fsync
190 # fsync_writethrough
191 # open_sync
192#full_page_writes = on # recover from partial page writes
193#wal_compression = off # enable compression of full-page writes
194#wal_log_hints = off # also do full page writes of non-critical updates
195 # (change requires restart)
196#wal_buffers = -1 # min 32kB, -1 sets based on shared_buffers
197 # (change requires restart)
198#wal_writer_delay = 200ms # 1-10000 milliseconds
57cbf057 199#wal_writer_flush_after = 1MB # measured in pages, 0 disables
e6e4b9ac
DM
200
201#commit_delay = 0 # range 0-100000, in microseconds
202#commit_siblings = 5 # range 1-1000
203
204# - Checkpoints -
205
206#checkpoint_timeout = 5min # range 30s-1d
207#max_wal_size = 1GB
208#min_wal_size = 80MB
209#checkpoint_completion_target = 0.5 # checkpoint target duration, 0.0 - 1.0
57cbf057 210#checkpoint_flush_after = 256kB # measured in pages, 0 disables
e6e4b9ac
DM
211#checkpoint_warning = 30s # 0 disables
212
213# - Archiving -
214
215#archive_mode = off # enables archiving; off, on, or always
216 # (change requires restart)
217#archive_command = '' # command to use to archive a logfile segment
218 # placeholders: %p = path of file to archive
219 # %f = file name only
220 # e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f'
221#archive_timeout = 0 # force a logfile segment switch after this
222 # number of seconds; 0 disables
223
224
225#------------------------------------------------------------------------------
226# REPLICATION
227#------------------------------------------------------------------------------
228
229# - Sending Server(s) -
230
231# Set these on the master and on any standby that will send replication data.
232
233#max_wal_senders = 0 # max number of walsender processes
234 # (change requires restart)
235#wal_keep_segments = 0 # in logfile segments, 16MB each; 0 disables
236#wal_sender_timeout = 60s # in milliseconds; 0 disables
237
238#max_replication_slots = 0 # max number of replication slots
239 # (change requires restart)
240#track_commit_timestamp = off # collect timestamp of transaction commit
241 # (change requires restart)
242
243# - Master Server -
244
245# These settings are ignored on a standby server.
246
247#synchronous_standby_names = '' # standby servers that provide sync rep
248 # number of sync standbys and comma-separated list of application_name
249 # from standby(s); '*' = all
250#vacuum_defer_cleanup_age = 0 # number of xacts by which cleanup is delayed
251
252# - Standby Servers -
253
254# These settings are ignored on a master server.
255
256#hot_standby = off # "on" allows queries during recovery
257 # (change requires restart)
258#max_standby_archive_delay = 30s # max delay before canceling queries
259 # when reading WAL from archive;
260 # -1 allows indefinite delay
261#max_standby_streaming_delay = 30s # max delay before canceling queries
262 # when reading streaming WAL;
263 # -1 allows indefinite delay
264#wal_receiver_status_interval = 10s # send replies at least this often
265 # 0 disables
266#hot_standby_feedback = off # send info from standby to prevent
267 # query conflicts
268#wal_receiver_timeout = 60s # time that receiver waits for
269 # communication from master
270 # in milliseconds; 0 disables
271#wal_retrieve_retry_interval = 5s # time to wait before retrying to
272 # retrieve WAL after a failed attempt
273
274
275#------------------------------------------------------------------------------
276# QUERY TUNING
277#------------------------------------------------------------------------------
278
279# - Planner Method Configuration -
280
281#enable_bitmapscan = on
282#enable_hashagg = on
283#enable_hashjoin = on
284#enable_indexscan = on
285#enable_indexonlyscan = on
286#enable_material = on
287#enable_mergejoin = on
288#enable_nestloop = on
289#enable_seqscan = on
290#enable_sort = on
291#enable_tidscan = on
292
293# - Planner Cost Constants -
294
295#seq_page_cost = 1.0 # measured on an arbitrary scale
296#random_page_cost = 4.0 # same scale as above
297#cpu_tuple_cost = 0.01 # same scale as above
298#cpu_index_tuple_cost = 0.005 # same scale as above
299#cpu_operator_cost = 0.0025 # same scale as above
300#parallel_tuple_cost = 0.1 # same scale as above
301#parallel_setup_cost = 1000.0 # same scale as above
302#min_parallel_relation_size = 8MB
303#effective_cache_size = 4GB
304
305# - Genetic Query Optimizer -
306
307#geqo = on
308#geqo_threshold = 12
309#geqo_effort = 5 # range 1-10
310#geqo_pool_size = 0 # selects default based on effort
311#geqo_generations = 0 # selects default based on effort
312#geqo_selection_bias = 2.0 # range 1.5-2.0
313#geqo_seed = 0.0 # range 0.0-1.0
314
315# - Other Planner Options -
316
317#default_statistics_target = 100 # range 1-10000
318#constraint_exclusion = partition # on, off, or partition
319#cursor_tuple_fraction = 0.1 # range 0.0-1.0
320#from_collapse_limit = 8
321#join_collapse_limit = 8 # 1 disables collapsing of explicit
322 # JOIN clauses
323#force_parallel_mode = off
324
325
326#------------------------------------------------------------------------------
327# ERROR REPORTING AND LOGGING
328#------------------------------------------------------------------------------
329
330# - Where to Log -
331
332#log_destination = 'stderr' # Valid values are combinations of
333 # stderr, csvlog, syslog, and eventlog,
334 # depending on platform. csvlog
335 # requires logging_collector to be on.
336
337# This is used when logging to stderr:
338#logging_collector = off # Enable capturing of stderr and csvlog
339 # into log files. Required to be on for
340 # csvlogs.
341 # (change requires restart)
342
343# These are only used if logging_collector is on:
344#log_directory = 'pg_log' # directory where log files are written,
345 # can be absolute or relative to PGDATA
346#log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log' # log file name pattern,
347 # can include strftime() escapes
348#log_file_mode = 0600 # creation mode for log files,
349 # begin with 0 to use octal notation
350#log_truncate_on_rotation = off # If on, an existing log file with the
351 # same name as the new log file will be
352 # truncated rather than appended to.
353 # But such truncation only occurs on
354 # time-driven rotation, not on restarts
355 # or size-driven rotation. Default is
356 # off, meaning append to existing files
357 # in all cases.
358#log_rotation_age = 1d # Automatic rotation of logfiles will
359 # happen after that time. 0 disables.
360#log_rotation_size = 10MB # Automatic rotation of logfiles will
361 # happen after that much log output.
362 # 0 disables.
363
364# These are relevant when logging to syslog:
365#syslog_facility = 'LOCAL0'
366#syslog_ident = 'postgres'
367#syslog_sequence_numbers = on
368#syslog_split_messages = on
369
370# This is only relevant when logging to eventlog (win32):
371#event_source = 'PostgreSQL'
372
373# - When to Log -
374
375#client_min_messages = notice # values in order of decreasing detail:
376 # debug5
377 # debug4
378 # debug3
379 # debug2
380 # debug1
381 # log
382 # notice
383 # warning
384 # error
385
386#log_min_messages = warning # values in order of decreasing detail:
387 # debug5
388 # debug4
389 # debug3
390 # debug2
391 # debug1
392 # info
393 # notice
394 # warning
395 # error
396 # log
397 # fatal
398 # panic
399
400#log_min_error_statement = error # values in order of decreasing detail:
401 # debug5
402 # debug4
403 # debug3
404 # debug2
405 # debug1
406 # info
407 # notice
408 # warning
409 # error
410 # log
411 # fatal
412 # panic (effectively off)
413
414#log_min_duration_statement = -1 # -1 is disabled, 0 logs all statements
415 # and their durations, > 0 logs only
416 # statements running at least this number
417 # of milliseconds
418
419
420# - What to Log -
421
422#debug_print_parse = off
423#debug_print_rewritten = off
424#debug_print_plan = off
425#debug_pretty_print = on
426#log_checkpoints = off
427#log_connections = off
428#log_disconnections = off
429#log_duration = off
430#log_error_verbosity = default # terse, default, or verbose messages
431#log_hostname = off
57cbf057 432log_line_prefix = '%m [%p] %q%u@%d ' # special values:
e6e4b9ac
DM
433 # %a = application name
434 # %u = user name
435 # %d = database name
436 # %r = remote host and port
437 # %h = remote host
438 # %p = process ID
439 # %t = timestamp without milliseconds
440 # %m = timestamp with milliseconds
441 # %n = timestamp with milliseconds (as a Unix epoch)
442 # %i = command tag
443 # %e = SQL state
444 # %c = session ID
445 # %l = session line number
446 # %s = session start timestamp
447 # %v = virtual transaction ID
448 # %x = transaction ID (0 if none)
449 # %q = stop here in non-session
450 # processes
451 # %% = '%'
452 # e.g. '<%u%%%d> '
453#log_lock_waits = off # log lock waits >= deadlock_timeout
454#log_statement = 'none' # none, ddl, mod, all
455#log_replication_commands = off
456#log_temp_files = -1 # log temporary files equal or larger
457 # than the specified size in kilobytes;
458 # -1 disables, 0 logs all temp files
459log_timezone = 'localtime'
460
461
462# - Process Title -
463
2005e4b3 464cluster_name = '<* postgres.version *>/main' # added to process titles if nonempty
e6e4b9ac
DM
465 # (change requires restart)
466#update_process_title = on
467
468
469#------------------------------------------------------------------------------
470# RUNTIME STATISTICS
471#------------------------------------------------------------------------------
472
473# - Query/Index Statistics Collector -
474
475#track_activities = on
476#track_counts = on
477#track_io_timing = off
478#track_functions = none # none, pl, all
479#track_activity_query_size = 1024 # (change requires restart)
2005e4b3 480stats_temp_directory = '/var/run/postgresql/<* postgres.version *>-main.pg_stat_tmp'
e6e4b9ac
DM
481
482
483# - Statistics Monitoring -
484
485#log_parser_stats = off
486#log_planner_stats = off
487#log_executor_stats = off
488#log_statement_stats = off
489
490
491#------------------------------------------------------------------------------
492# AUTOVACUUM PARAMETERS
493#------------------------------------------------------------------------------
494
495#autovacuum = on # Enable autovacuum subprocess? 'on'
496 # requires track_counts to also be on.
497#log_autovacuum_min_duration = -1 # -1 disables, 0 logs all actions and
498 # their durations, > 0 logs only
499 # actions running at least this number
500 # of milliseconds.
501#autovacuum_max_workers = 3 # max number of autovacuum subprocesses
502 # (change requires restart)
503#autovacuum_naptime = 1min # time between autovacuum runs
504#autovacuum_vacuum_threshold = 50 # min number of row updates before
505 # vacuum
506#autovacuum_analyze_threshold = 50 # min number of row updates before
507 # analyze
508#autovacuum_vacuum_scale_factor = 0.2 # fraction of table size before vacuum
509#autovacuum_analyze_scale_factor = 0.1 # fraction of table size before analyze
510#autovacuum_freeze_max_age = 200000000 # maximum XID age before forced vacuum
511 # (change requires restart)
512#autovacuum_multixact_freeze_max_age = 400000000 # maximum multixact age
513 # before forced vacuum
514 # (change requires restart)
515#autovacuum_vacuum_cost_delay = 20ms # default vacuum cost delay for
516 # autovacuum, in milliseconds;
517 # -1 means use vacuum_cost_delay
518#autovacuum_vacuum_cost_limit = -1 # default vacuum cost limit for
519 # autovacuum, -1 means use
520 # vacuum_cost_limit
521
522
523#------------------------------------------------------------------------------
524# CLIENT CONNECTION DEFAULTS
525#------------------------------------------------------------------------------
526
527# - Statement Behavior -
528
529#search_path = '"$user", public' # schema names
530#default_tablespace = '' # a tablespace name, '' uses the default
531#temp_tablespaces = '' # a list of tablespace names, '' uses
532 # only default tablespace
533#check_function_bodies = on
534#default_transaction_isolation = 'read committed'
535#default_transaction_read_only = off
536#default_transaction_deferrable = off
537#session_replication_role = 'origin'
538#statement_timeout = 0 # in milliseconds, 0 is disabled
539#lock_timeout = 0 # in milliseconds, 0 is disabled
540#idle_in_transaction_session_timeout = 0 # in milliseconds, 0 is disabled
541#vacuum_freeze_min_age = 50000000
542#vacuum_freeze_table_age = 150000000
543#vacuum_multixact_freeze_min_age = 5000000
544#vacuum_multixact_freeze_table_age = 150000000
545#bytea_output = 'hex' # hex, escape
546#xmlbinary = 'base64'
547#xmloption = 'content'
548#gin_fuzzy_search_limit = 0
549#gin_pending_list_limit = 4MB
550
551# - Locale and Formatting -
552
553datestyle = 'iso, mdy'
554#intervalstyle = 'postgres'
555timezone = 'localtime'
556#timezone_abbreviations = 'Default' # Select the set of available time zone
557 # abbreviations. Currently, there are
558 # Default
559 # Australia (historical usage)
560 # India
561 # You can create your own file in
562 # share/timezonesets/.
563#extra_float_digits = 0 # min -15, max 3
564#client_encoding = sql_ascii # actually, defaults to database
565 # encoding
566
567# These settings are initialized by initdb, but they can be changed.
568lc_messages = 'en_US.UTF-8' # locale for system error message
569 # strings
570lc_monetary = 'en_US.UTF-8' # locale for monetary formatting
571lc_numeric = 'en_US.UTF-8' # locale for number formatting
572lc_time = 'en_US.UTF-8' # locale for time formatting
573
574# default configuration for text search
575default_text_search_config = 'pg_catalog.english'
576
577# - Other Defaults -
578
579#dynamic_library_path = '$libdir'
580#local_preload_libraries = ''
581#session_preload_libraries = ''
582
583
584#------------------------------------------------------------------------------
585# LOCK MANAGEMENT
586#------------------------------------------------------------------------------
587
588#deadlock_timeout = 1s
589#max_locks_per_transaction = 64 # min 10
590 # (change requires restart)
591#max_pred_locks_per_transaction = 64 # min 10
592 # (change requires restart)
593
594
595#------------------------------------------------------------------------------
596# VERSION/PLATFORM COMPATIBILITY
597#------------------------------------------------------------------------------
598
599# - Previous PostgreSQL Versions -
600
601#array_nulls = on
602#backslash_quote = safe_encoding # on, off, or safe_encoding
603#default_with_oids = off
604#escape_string_warning = on
605#lo_compat_privileges = off
606#operator_precedence_warning = off
607#quote_all_identifiers = off
608#sql_inheritance = on
609#standard_conforming_strings = on
610#synchronize_seqscans = on
611
612# - Other Platforms and Clients -
613
614#transform_null_equals = off
615
616
617#------------------------------------------------------------------------------
618# ERROR HANDLING
619#------------------------------------------------------------------------------
620
621#exit_on_error = off # terminate session on any error?
622#restart_after_crash = on # reinitialize after backend crash?
623
624
625#------------------------------------------------------------------------------
626# CONFIG FILE INCLUDES
627#------------------------------------------------------------------------------
628
629# These options allow settings to be loaded from files other than the
630# default postgresql.conf.
631
632#include_dir = 'conf.d' # include files ending in '.conf' from
633 # directory 'conf.d'
634#include_if_exists = 'exists.conf' # include file only if it exists
635#include = 'special.conf' # include file
636
637
638#------------------------------------------------------------------------------
639# CUSTOMIZED OPTIONS
640#------------------------------------------------------------------------------
641
642# Add settings for extensions here