tinslice/postgres repository overview

⁠docker-postgres

Postgresql docker image with database configuration based on environment variables.

⁠Usage

⁠Change Postgres default configuration.

To overwrite the Postgres default configuration you need to mount the folder containing the custom Postgres config to /etc/postgresql/<pg-version>/main/conf.d.

⁠Run scripts to initialise database

• /etc/postgresql/scripts Location of custom defined scripts that the user can execute through environment variables.

⁠Environment variables

• PGDATA overrides the default ('/var/lib/postgresql/data') data directory

• POSTGRES_PASSWORD set the password for the postgresql user

• POSTGRES_ROLES postgres group roles. Example config:

  [
    {
      "name": "role_ts_admin",
      "privileges": "NOINHERIT"
    },
    {
      "name": "role_ts_write",
      "privileges": "INHERIT"
    },
    {
      "name": "role_ts_read"
    }
  ]
  

  Copy

• POSTGRES_USERS postgres users (roles). Example config:

  [
    {
      "name": "ts_admin",
      "password": "changeit",
      "roles": ["role_ts_admin"]
    },
    {
      "name": "ts_owner",
      "password": "changeit"
    },
    {
      "name": "ts_read",
      "password": "changeit_read_only",
      "roles": ["role_ts_read"]
    },
    {
      "name": "ts_test_user",
      "password": "changeit"
    }        
  ]
  

  Copy

• POSTGRES_DB configuration for auto creation of databases and user access. It also allows the posibillity to run scripts once, when the database is created. Example config:

  {
    "ts_demo": {
      "roles": [
        {
          "name": "ts_owner",
          "owner": "true"
        },
        {
          "name": "ts_test_user",
          "privileges": "ALL"
        },
        {
          "name": "role_ts_admin",
          "schemas": [
            { "name": "public", "privileges": "ALL" }
          ]
        },
        {
          "name": "role_ts_write",
          "schemas": [
            { "name": "public", "privileges": "SELECT,INSERT,UPDATE,DELETE,EXECUTE" }
          ]
        },
        {
          "name": "role_ts_read",
          "schemas": [
            {
              "name": "public",
              "tables": [
                { "name": "*", "privileges": "SELECT" }
              ],
              "sequences": [
                { "name": "*", "privileges": "SELECT" }
              ],
              "functions": [
                { "name": "*", "privileges": "EXECUTE" }
              ]
            }
          ]
        }
      ],
      "init": ["init_db"]
    }
  }
  

  Copy

• POSTGRES_RUN_SCRIPTS run scripts on specific databases each time the container starts. The script can be run as postgres or as specific user by specifying the sql file in the following format: <db-role>:<sql-file>. Example config:

  {
    "ts_demo": [ "ts_owner:run_at_start" ]
  }
  

  Copy

• POSTGRES_RUN_SQL run sql statements on specific databases each time the container starts. Example config:

  {
    "postgres": [
  
    ],
    "ts_demo": [
      "delete from public._marker_test;",
      "insert into public._marker_test values(''ts_demo'');"
    ]
  }
  

  Copy

Complete examples can be found in the example⁠ folder.