2014-10-08 21:29:43 -05:00
|
|
|
# pgweb
|
|
|
|
|
|
2014-10-10 21:06:08 -05:00
|
|
|
Web-based PostgreSQL database browser written in Go.
|
2014-10-08 21:29:43 -05:00
|
|
|
|
2014-12-09 19:49:29 -06:00
|
|
|
[](https://github.com/sosedoff/pgweb/releases)
|
|
|
|
|
[](https://travis-ci.org/sosedoff/pgweb)
|
2014-10-27 22:12:56 -05:00
|
|
|
|
2014-10-13 21:02:04 -05:00
|
|
|
## Overview
|
|
|
|
|
|
2014-12-29 20:03:35 -06:00
|
|
|
Pgweb is a web-based database browser for PostgreSQL, written in Go and works
|
|
|
|
|
on OSX, Linux and Windows machines. Main idea behind using Go for backend development
|
|
|
|
|
is to utilize ability of the compiler to produce zero-dependency binaries for
|
|
|
|
|
multiple platforms. Pgweb was created as an attempt to build very simple and portable
|
|
|
|
|
application to work with local or remote PostgreSQL databases.
|
2014-10-13 21:02:04 -05:00
|
|
|
|
2014-10-14 11:34:22 -05:00
|
|
|
<img src="screenshots/browse.png" width="345px" />
|
|
|
|
|
<img src="screenshots/query.png" width="345px" />
|
|
|
|
|
|
2014-12-29 20:03:35 -06:00
|
|
|
## Features
|
2014-10-23 09:11:40 -06:00
|
|
|
|
2014-12-29 20:03:35 -06:00
|
|
|
- Works on OSX, Linux and Windows
|
|
|
|
|
- Zero dependencies
|
|
|
|
|
- Simple installation (distributes as a single binary)
|
|
|
|
|
- Connect to local or remote servers
|
|
|
|
|
- Browse tables and table data
|
|
|
|
|
- Get table details: structure, size, indeces, row count
|
|
|
|
|
- Run / analyze custom queries
|
2014-10-23 09:11:40 -06:00
|
|
|
- Export query results to CSV
|
2014-12-29 20:03:35 -06:00
|
|
|
- Query history
|
|
|
|
|
- Server bookmarks
|
2014-10-23 09:11:40 -06:00
|
|
|
|
2014-12-29 20:03:35 -06:00
|
|
|
Visit [WIKI](https://github.com/sosedoff/pgweb/wiki) for more details
|
2014-10-16 17:42:40 -05:00
|
|
|
|
2014-12-10 23:41:45 -06:00
|
|
|
## Installation
|
2014-10-29 11:58:32 -07:00
|
|
|
|
2014-12-10 23:42:24 -06:00
|
|
|
[Precompiled binaries](https://github.com/sosedoff/pgweb/releases) for supported
|
2014-12-10 23:41:45 -06:00
|
|
|
operating systems are available.
|
2014-10-29 11:58:32 -07:00
|
|
|
|
2014-12-29 20:03:35 -06:00
|
|
|
[More installation options](https://github.com/sosedoff/pgweb/wiki/Installation)
|
2014-12-10 23:43:17 -06:00
|
|
|
|
2014-10-08 21:29:43 -05:00
|
|
|
## Usage
|
|
|
|
|
|
2014-10-13 21:03:42 -05:00
|
|
|
Start server:
|
|
|
|
|
|
2014-11-07 18:12:08 -06:00
|
|
|
```
|
|
|
|
|
pgweb
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
You can also provide connection flags:
|
|
|
|
|
|
2014-10-13 21:03:42 -05:00
|
|
|
```
|
2014-10-14 10:52:40 -05:00
|
|
|
pgweb --host localhost --user myuser --db mydb
|
2014-10-13 21:03:42 -05:00
|
|
|
```
|
|
|
|
|
|
2014-11-07 18:12:08 -06:00
|
|
|
Connection URL scheme is also supported:
|
2014-10-13 21:02:04 -05:00
|
|
|
|
|
|
|
|
```
|
2014-11-07 18:12:08 -06:00
|
|
|
pgweb --url postgres://user:password@host:port/database?sslmode=[mode]
|
2014-10-13 21:02:04 -05:00
|
|
|
```
|
|
|
|
|
|
2014-12-10 23:41:45 -06:00
|
|
|
## Deploy on Heroku
|
2014-12-04 23:35:25 -06:00
|
|
|
|
2014-12-10 23:41:45 -06:00
|
|
|
[](https://heroku.com/deploy?template=https://github.com/sosedoff/pgweb)
|
2014-11-07 18:12:08 -06:00
|
|
|
|
2014-12-29 20:03:35 -06:00
|
|
|
## Contribute
|
2014-11-07 18:12:08 -06:00
|
|
|
|
|
|
|
|
- Fork repository
|
|
|
|
|
- Create a feature or bugfix branch
|
|
|
|
|
- Open a new pull request
|
2014-12-29 20:03:35 -06:00
|
|
|
- Use [github issues](https://github.com/sosedoff/pgweb/issues) for any questions
|
2014-11-03 14:35:56 +08:00
|
|
|
|
2014-11-07 18:12:08 -06:00
|
|
|
## Contact
|
2014-10-13 21:02:04 -05:00
|
|
|
|
2014-11-07 18:12:08 -06:00
|
|
|
- Dan Sosedoff
|
|
|
|
|
- [dan.sosedoff@gmail.com](mailto:dan.sosedoff@gmail.com)
|
|
|
|
|
- [http://twitter.com/sosedoff](http://twitter.com/sosedoff)
|
2014-10-13 21:02:04 -05:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
The MIT License (MIT)
|
|
|
|
|
|
2014-12-31 18:33:06 -06:00
|
|
|
Copyright (c) 2014-2015 Dan Sosedoff, <dan.sosedoff@gmail.com>
|
