@@ -24,24 +24,24 @@ You can do both in one command using `docker run`. This is the easiest way to ru
2424
2525``` shell
2626# Linux variant: run on foreground, destroy container after exit, use host ports without NAT
27- docker run --name evitadb -i --rm --net=host \
27+ docker run --name evitadb -i --rm --net=host \
2828index.docker.io/evitadb/evitadb:latest
2929
30- # Windows / MacOS: there is open issue https://github.com/docker/roadmap/issues/238
30+ # Windows / MacOS: there is open issue https://github.com/docker/roadmap/issues/238
3131# and you need to open ports manually and propagate host IP address to the container
3232docker run --name evitadb -i --rm -p 5555:5555 -p 5556:5556 -p 5557:5557 \
33- -e " api.exposedOn=localhost" \
33+ -e " api.exposedOn=localhost"
3434 index.docker.io/evitadb/evitadb:latest
3535```
3636
3737When you start the evitaDB server you should see the following information in the console output:
3838
3939``` plain
40- _ _ ____ ____
41- _____ _(_) |_ __ _| _ \| __ )
42- / _ \ \ / / | __/ _` | | | | _ \
40+ _ _ ____ ____
41+ _____ _(_) |_ __ _| _ \| __ )
42+ / _ \ \ / / | __/ _` | | | | _ \
4343| __/\ V /| | || (_| | |_| | |_) |
44- \___| \_/ |_|\__\__,_|____/|____/
44+ \___| \_/ |_|\__\__,_|____/|____/
4545
4646You'll see some version here
4747Visit us at: https://evitadb.io
@@ -79,8 +79,8 @@ API `system` listening on http://your-server:5557/system/
7979 <Tr>
8080 <Td>`-i`</Td>
8181 <Td>
82- keeps STDIN open - the container will run in the foreground, and you'll see the container's
83- standard/error output in the console. in the console, and you can stop the container by sending it
82+ keeps STDIN open - the container will run in the foreground, and you'll see the container's
83+ standard/error output in the console. in the console, and you can stop the container by sending it
8484 a terminal signal (usually the the key combination `Ctrl`+`C`, or `Command`+`.` on MacOS).
8585 </Td>
8686 </Tr>
@@ -94,9 +94,9 @@ API `system` listening on http://your-server:5557/system/
9494 <Tr>
9595 <Td>`--net=host`</Td>
9696 <Td>
97- instructs Docker to use directly host system network stack, this way evitaDB behaves as if it runs directly
98- on the host system network-wise, if the port configured in evitaDB configuration is already used on the
99- system, Evita fails to set up appropriate web API (see next chapter for port remapping or
97+ instructs Docker to use directly host system network stack, this way evitaDB behaves as if it runs directly
98+ on the host system network-wise, if the port configured in evitaDB configuration is already used on the
99+ system, Evita fails to set up appropriate web API (see next chapter for port remapping or
100100 [evitaDB configuration](../operate/configure.md) for specifying open ports)
101101 </Td>
102102 </Tr>
@@ -112,17 +112,17 @@ open/re-mapping ports opened inside the Docker container in the following way:
112112``` shell
113113# run on foreground, destroy container after exit, use exact mapping for host ports
114114docker run --name evitadb -i --rm \
115- -p 5555:5555 \
116- -p 5556:5556 \
115+ -p 5555:5555 \
116+ -p 5556:5556 \
117117 -p 5557:5557 \
118- -e " api.exposedOn=localhost" \
118+ -e " api.exposedOn=localhost"
119119 index.docker.io/evitadb/evitadb:latest
120120```
121121
122122<Note type =" info " >
123123
124124The ` -e "api.exposedOn=localhost" ` argument is necessary when evitaLab and/or Open API schema is generated and used
125- from the host system the docker container is running on. This argument is not necessary when container shares
125+ from the host system the docker container is running on. This argument is not necessary when container shares
126126the network with the host using argument ` --net=host ` . Argument tells evitaDB running in container to use ` localhost `
127127as a domain for generated URLs in the schemas and the evitaLab network requests. Otherwise it would use the container
128128inner hostname as a domain, which is not accessible from the outer host system.
@@ -170,7 +170,7 @@ inner hostname as a domain, which is not accessible from the outer host system.
170170 <Tr>
171171 <Td>`-p`</Td>
172172 <Td>
173- port remapping in the format `host port`:`container port`, so you could remap default ports opened by
173+ port remapping in the format `host port`:`container port`, so you could remap default ports opened by
174174 evitaDB inside the container to different ports on the host system.
175175 </Td>
176176 </Tr>
@@ -259,7 +259,7 @@ You can take advantage of all the following variables:
259259 </Tr>
260260 <Tr>
261261 <Td>**`EVITA_JAVA_OPTS`**</Td>
262- <Td>Java commandline arguments
262+ <Td>Java commandline arguments
263263 (list of basic arguments [can be found here](https://docs.oracle.com/en/java/javase/17/docs/specs/man/java.html#overview-of-java-options)),
264264 default: none (empty string)</Td>
265265 </Tr>
@@ -292,18 +292,18 @@ You can also provide the entire configuration YAML file using a special volume i
292292``` shell
293293# # run interactively, destroy container after exit, use host ports without NAT, specify your own data directory and configuration file
294294docker run --name evitadb -i --net=host \
295- -v " __config_file__:/evita/conf/evita-configuration.yaml" \
295+ -v " __config_file__:/evita/conf/evita-configuration.yaml"
296296-v " __data_dir__:/evita/data"
297297-v " __certificate_dir__:/evita/certificates"
298298index.docker.io/evitadb/evitadb:latest
299299```
300300
301- You need to replace ` __config_file__ ` with the path to the YAML file and ` __data_dir__ ` , ` __certificate_dir__ ` with
301+ You need to replace ` __config_file__ ` with the path to the YAML file and ` __data_dir__ ` , ` __certificate_dir__ ` with
302302existing folders on the host file system.
303303
304304<Note type =" info " >
305- The contents should match the default configuration file
306- <SourceClass >docker/evita-configuration.yaml</SourceClass >, but you can specify constants instead
305+ The contents should match the default configuration file
306+ <SourceClass >docker/evita-configuration.yaml</SourceClass >, but you can specify constants instead
307307of variables in certain settings.
308308</Note >
309309
@@ -348,13 +348,13 @@ curl -k "https://localhost:5555/rest/system/liveness" \
348348```
349349this should return following confirmation about liveness status of the REST API:
350350``` json
351- {"alive " :true }
351+ {"liveness " :true }
352352```
353353
354354### Control logging
355355
356356evitaDB uses the [ Slf4j] ( https://www.slf4j.org/ ) logging facade with [ Logback] ( https://logback.qos.ch/ ) implementation, but
357- you're free to change this. The default logback configuration is defined in a file
357+ you're free to change this. The default logback configuration is defined in a file
358358<SourceClass >evita_server/src/main/resources/META-INF/logback.xml</SourceClass >.
359359
360360You can completely override the default logback configuration by providing your own
@@ -363,7 +363,7 @@ You can completely override the default logback configuration by providing your
363363``` shell
364364# # run interactively, destroy container after exit, use host ports without NAT, specify your own data directory and configuration file
365365docker run --name evitadb -i --net=host \
366- -v " __config_file__:/evita/conf/evita-configuration.yaml" \
366+ -v " __config_file__:/evita/conf/evita-configuration.yaml"
367367-v " __data_dir__:/evita/data"
368368-v " __certificate_dir__:/evita/certificates"
369369-v " __path_to_log_file__:/evita/logback.xml"
@@ -401,7 +401,7 @@ evitaDB in the Docker compose file. The basic configuration could look like this
401401version : " 3.7"
402402services :
403403 evita :
404- image : index.docker.io/evitadb/evitadb:latest
404+ image : index.docker.io/evitadb/evitadb:latest
405405 environment :
406406 - EVITA_JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5000
407407 volumes :
0 commit comments