Skip to content

Latest commit

 

History

History
150 lines (104 loc) · 6.19 KB

README.md

File metadata and controls

150 lines (104 loc) · 6.19 KB
Raw

phpPgAdmin6

PHP Based administration tool for PostgreSQL. Blazing fast routing with Slim Framework 3 and solid abstraction layer in its core with AdoDB.

Packagist Codacy Badge Scrutinizer Code Quality Build Status License FOSSA Status Packagist PHP Version Support

This project is inspired in phppgadmin. Said project stalled a few years ago so we took it, refactored almost entirely and added:

Requirements

  • PHP 7.1+
  • PostgreSQL v9+
  • ext-psql
  • Composer

(If you're using PostgreSQL 7.4 or 8.x, or PHP 5.6+, you can still try versions RC2 and below, but you should really, realy upgrade).

Installation

Using Composer (recommended)

Install Composer in your machine.

Install with composer running the following command in your shell (replacing whith your desired folder name)

composer create-project huasofoundries/phppgadmin6 <FOLDER> v6.0.* --no-dev --prefer-dist

Alternatively, clone this repo and run (inside then folder where the project was cloned)

composer install --no-dev

Configuration

You can set the config options either in a config.inc.php (refer to config.inc.example.php for an example) AND/OR a config.yml. The use of the latter is complely optional. Keep in mind the config entries are merged giving precedence to the ones in the YAML file.

Server Blocks

Configuration has a servers entry whose details are in their on Wiki section: "Config: Servers"

Rewrite Rules

As this project is built over Slim Framework 3, you'll need some rewrite rules for nice-urls to work.

Please refer to Slim Framework 3 instructions on rewrite rules config for:

Running inside a subfolder

If you're planning to run phpPgAdmin6 under a subfolder, make sure you set it explicitly in the config file(s). I gave up trying to figure out the subfolder automatically and it's outside of this project's scope.

To set it in config.inc.php

$conf = [
  'subfolder' => '/phppga_subfolder',
  'other config...' => 'sure'
];

To set it in config.yml

default_lang: auto
subfolder: '/phppha_subfolder'

Remember that values set on the yml config take precedence.

Besides, remember to modify your webserver configuration accordingly

location /subfolder/ {
    try_files $uri $uri/ /subfolder/index.php$is_args$args;
}

Instead of

location / {
    try_files $uri $uri/ /index.php$is_args$args;
}

(Implementation details for your specific setup fall outside of this package's scope)

Installing dev branch

If there's something broken and I cannot risk breaking the rest to fix your issue, I might push a fix or feature to develop branch. Said branch can be installed as

composer create-project huasofoundries/phppgadmin6 <FOLDER> v6.*.*@beta --no-dev --prefer-dist

(or, you know, clone the repo and make sure you're in develop branch)

License

This work is licensed under MIT or GPL 2.0 (or any later version) or BSD-3-Clause You can choose between one of them if you use this work.

SPDX-License-Identifier: MIT OR GPL-2.0-or-later OR BSD-3-Clause

Credits & FAQ

We're preserving due credits to all people that contributed in the past, as well as other release notes contained in the old version of phppgadmin

Kudos to all people that helped build the original project, upon which this one was built.