Skip to content

Commit

Permalink
Merge branch 'main' into capacity-plan
Browse files Browse the repository at this point in the history
  • Loading branch information
tisonkun authored May 30, 2024
2 parents 236add6 + 3b93c2f commit 61628fa
Show file tree
Hide file tree
Showing 11 changed files with 143 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/addDocsToS3BucketAWS.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
branches: ['main']
types: [closed]
paths:
- "./docs/zh/**/*.md"
- "./docs/**/zh/**/*.md"
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To run GreptimeDB in standalone mode, open a terminal (like Powershell) at the d
Make sure the [Docker](https://www.docker.com/) is already installed. If not, you can follow the official [documents](https://www.docker.com/get-started/) to install Docker.

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
Expand Down Expand Up @@ -80,6 +80,38 @@ You can:
2. Upgrade the Docker version to v23.0.0 or higher;
:::

## Binding address

GreptimeDB binds to `127.0.0.1` by default. If you need to accept connections from other addresses, you can start with the following parameters.

:::danger Warning

If the computer running GreptimeDB is directly exposed to the internet, binding to `0.0.0.0` is dangerous and will expose the instance to everybody on the internet.

:::code-group

```shell [Binary]
./greptime standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```

```shell [Docker]
docker run -p 0.0.0.0:4000-4003:4000-4003 \
-v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
:::

You can also refer to the [Configuration](/user-guide/operations/configuration.md) document to modify the bind address in the configuration file.

## Next Steps

Learn how to write data to GreptimeDB and visualize it using Grafana in the [Quick Start](../quick-start/overview.md).
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ curl -fsSL \
请确保已经安装了 [Docker](https://www.docker.com/)。如果还没有安装,可以参考 Docker 官方的[文档](https://www.docker.com/get-started/)进行安装。

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
Expand All @@ -52,7 +52,7 @@ greptime/greptimedb:<%greptimedb-version%> standalone start \
--postgres-addr 0.0.0.0:4003
```

:::tip NOTE
:::tip 注意事项
为了防止不小心退出 Docker 容器,你可能想以 “detached” 模式运行它:在 `docker run` 命令中添加 `-d` 参数即可。
:::

Expand Down Expand Up @@ -82,6 +82,39 @@ greptime/greptimedb:<%greptimedb-version%> standalone start \
2. 将 Docker 版本升级到 v23.0.0 或更高;
:::

## 绑定地址

GreptimeDB 默认绑定地址为 `127.0.0.1`。如果你需要能够接收来自所有地址的连接,可以通过以下参数启动。

:::danger 危险操作

如果运行 GreptimeDB 的计算机直接向互联网暴露服务,那么绑定 `0.0.0.0` 会十分危险,因为这将数据库实例暴露给互联网上的所有人。

:::code-group

```shell [二进制]
./greptime standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```

```shell [Docker]
docker run -p 0.0.0.0:4000-4003:4000-4003 \
-v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```

:::

你也可以参考[配置 GreptimeDB](/user-guide/operations/configuration.md)文档在配置文件中修改绑定的地址。

## 下一步

学习如何使用 GreptimeDB 并使用 Grafana 可视化数据:[快速开始](../quick-start/overview.md)
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To run GreptimeDB in standalone mode, open a terminal (like Powershell) at the d
Make sure the [Docker](https://www.docker.com/) is already installed. If not, you can follow the official [documents](https://www.docker.com/get-started/) to install Docker.

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb standalone start \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ curl -fsSL \
请确保已经安装了 [Docker](https://www.docker.com/)。如果还没有安装,可以参考 Docker 官方的[文档](https://www.docker.com/get-started/)进行安装。

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb standalone start \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To run GreptimeDB in standalone mode, open a terminal (like Powershell) at the d
Make sure the [Docker](https://www.docker.com/) is already installed. If not, you can follow the official [documents](https://www.docker.com/get-started/) to install Docker.

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb standalone start \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ curl -fsSL \
请确保已经安装了 [Docker](https://www.docker.com/)。如果还没有安装,可以参考 Docker 官方的[文档](https://www.docker.com/get-started/)进行安装。

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb standalone start \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To run GreptimeDB in standalone mode, open a terminal (like Powershell) at the d
Make sure the [Docker](https://www.docker.com/) is already installed. If not, you can follow the official [documents](https://www.docker.com/get-started/) to install Docker.

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ curl -fsSL \
请确保已经安装了 [Docker](https://www.docker.com/)。如果还没有安装,可以参考 Docker 官方的[文档](https://www.docker.com/get-started/)进行安装。

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-p 4242:4242 -v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ To run GreptimeDB in standalone mode, open a terminal (like Powershell) at the d
Make sure the [Docker](https://www.docker.com/) is already installed. If not, you can follow the official [documents](https://www.docker.com/get-started/) to install Docker.

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
Expand Down Expand Up @@ -80,6 +80,39 @@ You can:
2. Upgrade the Docker version to v23.0.0 or higher;
:::

## Binding address

GreptimeDB binds to `127.0.0.1` by default. If you need to accept connections from other addresses, you can start with the following parameters.

:::danger Warning

If the computer running GreptimeDB is directly exposed to the internet, binding to `0.0.0.0` is dangerous and will expose the instance to everybody on the internet.


:::code-group

```shell [Binary]
./greptime standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```

```shell [Docker]
docker run -p 0.0.0.0:4000-4003:4000-4003 \
-v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```
:::

You can also refer to the [Configuration](/user-guide/operations/configuration.md) document to modify the bind address in the configuration file.

## Next Steps

Learn how to write data to GreptimeDB and visualize it using Grafana in the [Quick Start](../quick-start/overview.md).
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ curl -fsSL \
请确保已经安装了 [Docker](https://www.docker.com/)。如果还没有安装,可以参考 Docker 官方的[文档](https://www.docker.com/get-started/)进行安装。

```shell
docker run -p 4000-4003:4000-4003 \
docker run -p 127.0.0.1:4000-4003:4000-4003 \
-v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
Expand Down Expand Up @@ -82,6 +82,39 @@ greptime/greptimedb:<%greptimedb-version%> standalone start \
2. 将 Docker 版本升级到 v23.0.0 或更高;
:::

## 绑定地址

GreptimeDB 默认绑定地址为 `127.0.0.1`。如果你需要能够接收来自所有地址的连接,可以通过以下参数启动。

:::danger 危险操作

如果运行 GreptimeDB 的计算机直接向互联网暴露服务,那么绑定 `0.0.0.0` 会十分危险,因为这将数据库实例暴露给互联网上的所有人。

:::code-group

```shell [二进制]
./greptime standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```

```shell [Docker]
docker run -p 0.0.0.0:4000-4003:4000-4003 \
-v "$(pwd)/greptimedb:/tmp/greptimedb" \
--name greptime --rm \
greptime/greptimedb:<%greptimedb-version%> standalone start \
--http-addr 0.0.0.0:4000 \
--rpc-addr 0.0.0.0:4001 \
--mysql-addr 0.0.0.0:4002 \
--postgres-addr 0.0.0.0:4003
```

:::

你也可以参考[配置 GreptimeDB](/user-guide/operations/configuration.md)文档在配置文件中修改绑定的地址。

## 下一步

学习如何使用 GreptimeDB 并使用 Grafana 可视化数据:[快速开始](../quick-start/overview.md)

0 comments on commit 61628fa

Please sign in to comment.