Skip to content

Commit 1f93038

Browse files
author
Jan Prochazka
committed
team premium instructions
1 parent 4987d2d commit 1f93038

4 files changed

Lines changed: 62 additions & 2 deletions

File tree

content/installation/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ For Mac, DMG installer is available. There are 3 packages available:
2121
## Docker
2222
Follow instructions on [docker hub](https://hub.docker.com/r/dbgate/dbgate)
2323

24+
For Team Premium edition, please follow instructions on [Docker Team Premium](docker-tp)
25+
2426
## NPM
2527
You could also install web version of DbGate from NPM, please follow instructions on [npmjs](https://www.npmjs.com/package/dbgate-serve)
2628

content/installation/aws.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Deploy on AWS
33
subtitle: Single-click deploy on Amazon EC2 cluster
44
icon: aws.svg
5-
weight: 14
5+
weight: 10
66
demo_url: https://aws.amazon.com/marketplace/pp/prodview-glw7okfnhf4cy
77
demo_title: View on AWS
88
edition: 'premium'

content/installation/azure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Deploy on Azure
3-
weight: 14
3+
weight: 20
44
---
55

66
DbGate Azure edition is a collaborative, multi-user web platform specifically designed for database management within Azure. By taking advantage of Azure infrastructure, it streamlines teamwork for organizations operating in cloud environments. Its shared, browser-based interface simplifies collaboration, data access, and database oversight while seamlessly integrating with Azure.

content/installation/docker-tp.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Docker Team Premium
3+
weight: 30
4+
---
5+
6+
Typical Team Premium installation consists of two components:
7+
- DbGate server docker container
8+
- Database server (MS SQL, MySQL, PostgreSQL, Oracle) - internal storage database for connections, users and roles
9+
10+
## DbGate Server Docker Container
11+
User [DbGate Team Premium image](https://hub.docker.com/r/dbgate/dbgate-premium) from Docker Hub:
12+
```
13+
docker pull dbgate/dbgate-premium
14+
```
15+
16+
DbGate Team Premium container requires some environment variables to be set:
17+
- `STORAGE_SERVER`, `STORAGE_DATABASE`, `STORAGE_USER`, `STORAGE_PASSWORD`, `STORAGE_ENGINE` - defines connection to internal storage database
18+
19+
See [environment variables documentation](/env-variables/#team-premium-edition-configuration) for more details about available environment variables.
20+
21+
In fact, DbGate Team Premium has very low resource consumption, but for best performance we recommend following configuration (for 10 concurrent users):
22+
- Minimum 2 CPU cores
23+
- Minimum 2 GB RAM
24+
- Minimum 10 GB free disk space
25+
26+
If you want to use disk files for storage of user files (like query results export), you should map `/root/.dbgate` path in container.
27+
28+
```yaml
29+
volumes:
30+
- dbgate-data:/root/.dbgate
31+
```
32+
33+
## Stateless/Statuefullness
34+
DbGate container is statefull.
35+
36+
The following data is stored inside container:
37+
* Logged user sessions
38+
* Query execution states
39+
* Temporary files (like results)
40+
* Opened database transactions
41+
* Opened database connections
42+
43+
It is not possible to run correctly multiple DbGate containers behind load balancer, because the data above is not shared between containers.
44+
45+
## DbGate Server from NPM
46+
If your infrastructure does not support Docker, you could use [DbGate Team Premium NPM package](https://www.npmjs.com/package/dbgate-serve-premium):
47+
```
48+
npm install -g dbgate-serve-premium
49+
```
50+
51+
## Process isolation
52+
DbGate Team Premium uses process isolation on database connection level, so multiple users could use same database server without interference. Process forked from DbGate grows with number of active users and connections, so make sure your server has enough resources.
53+
Following entities are isolated into new process:
54+
* Server connections
55+
* Database connections
56+
* Query sessions
57+
* Export/import job execution
58+
* SSH tunneling

0 commit comments

Comments
 (0)