|
6 | 6 | name: Install InfluxDB 3 Core
|
7 | 7 | weight: 2
|
8 | 8 | influxdb3/core/tags: [install]
|
| 9 | +source: /shared/influxdb3/install.md |
9 | 10 | alt_links:
|
10 | 11 | v1: /influxdb/v1/introduction/install/
|
11 | 12 | ---
|
12 | 13 |
|
13 |
| -- [System Requirements](#system-requirements) |
14 |
| -- [Quick install](#quick-install) |
15 |
| -- [Download {{% product-name %}} binaries](#download-influxdb-3-{{< product-key >}}-binaries) |
16 |
| -- [Docker image](#docker-image) |
17 |
| - |
18 |
| -## System Requirements |
19 |
| - |
20 |
| -#### Operating system |
21 |
| - |
22 |
| -{{< product-name >}} runs on **Linux**, **macOS**, and **Windows**. |
23 |
| - |
24 |
| -#### Object storage |
25 |
| - |
26 |
| -A key feature of InfluxDB 3 is its use of object storage to store time series |
27 |
| -data in Apache Parquet format. You can choose to store these files on your local |
28 |
| -file system. Performance on your local filesystem will likely be better, but |
29 |
| -object storage has the advantage of not running out of space and being accessible |
30 |
| -by other systems over the network. {{< product-name >}} natively supports Amazon S3, |
31 |
| -Azure Blob Storage, and Google Cloud Storage. |
32 |
| -You can also use many local object storage implementations that provide an |
33 |
| -S3-compatible API, such as [Minio](https://min.io/). |
34 |
| - |
35 |
| -## Quick install |
36 |
| - |
37 |
| -Use the InfluxDB 3 quick install script to install {{< product-name >}} on |
38 |
| -**Linux** and **macOS**. |
39 |
| - |
40 |
| -> [!Important] |
41 |
| -> If using Windows, [download the {{% product-name %}} Windows binary](?t=Windows#download-influxdb-3-{{< product-key >}}-binaries). |
42 |
| -
|
43 |
| -1. Use the following command to download and install the appropriate |
44 |
| - {{< product-name >}} package on your local machine: |
45 |
| - <!--pytest.mark.skip--> |
46 |
| - ```bash |
47 |
| - curl -O https://www.influxdata.com/d/install_influxdb3.sh \ |
48 |
| - && sh install_influxdb3.sh |
49 |
| - ``` |
50 |
| - |
51 |
| -2. Verify that installation completed successfully: |
52 |
| - |
53 |
| - ```bash |
54 |
| - influxdb3 --version |
55 |
| - ``` |
56 |
| - |
57 |
| -> [!Note] |
58 |
| -> |
59 |
| -> #### influxdb3 not found |
60 |
| -> |
61 |
| -> If your system can't locate your `influxdb3` binary, `source` your |
62 |
| -> current shell configuration file (`.bashrc`, `.zshrc`, etc.). |
63 |
| -> |
64 |
| -> {{< code-tabs-wrapper >}} |
65 |
| -{{% code-tabs %}} |
66 |
| -[.bashrc](#) |
67 |
| -[.zshrc](#) |
68 |
| -{{% /code-tabs %}} |
69 |
| -{{% code-tab-content %}} |
70 |
| -```bash |
71 |
| -source ~/.bashrc |
72 |
| -``` |
73 |
| -{{% /code-tab-content %}} |
74 |
| -{{% code-tab-content %}} |
75 |
| -<!--pytest.mark.skip--> |
76 |
| -```bash |
77 |
| -source ~/.zshrc |
78 |
| -``` |
79 |
| -{{% /code-tab-content %}} |
80 |
| -{{< /code-tabs-wrapper >}} |
81 |
| -
|
82 |
| -## Download {{% product-name %}} binaries |
83 |
| -
|
84 |
| -{{< tabs-wrapper >}} |
85 |
| -{{% tabs %}} |
86 |
| -[Linux](#) |
87 |
| -[macOS](#) |
88 |
| -[Windows](#) |
89 |
| -{{% /tabs %}} |
90 |
| -{{% tab-content %}} |
91 |
| -
|
92 |
| -<!-------------------------------- BEGIN LINUX --------------------------------> |
93 |
| -
|
94 |
| -- [{{< product-name >}} • Linux (AMD64, x86_64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz) |
95 |
| - • |
96 |
| - [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_amd64.tar.gz.sha256) |
97 |
| -
|
98 |
| -- [{{< product-name >}} • Linux (ARM64, AArch64) • GNU](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz) |
99 |
| - • |
100 |
| - [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_linux_arm64.tar.gz.sha256) |
101 |
| -
|
102 |
| -<!--------------------------------- END LINUX ---------------------------------> |
103 |
| -
|
104 |
| -{{% /tab-content %}} |
105 |
| -{{% tab-content %}} |
106 |
| -
|
107 |
| -<!-------------------------------- BEGIN MACOS --------------------------------> |
108 |
| -
|
109 |
| -- [{{< product-name >}} • macOS (Silicon, ARM64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz) |
110 |
| - • |
111 |
| - [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}_darwin_arm64.tar.gz.sha256) |
112 |
| -
|
113 |
| -> [!Note] |
114 |
| -> macOS Intel builds are coming soon. |
115 |
| -
|
116 |
| -<!--------------------------------- END MACOS ---------------------------------> |
117 |
| -
|
118 |
| -{{% /tab-content %}} |
119 |
| -{{% tab-content %}} |
120 |
| -
|
121 |
| -<!------------------------------- BEGIN WINDOWS -------------------------------> |
122 |
| -
|
123 |
| -- [{{< product-name >}} • Windows (AMD64, x86_64)](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip) |
124 |
| - • |
125 |
| - [sha256](https://dl.influxdata.com/influxdb/releases/influxdb3-{{< product-key >}}-{{< latest-patch >}}-windows_amd64.zip.sha256) |
126 |
| -
|
127 |
| -<!-------------------------------- END WINDOWS --------------------------------> |
128 |
| -
|
129 |
| -{{% /tab-content %}} |
130 |
| -{{< /tabs-wrapper >}} |
131 |
| -
|
132 |
| -## Docker image |
133 |
| -
|
134 |
| -Use the `influxdb3-{{< product-key >}}` Docker image to deploy {{< product-name >}} in a |
135 |
| -Docker container. |
136 |
| -The image is available for x86_64 (AMD64) and ARM64 architectures. |
137 |
| -
|
138 |
| -### Use Docker CLI |
139 |
| -
|
140 |
| -<!--pytest.mark.skip--> |
141 |
| -```bash |
142 |
| -docker pull influxdb:3-{{< product-key >}} |
143 |
| -``` |
144 |
| -
|
145 |
| -Docker automatically pulls the appropriate image for your system architecture. |
146 |
| -
|
147 |
| -To specify the system architecture, use platform-specific tags--for example: |
148 |
| -
|
149 |
| -```bash |
150 |
| -# For x86_64/AMD64 |
151 |
| -docker pull \ |
152 |
| ---platform linux/amd64 \ |
153 |
| -influxdb:3-{{< product-key >}} |
154 |
| -``` |
155 |
| -
|
156 |
| -```bash |
157 |
| -# For ARM64 |
158 |
| -docker pull \ |
159 |
| ---platform linux/arm64 \ |
160 |
| -influxdb:3-{{< product-key >}} |
161 |
| -``` |
162 |
| -
|
163 |
| -> [!Note] |
164 |
| -> The {{% product-name %}} Docker image exposes port `8181`, the `influxdb3` server default for HTTP connections. |
165 |
| -> To map the exposed port to a different port when running a container, see the Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/). |
166 |
| -
|
167 |
| -### Use Docker Compose |
168 |
| -
|
169 |
| -1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}--for example: |
170 |
| -
|
171 |
| - ```yaml |
172 |
| - # compose.yaml |
173 |
| - services: |
174 |
| - influxdb3-{{< product-key >}}: |
175 |
| - container_name: influxdb3-{{< product-key >}} |
176 |
| - image: influxdb:3-{{< product-key >}} |
177 |
| - ports: |
178 |
| - - 8181:8181 |
179 |
| - command: |
180 |
| - - influxdb3 |
181 |
| - - serve |
182 |
| - - --node-id=node0 |
183 |
| - - --object-store=file |
184 |
| - - --data-dir=/var/lib/influxdb3 |
185 |
| - ``` |
186 |
| -
|
187 |
| -2. Use the Docker Compose CLI to start the server. |
188 |
| -
|
189 |
| - Optional: to make sure you have the latest version of the image before you |
190 |
| - start the server, run `docker compose pull`. |
191 |
| -
|
192 |
| - <!--pytest.mark.skip--> |
193 |
| - ```bash |
194 |
| - docker compose pull && docker compose run influxdb3-{{< product-key >}} |
195 |
| - ``` |
196 |
| -
|
197 |
| -> [!Note] |
198 |
| -> #### Stopping an InfluxDB 3 container |
199 |
| -> |
200 |
| -> To stop a running InfluxDB 3 container, find and terminate the process--for example: |
201 |
| -> |
202 |
| -> <!--pytest.mark.skip--> |
203 |
| -> ```bash |
204 |
| -> ps -ef | grep influxdb3 |
205 |
| -> kill -9 <PROCESS_ID> |
206 |
| -> ``` |
207 |
| -> |
208 |
| -> Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container. |
209 |
| -
|
210 |
| -{{< page-nav next="/influxdb3/core/get-started/" nextText="Get started with InfluxDB 3 Core" >}} |
| 14 | +<!--SOURCE content/shared/influxdb3/install.md --> |
0 commit comments