pgweb/README.md
2014-10-14 11:34:22 -05:00

1.9 KiB

pgweb

Web-based PostgreSQL database browser written in Go.

Overview

This is a web-based browser for PostgreSQL database server. Its written in Go and works on Mac OSX, Linux and Windows machines. Main idea behind using Go for the backend is to utilize language's ability for cross-compile source code for multiple platforms. This project is an attempt to create a very simple and portable application to work with PostgreSQL databases.

Installation

Please visit Github Releases to download a precompiled binary for your operating system.

Currently supported:

  • Mac OSX 64bit
  • Linux 32/64bit
  • Windows 32/64bit

Usage

Start server:

pgweb --host localhost --user myuser --db mydb

You can also specify a connection URI instead of individual flags:

pgweb --url postgresql://user:password@host:port/database

It works great with Heroku Postgres if you need to troubleshoot production database or simply run a few queries.

CLI

CLI options:

Usage:
  pgweb [OPTIONS]

Application Options:
  -d          Enable debugging mode (false)
      --url=  Database connection string
      --host= Server hostname or IP (localhost)
      --port= Server port (5432)
      --user= Database user (postgres)
      --db=   Database name (postgres)
      --ssl=  SSL option (disable)

Compile from source

Go 1.3+ is required. You can install Go with homebrew:

brew install go

To compile source code run the following command:

make deps
make dev

This will produce pgweb binary in the current directory.

Contributors

License

The MIT License (MIT)

Copyright (c) 2014 Dan Sosedoff, dan.sosedoff@gmail.com