Skip to content

Commit f8e5bcf

Browse files
authored
dbeaver/tech-docs#1295 installation with Docker image (#70)
* dbeaver/tech-docs#1295 installation with Docker image * dbeaver/tech-docs#1295 installation with Docker image * dbeaver/tech-docs#1295 installation with Docker image * dbeaver/tech-docs#1295 installation with Docker image
1 parent 7206b67 commit f8e5bcf

1 file changed

Lines changed: 62 additions & 15 deletions

File tree

README.md

Lines changed: 62 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,31 @@
11
# CloudBeaver Enterprise deployment
22

3-
### Version 25.2
3+
<big><b>Version 25.2</b></big>
44

55
CloudBeaver Enterprise is a client-server application.
6-
It requires server deployment. You can deploy it on a single host (e.g. your local computer) or in a cloud.
6+
It requires server deployment. You can deploy it in several ways:
7+
8+
- [With Docker Compose](#installation-with-docker-compose)
9+
- [With a single Docker image](#installation-with-docker-image)
10+
- [With Kubernetes/Helm](#installation-with-kuberneteshelm)
711

812
## Installation with Docker Compose
913

1014
It is the simplest way to install [CloudBeaver Enterprise Edition](https://dbeaver.com/cloudbeaver-enterprise/).
1115
All you need is a Linux, macOS, or Windows machine with Docker.
1216

13-
CloudBeaver can be run in a [single docker container](https://dbeaver.com/docs/cloudbeaver/CloudBeaver-Enterprise-deployment-from-docker-image/).
17+
CloudBeaver can be run in a [single docker container](#installation-with-docker-image).
1418
However you can use Docker compose for easy web server (HTTPS) configuration.
1519

1620
### System requirements
21+
1722
- Minimum 4GB RAM
1823
- Minimum 50GB storage, > 100GB recommended
1924
- Ubuntu recommended
2025
- [Docker](https://docs.docker.com/engine/install/ubuntu/) installed. Make sure you have chosen the right OS distro.
2126
- [docker-compose](https://docs.docker.com/compose/install/) binary installed and added to your PATH variable. Supported versions 2.10 and above
2227
- If you install `docker-compose-plugin`, you must use the `docker compose` command instead of `docker-compose`.
2328

24-
### User and permissions changes
25-
26-
Starting from CloudBeaver v25.0 process inside the container now runs as the ‘dbeaver’ user (‘UID=8978’), instead of ‘root’.
27-
If a user with ‘UID=8978’ already exists in your environment, permission conflicts may occur.
28-
Additionally, the default Docker volumes directory’s ownership has changed.
29-
Previously, the volumes were owned by the ‘root’ user, but now they are owned by the ‘dbeaver’ user (‘UID=8978’).
30-
3129
### Configuring proxy server (Nginx / HAProxy)
3230

3331
Starting from v25.1, CloudBeaver supports two types of proxy servers: Nginx and HAProxy. You can choose your preferred proxy type by setting the following variable in the .env file:
@@ -85,12 +83,12 @@ There are two ways to configure SSL:
8583

8684
### Podman requirements
8785

88-
as user `root` run following commands before [Configuring and starting the CloudBeaver cluster](#configuring-and-starting-team-edition-cluster):
86+
as user `root` run following commands before [Configuring and starting the CloudBeaver cluster](#configuring-and-starting-the-cloudbeaver-cluster):
8987
1. ```loginctl enable-linger 1000```
9088
2. ```echo 'net.ipv4.ip_unprivileged_port_start=80' >> /etc/sysctl.conf```
9189
3. ```sysctl -p```
9290

93-
on step 4 of [Configuring and starting the CloudBeaver cluster](#configuring-and-starting-team-edition-cluster) use `podman-compose` tool intead of `docker-compose` and on step 4 define compose file name:
91+
on step 4 of [Configuring and starting the CloudBeaver cluster](#configuring-and-starting-the-cloudbeaver-cluster) use `podman-compose` tool intead of `docker-compose` and on step 4 define compose file name:
9492
```
9593
podman-compose -f podman-compose.yml up -d
9694
```
@@ -101,13 +99,62 @@ or replace `docker-compose.yml` with `podman-compose.yml` and use `podman-compos
10199
2. Pull new docker images: `docker-compose pull` or `docker compose pull`
102100
3. Restart the cluster: `docker-compose up -d` or `docker compose up -d`
103101

104-
## Kubernetes/Helm Deployment
102+
## Installation with Docker image
103+
104+
CloudBeaver Enterprise can run as a single Docker container:
105+
106+
1. Pull Docker image
107+
108+
```sh
109+
docker pull dbeaver/cloudbeaver-ee:latest
110+
```
111+
112+
> You can replace `latest` with a preferred [version tag](https://hub.docker.com/r/dbeaver/cloudbeaver-ee/tags).
113+
> Use the same tag when running the container.
114+
115+
2. Run container
116+
117+
```sh
118+
docker run --name cloudbeaver-ee --rm -ti -p 8978:8978 \
119+
-v /var/cloudbeaver-ee/workspace:/opt/cloudbeaver/workspace \
120+
dbeaver/cloudbeaver-ee:latest
121+
```
122+
123+
> Replace 8978 with a preferred host port.
124+
125+
3. Access application
126+
127+
Open `http://<server-ip>:8978` in a web browser.
128+
129+
### Configuring proxy server
130+
131+
Use the official CloudBeaver web proxy for proper HTTPS configuration.
132+
133+
You can choose between [Nginx](https://hub.docker.com/r/dbeaver/cloudbeaver-nginx/tags)
134+
and [HAProxy](https://hub.docker.com/r/dbeaver/cloudbeaver-haproxy/tags) images,
135+
or set up web proxy automatically with the [Docker Compose deployment](#installation-with-docker-compose).
136+
137+
> **Note**: The [Domain Manager](https://dbeaver.com/docs/cloudbeaver/Domain-Manager/) is available only when running
138+
> with a CloudBeaver web proxy setup.
139+
140+
## Installation with Kubernetes/Helm
105141

106142
For Kubernetes deployments using Helm charts, see:
107143
- [General Kubernetes/Helm deployment guide](k8s/README.md)
108-
- [AWS EKS specific deployment guide](AWS/aws-eks/eks-deployment.md)
144+
- [AWS EKS specific deployment guide](AWS/aws-eks/README.md)
145+
146+
## User and permissions changes
147+
148+
Starting from CloudBeaver v25.0, the process inside all CloudBeaver Enterprise containers
149+
(both [Docker Compose](#installation-with-docker-compose) and single [Docker image](#installation-with-docker-image)) now
150+
runs as the ‘dbeaver’ user (‘UID=8978’), instead of ‘root’. If a user with ‘UID=8978’ already exists in your environment,
151+
permission conflicts may occur.
152+
153+
Additionally, the default Docker volumes directory’s ownership has changed.
154+
Previously, the volumes were owned by the ‘root’ user, but now they’re owned by the ‘dbeaver’ user (‘UID=8978’).
155+
156+
## Older versions
109157

110-
### Older versions:
111158
- [25.1.0](https://github.com/dbeaver/cloudbeaver-deploy/tree/25.1.0)
112159
- [25.0.0](https://github.com/dbeaver/cloudbeaver-deploy/tree/25.0.0)
113160
- [24.3.0](https://github.com/dbeaver/cloudbeaver-deploy/tree/24.3.0)

0 commit comments

Comments
 (0)