Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "BaSyx / Documentation / Components / Environment Variables"
< BaSyx | Documentation | Components
(→BaSyxContextConfiguration.java) |
(→BaSyxContextConfiguration.java) |
||
| Line 7: | Line 7: | ||
=== BaSyxContextConfiguration.java === | === BaSyxContextConfiguration.java === | ||
| − | When configuring the BaSyx context, always put the prefix " | + | When configuring the BaSyx context, always put the prefix "basyxcontext_" at begin of an environment variable. |
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| Line 16: | Line 16: | ||
! Example | ! Example | ||
|- | |- | ||
| − | | | + | | contextPath |
| basyxcontext_contextpath | | basyxcontext_contextpath | ||
| basyxcontext_contextpath=basys.sdk | | basyxcontext_contextpath=basys.sdk | ||
| Line 22: | Line 22: | ||
| contextDocPath | | contextDocPath | ||
| basyxcontext_contextdocpath | | basyxcontext_contextdocpath | ||
| − | | basyxcontext_contextdocpath= | + | | basyxcontext_contextdocpath=java.io.tempdir |
|- | |- | ||
| contextHostname | | contextHostname | ||
| Line 31: | Line 31: | ||
| basyxcontext_contextport | | basyxcontext_contextport | ||
| basyxcontext_contextport=4000 | | basyxcontext_contextport=4000 | ||
| + | |||
| + | === BaSyxDockerConfiguration.java === | ||
| + | When configuring a BaSyx Docker container, always put the prefix "basyxdocker_" at begin of an environment variable. | ||
| + | |- | ||
| + | ! colspan="3" | Configuration using Environment variables | ||
| + | |- | ||
| + | ! Variable in BaSysDockerConfiguration.java | ||
| + | ! Written as an environment variable | ||
| + | ! Example | ||
| + | |- | ||
| + | | BASYX_HOST_PORT | ||
| + | | basyxdocker_basyx_host_port | ||
| + | | basyxdocker_basyx_host_port=4000 | ||
| + | |- | ||
| + | | BASYX_CONTAINER_PORT | ||
| + | | basyxdocker_basyx_container_port | ||
| + | | basyxdocker_basyx_container_port=4000 | ||
| + | |- | ||
| + | | BASYX_IMAGE_NAME | ||
| + | | basyxdocker_basyx_image_name | ||
| + | | basyxdocker_basyx_image_name=aasserver | ||
| + | |- | ||
| + | | BASYX_CONTAINER_NAME | ||
| + | | basyxdocker_basyx_container_name | ||
| + | | basyxdocker_basyx_container_name=aas-server | ||
| + | |- | ||
Revision as of 06:24, 8 April 2022
Instead of using .properties file to configure the BaSyx components such as aas-server, registry etc., a user can also use environment variable for configuration. All parameters which are defined in the BaSyx*Configuration.java in this package basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/ . There are general rules when using environment variables:
- Once environment variables are set, then the settings in the .properties file will be overwritten.
- When using environment variables, it is not allowed to use "." in your parameters (such as basyx_aas.server) and DO NOT mix upper and lower case letters(such as BaSyx_aas_server).
- Always put the prefix of this component configuration at the begin of an environment variable and write it in lower case.
BaSyxContextConfiguration.java
When configuring the BaSyx context, always put the prefix "basyxcontext_" at begin of an environment variable.
| Configuration using Environment variables | ||
|---|---|---|
| Variable name | Written as an environment variable | Example |
| contextPath | basyxcontext_contextpath | basyxcontext_contextpath=basys.sdk |
| contextDocPath | basyxcontext_contextdocpath | basyxcontext_contextdocpath=java.io.tempdir |
| contextHostname | basyxcontext_contexthostname | basyxcontext_contexthostname=localhost |
| contextPort | basyxcontext_contextport | basyxcontext_contextport=4000
BaSyxDockerConfiguration.javaWhen configuring a BaSyx Docker container, always put the prefix "basyxdocker_" at begin of an environment variable. |
| Configuration using Environment variables | ||
| Variable in BaSysDockerConfiguration.java | Written as an environment variable | Example |
| BASYX_HOST_PORT | basyxdocker_basyx_host_port | basyxdocker_basyx_host_port=4000 |
| BASYX_CONTAINER_PORT | basyxdocker_basyx_container_port | basyxdocker_basyx_container_port=4000 |
| BASYX_IMAGE_NAME | basyxdocker_basyx_image_name | basyxdocker_basyx_image_name=aasserver |
| BASYX_CONTAINER_NAME | basyxdocker_basyx_container_name | basyxdocker_basyx_container_name=aas-server |