@@ -133,7 +133,7 @@ data to the local file system, mount a volume for the object store--for example,
133
133
provide the following options with your ` docker run ` command:
134
134
135
135
- ` --volume /path/on/host:/path/in/container ` : Mounts a directory from your file system to the container
136
- - ` --object-store file --data-dir /path/in/container ` : Use the volume mount for object storage
136
+ - ` --object-store file --data-dir /path/in/container ` : Uses the volume for object storage
137
137
138
138
{{% show-in "enterprise" %}}
139
139
<!-- pytest.mark.skip-->
@@ -174,66 +174,81 @@ docker run -it \
174
174
175
175
{{% /expand %}}
176
176
{{% expand "Docker compose with a mounted file system object store" %}}
177
+ Open ` compose.yaml ` for editing and add a ` services ` entry for
178
+ {{% product-name %}}--for example:
177
179
{{% show-in "enterprise" %}}
178
- 1 . Open ` compose.yaml ` for editing and add a ` services ` entry for {{% product-name %}}.
179
- --for example:
180
-
181
- ``` yaml
182
- # compose.yaml
183
- services :
184
- influxdb3-{{< product-key >}} :
185
- container_name : influxdb3-{{< product-key >}}
186
- image : influxdb:3-{{< product-key >}}
187
- ports :
188
- - 8181:8181
189
- command :
190
- - influxdb3
191
- - serve
192
- - --node-id=node0
193
- - --cluster-id=cluster0
194
- - --object-store=file
195
- - --data-dir=/var/lib/influxdb3
196
- - --plugin-dir=/var/lib/influxdb3-plugins
197
- environment :
198
- - INFLUXDB3_LICENSE_EMAIL=EMAIL_ADDRESS
199
- ` ` `
200
- _Replace ` EMAIL_ADDRESS` with your email address to bypass the email prompt
180
+ ``` yaml
181
+ # compose.yaml
182
+ services :
183
+ influxdb3-{{< product-key >}} :
184
+ image : influxdb:3-{{< product-key >}}
185
+ ports :
186
+ - 8181:8181
187
+ command :
188
+ - influxdb3
189
+ - serve
190
+ - --node-id=node0
191
+ - --cluster-id=cluster0
192
+ - --object-store=file
193
+ - --data-dir=/var/lib/influxdb3/data
194
+ - --plugin-dir=/var/lib/influxdb3/plugins
195
+ environment :
196
+ - INFLUXDB3_ENTERPRISE_LICENSE_EMAIL=EMAIL_ADDRESS
197
+ volumes :
198
+ - type : bind
199
+ # Path to store data on your host system
200
+ source : ~/.influxdb3/data
201
+ # Path to store data in the container
202
+ target : /var/lib/influxdb3/data
203
+ - type : bind
204
+ # Path to store plugins on your host system
205
+ source : ~/.influxdb3/plugins
206
+ # Path to store plugins in the container
207
+ target : /var/lib/influxdb3/plugins
208
+ ` ` `
209
+ Replace ` EMAIL_ADDRESS` with your email address to bypass the email prompt
201
210
when generating a trial or at-home license. For more information, see [Manage your
202
- {{% product-name %}} license](/influxdb3/version/admin/license/)_ .
211
+ {{% product-name %}} license](/influxdb3/version/admin/license/).
203
212
{{% /show-in %}}
204
213
{{% show-in "core" %}}
205
- 1. Open `compose.yaml` for editing and add a `services` entry for {{% product-name %}}--for example :
206
-
207
- ` ` ` yaml
208
- # compose.yaml
209
- services:
210
- influxdb3-{{< product-key >}}:
211
- container_name: influxdb3-{{< product-key >}}
212
- image: influxdb:3-{{< product-key >}}
213
- ports:
214
- - 8181:8181
215
- command:
216
- - influxdb3
217
- - serve
218
- - --node-id=node0
219
- - --object-store=file
220
- - --data-dir=/var/lib/influxdb3
221
- - --plugin-dir=/var/lib/influxdb3-plugins
222
- ` ` `
214
+ ` ` ` yaml
215
+ # compose.yaml
216
+ services:
217
+ influxdb3-{{< product-key >}}:
218
+ image: influxdb:3-{{< product-key >}}
219
+ ports:
220
+ - 8181:8181
221
+ command:
222
+ - influxdb3
223
+ - serve
224
+ - --node-id=node0
225
+ - --object-store=file
226
+ - --data-dir=/var/lib/influxdb3/data
227
+ - --plugin-dir=/var/lib/influxdb3/plugins
228
+ volumes:
229
+ - type: bind
230
+ # Path to store data on your host system
231
+ source: ~/.influxdb3/data
232
+ # Path to store data in the container
233
+ target: /var/lib/influxdb3/data
234
+ - type: bind
235
+ # Path to store plugins on your host system
236
+ source: ~/.influxdb3/plugins
237
+ # Path to store plugins in the container
238
+ target: /var/lib/influxdb3/plugins
239
+ ` ` `
223
240
{{% /show-in %}}
224
241
225
- 2. Use the Docker Compose CLI to start the server.
226
-
227
- Optional : to make sure you have the latest version of the image before you
228
- start the server, run `docker compose pull`.
242
+ Use the Docker Compose CLI to start the server--for example :
229
243
230
- <!--pytest.mark.skip-->
231
- ` ` ` bash
232
- docker compose pull && docker compose run influxdb3-{{< product-key >}}
233
- ` ` `
244
+ <!--pytest.mark.skip-->
245
+ ` ` ` bash
246
+ docker compose pull && docker compose up influxdb3-{{< product-key >}}
247
+ ` ` `
234
248
235
- InfluxDB 3 starts in a container with host port `8181` mapped to container port
236
- ` 8181` , the `influxdb3` server default for HTTP connections.
249
+ The command pulls the latest {{% product-name %}} Docker image and starts
250
+ ` influxdb3` in a container with host port `8181` mapped to container port
251
+ ` 8181` , the server default for HTTP connections.
237
252
238
253
> [!Tip]
239
254
> # ### Custom port mapping
@@ -244,18 +259,6 @@ InfluxDB 3 starts in a container with host port `8181` mapped to container port
244
259
> For more information about mapping your container port to a specific host port, see the
245
260
> Docker guide for [Publishing and exposing ports](https://docs.docker.com/get-started/docker-concepts/running-containers/publishing-ports/).
246
261
247
- > [!Note]
248
- > # ### Stopping an InfluxDB 3 container
249
- >
250
- > To stop a running InfluxDB 3 container, find and terminate the process or container--for example:
251
- >
252
- > <!--pytest.mark.skip-->
253
- > ```bash
254
- > docker container ls --filter "name=influxdb3"
255
- > docker kill <CONTAINER_ID>
256
- > ```
257
- >
258
- > _Currently, a bug prevents using {{< keybind all="Ctrl+c" >}} in the terminal to stop an InfluxDB 3 container._
259
262
{{% /expand %}}
260
263
{{% expand "S3 object storage" %}}
261
264
@@ -377,7 +380,7 @@ InfluxDB 3 Enterprise licenses:
377
380
>
378
381
> To generate the trial or home license in Docker, bypass the email prompt.
379
382
> The first time you start a new instance, provide your email address with the
380
- > `--license-email` option or the `INFLUXDB3_LICENSE_EMAIL ` environment variable.
383
+ > `--license-email` option or the `INFLUXDB3_ENTERPRISE_LICENSE_EMAIL ` environment variable.
381
384
>
382
385
> _Currently, if you use Docker and enter your email address in the prompt, a bug may
383
386
> prevent the container from generating the license ._
0 commit comments