mirror of
https://github.com/sosedoff/pgweb.git
synced 2024-12-15 11:52:12 +03:00
142 lines
4.0 KiB
Markdown
142 lines
4.0 KiB
Markdown
# pgweb
|
|
|
|
Web-based PostgreSQL database browser written in Go.
|
|
|
|
[](https://github.com/sosedoff/pgweb/releases)
|
|
[](https://travis-ci.org/sosedoff/pgweb)
|
|
[](https://ci.appveyor.com/project/sosedoff/pgweb)
|
|
[](https://goreportcard.com/report/github.com/sosedoff/pgweb)
|
|
[](https://godoc.org/github.com/sosedoff/pgweb)
|
|
|
|
## Overview
|
|
|
|
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.
|
|
|
|
[See application screenshots](SCREENS.md)
|
|
|
|
## Features
|
|
|
|
- Cross-platform support OSX/Linux/Windows 32/64-bit
|
|
- Simple installation (distributed as a single binary)
|
|
- Zero dependencies
|
|
- Works with PostgreSQL 9.1+
|
|
- SSH Connections
|
|
- Multiple database sessions
|
|
- Simple database browser
|
|
- Execute and analyze custom SQL queries
|
|
- Table and query data export to CSV/JSON/XML
|
|
- Query history
|
|
- Server bookmarks
|
|
|
|
Visit [WIKI](https://github.com/sosedoff/pgweb/wiki) for more details
|
|
|
|
## Demo
|
|
|
|
Visit https://pgweb-demo.herokuapp.com to see pgweb in action.
|
|
|
|
## Installation
|
|
|
|
[Precompiled binaries](https://github.com/sosedoff/pgweb/releases) for supported
|
|
operating systems are available.
|
|
|
|
[More installation options](https://github.com/sosedoff/pgweb/wiki/Installation)
|
|
|
|
## Usage
|
|
|
|
Start server:
|
|
|
|
```
|
|
pgweb
|
|
```
|
|
|
|
You can also provide connection flags:
|
|
|
|
```
|
|
pgweb --host localhost --user myuser --db mydb
|
|
```
|
|
|
|
Connection URL scheme is also supported:
|
|
|
|
```
|
|
pgweb --url postgres://user:password@host:port/database?sslmode=[mode]
|
|
```
|
|
|
|
### Multiple database sessions
|
|
|
|
To enable multiple database sessions in pgweb, start the server with:
|
|
|
|
```
|
|
pgweb --sessions
|
|
```
|
|
|
|
Or set environment variable:
|
|
|
|
```
|
|
SESSIONS=1 pgweb
|
|
```
|
|
|
|
## Deploy on Heroku
|
|
|
|
[](https://heroku.com/deploy?template=https://github.com/sosedoff/pgweb)
|
|
|
|
## Testing
|
|
|
|
Before running tests, make sure you have PostgreSQL server running on `localhost:5432`
|
|
interface. Also, you must have `postgres` user that could create new databases
|
|
in your local environment. Pgweb server should not be running at the same time.
|
|
|
|
Execute test suite:
|
|
|
|
```
|
|
make test
|
|
```
|
|
|
|
If you're using Docker locally, you might also run pgweb test suite against
|
|
all supported PostgreSQL version with a single command:
|
|
|
|
```
|
|
make test-all
|
|
```
|
|
|
|
## Contribute
|
|
|
|
- Fork this repository
|
|
- Create a new feature branch for a new functionality or bugfix
|
|
- Commit your changes
|
|
- Execute test suite
|
|
- Push your code and open a new pull request
|
|
- Use [issues](https://github.com/sosedoff/pgweb/issues) for any questions
|
|
- Check [wiki](https://github.com/sosedoff/pgweb/wiki) for extra documentation
|
|
|
|
## Premium Features
|
|
|
|
If you or your company would like to sponsor a custom feature, please let me know
|
|
via email (see contact section). Custom features are developed exclusively for the
|
|
client and not committed to the public repo.
|
|
|
|
## Donations
|
|
|
|
Pgweb is free and open source software, there's no plan to make a business out of it.
|
|
If you wish to support the development, you can send a donation of any size using
|
|
the following platforms:
|
|
|
|
- Paypal: dan.sosedoff@gmail.com
|
|
- Bitcoin: 1qAGohEhuNEkJEhHyEQfLgXAwY7dWRhmU
|
|
|
|
Any contribution is much appreciated.
|
|
|
|
## Contact
|
|
|
|
- Dan Sosedoff
|
|
- [dan.sosedoff@gmail.com](mailto:dan.sosedoff@gmail.com)
|
|
- [http://twitter.com/sosedoff](http://twitter.com/sosedoff)
|
|
|
|
## License
|
|
|
|
The MIT License (MIT). See [LICENSE](LICENSE) file for more details.
|
|
|
|
Copyright (c) 2014-2018 Dan Sosedoff, <dan.sosedoff@gmail.com> |