dennii/dbgate
1
0
Fork 0
mirror of https://github.com/DeNNiiInc/dbgate.git synced 2026-04-17 22:36:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation

Browse Source
This commit is contained in:
SPRINX0\prochazka
2024-11-14 12:53:19 +01:00
parent 1c7729a797
commit 5c5a5f3b53
1 changed files with 49 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
packages/serve/README.md
View File

@@ -2,9 +2,55 @@
[![NPM version](https://img.shields.io/npm/v/dbgate.svg)](https://www.npmjs.com/package/dbgate)
# DbGate - database administration tool
DbGate is fast and easy to use database administration tool for MySQL, PostgreSQL, SQL Server.
DbGate is cross-platform database manager.
It's designed to be simple to use and effective, when working with more databases simultaneously.
But there are also many advanced features like schema compare, visual query designer, chart visualisation or batch export and import.
## Install using npm
## Supported databases
* MySQL
* PostgreSQL
* SQL Server
* Oracle
* MongoDB
* Redis
* SQLite
* Amazon Redshift (Premium)
* CockroachDB
* MariaDB
* CosmosDB (Premium)
* ClickHouse
## Community vs Premium
This package has 2 variants:
* [dbgate-serve](https://www.npmjs.com/package/dbgate-serve) - Community edition (free and open source)
* [dbgate-serve-premium](https://www.npmjs.com/package/dbgate-serve-premium) - Premium edition (commercial)
## Install using npm - premium edition
```sh
npm install -g dbgate-serve-premium
```
DbGate is configure via environment variables. In this package, you could use .env files with configuration of DbGate. .env file is loaded in working directory.
.env file could look like following:
```
STORAGE_SERVER=localhost
STORAGE_USER=root
STORAGE_PASSWORD=mypassword
STORAGE_DATABASE=dbname
STORAGE_ENGINE=mysql@dbgate-plugin-mysql
```
You could find more about environment variable configuration on [DbGate docs](https://dbgate.org/docs/env-variables.html) page.
After installing, you can run dbgate with command:
```sh
dbgate-serve-premium
```
Then open http://localhost:3000 in your browser
## Install using npm - community edition
```sh
npm install -g dbgate-serve
```
@@ -14,6 +60,7 @@ After installing, you can run dbgate with command:
dbgate-serve
```
.env file could be used in the same way as in Premium edition, without STORAGE_xxx variables, which are specific for Premium.
Then open http://localhost:3000 in your browser
## Download electron app