opensource/supermq
1
0
Fork 0
mirror of https://github.com/absmach/supermq.git synced 2026-06-23 07:00:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

MG-2365 - Fix JaegerURL in readme.md and cmd/<svc>/main.go (#2366)

Browse Source 
Signed-off-by: JeffMboya <jangina.mboya@gmail.com>
This commit is contained in:
JMboya
2024-08-02 17:28:26 +03:00
committed by GitHub
parent 03065369a7
commit 6a41ea10a3
27 changed files with 353 additions and 354 deletions
Download Patch File Download Diff File Expand all files Collapse all files
auth/README.md
+34 -34
View File
@@ -59,40 +59,40 @@ Domain consists of the following fields:
The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.
| Variable | Description | Default |
| ------------------------------ | ----------------------------------------------------------------------- | -------------------------------- |
| MG_AUTH_LOG_LEVEL | Log level for the Auth service (debug, info, warn, error) | info |
| MG_AUTH_DB_HOST | Database host address | localhost |
| MG_AUTH_DB_PORT | Database host port | 5432 |
| MG_AUTH_DB_USER | Database user | magistrala |
| MG_AUTH_DB_PASSWORD | Database password | magistrala |
| MG_AUTH_DB_NAME | Name of the database used by the service | auth |
| MG_AUTH_DB_SSL_MODE | Database connection SSL mode (disable, require, verify-ca, verify-full) | disable |
| MG_AUTH_DB_SSL_CERT | Path to the PEM encoded certificate file | "" |
| MG_AUTH_DB_SSL_KEY | Path to the PEM encoded key file | "" |
| MG_AUTH_DB_SSL_ROOT_CERT | Path to the PEM encoded root certificate file | "" |
| MG_AUTH_HTTP_HOST | Auth service HTTP host | "" |
| MG_AUTH_HTTP_PORT | Auth service HTTP port | 8189 |
| MG_AUTH_HTTP_SERVER_CERT | Path to the PEM encoded HTTP server certificate file | "" |
| MG_AUTH_HTTP_SERVER_KEY | Path to the PEM encoded HTTP server key file | "" |
| MG_AUTH_GRPC_HOST | Auth service gRPC host | "" |
| MG_AUTH_GRPC_PORT | Auth service gRPC port | 8181 |
| MG_AUTH_GRPC_SERVER_CERT | Path to the PEM encoded gRPC server certificate file | "" |
| MG_AUTH_GRPC_SERVER_KEY | Path to the PEM encoded gRPC server key file | "" |
| MG_AUTH_GRPC_SERVER_CA_CERTS | Path to the PEM encoded gRPC server CA certificate file | "" |
| MG_AUTH_GRPC_CLIENT_CA_CERTS | Path to the PEM encoded gRPC client CA certificate file | "" |
| MG_AUTH_SECRET_KEY | String used for signing tokens | secret |
| MG_AUTH_ACCESS_TOKEN_DURATION | The access token expiration period | 1h |
| MG_AUTH_REFRESH_TOKEN_DURATION | The refresh token expiration period | 24h |
| MG_AUTH_INVITATION_DURATION | The invitation token expiration period | 168h |
| MG_SPICEDB_HOST | SpiceDB host address | localhost |
| MG_SPICEDB_PORT | SpiceDB host port | 50051 |
| MG_SPICEDB_PRE_SHARED_KEY | SpiceDB pre-shared key | 12345678 |
| MG_SPICEDB_SCHEMA_FILE | Path to SpiceDB schema file | ./docker/spicedb/schema.zed |
| MG_JAEGER_URL | Jaeger server URL | <http://jaeger:14268/api/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_AUTH_ADAPTER_INSTANCE_ID | Adapter instance ID | "" |
| Variable | Description | Default |
| ------------------------------ | ----------------------------------------------------------------------- | ------------------------------- |
| MG_AUTH_LOG_LEVEL | Log level for the Auth service (debug, info, warn, error) | info |
| MG_AUTH_DB_HOST | Database host address | localhost |
| MG_AUTH_DB_PORT | Database host port | 5432 |
| MG_AUTH_DB_USER | Database user | magistrala |
| MG_AUTH_DB_PASSWORD | Database password | magistrala |
| MG_AUTH_DB_NAME | Name of the database used by the service | auth |
| MG_AUTH_DB_SSL_MODE | Database connection SSL mode (disable, require, verify-ca, verify-full) | disable |
| MG_AUTH_DB_SSL_CERT | Path to the PEM encoded certificate file | "" |
| MG_AUTH_DB_SSL_KEY | Path to the PEM encoded key file | "" |
| MG_AUTH_DB_SSL_ROOT_CERT | Path to the PEM encoded root certificate file | "" |
| MG_AUTH_HTTP_HOST | Auth service HTTP host | "" |
| MG_AUTH_HTTP_PORT | Auth service HTTP port | 8189 |
| MG_AUTH_HTTP_SERVER_CERT | Path to the PEM encoded HTTP server certificate file | "" |
| MG_AUTH_HTTP_SERVER_KEY | Path to the PEM encoded HTTP server key file | "" |
| MG_AUTH_GRPC_HOST | Auth service gRPC host | "" |
| MG_AUTH_GRPC_PORT | Auth service gRPC port | 8181 |
| MG_AUTH_GRPC_SERVER_CERT | Path to the PEM encoded gRPC server certificate file | "" |
| MG_AUTH_GRPC_SERVER_KEY | Path to the PEM encoded gRPC server key file | "" |
| MG_AUTH_GRPC_SERVER_CA_CERTS | Path to the PEM encoded gRPC server CA certificate file | "" |
| MG_AUTH_GRPC_CLIENT_CA_CERTS | Path to the PEM encoded gRPC client CA certificate file | "" |
| MG_AUTH_SECRET_KEY | String used for signing tokens | secret |
| MG_AUTH_ACCESS_TOKEN_DURATION | The access token expiration period | 1h |
| MG_AUTH_REFRESH_TOKEN_DURATION | The refresh token expiration period | 24h |
| MG_AUTH_INVITATION_DURATION | The invitation token expiration period | 168h |
| MG_SPICEDB_HOST | SpiceDB host address | localhost |
| MG_SPICEDB_PORT | SpiceDB host port | 50051 |
| MG_SPICEDB_PRE_SHARED_KEY | SpiceDB pre-shared key | 12345678 |
| MG_SPICEDB_SCHEMA_FILE | Path to SpiceDB schema file | ./docker/spicedb/schema.zed |
| MG_JAEGER_URL | Jaeger server URL | <http://jaeger:4318/v1/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_AUTH_ADAPTER_INSTANCE_ID | Adapter instance ID | "" |
## Deployment
bootstrap/README.md
+29 -29
View File
@@ -35,35 +35,35 @@ Thing configuration also contains the so-called `external ID` and `external key`
The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.
| Variable | Description | Default |
| ----------------------------- | -------------------------------------------------------------------------------- | ----------------------------------- |
| MG_BOOTSTRAP_LOG_LEVEL | Log level for Bootstrap (debug, info, warn, error) | info |
| MG_BOOTSTRAP_DB_HOST | Database host address | localhost |
| MG_BOOTSTRAP_DB_PORT | Database host port | 5432 |
| MG_BOOTSTRAP_DB_USER | Database user | magistrala |
| MG_BOOTSTRAP_DB_PASS | Database password | magistrala |
| MG_BOOTSTRAP_DB_NAME | Name of the database used by the service | bootstrap |
| MG_BOOTSTRAP_DB_SSL_MODE | Database connection SSL mode (disable, require, verify-ca, verify-full) | disable |
| MG_BOOTSTRAP_DB_SSL_CERT | Path to the PEM encoded certificate file | "" |
| MG_BOOTSTRAP_DB_SSL_KEY | Path to the PEM encoded key file | "" |
| MG_BOOTSTRAP_DB_SSL_ROOT_CERT | Path to the PEM encoded root certificate file | "" |
| MG_BOOTSTRAP_ENCRYPT_KEY | Secret key for secure bootstrapping encryption | 12345678910111213141516171819202 |
| MG_BOOTSTRAP_HTTP_HOST | Bootstrap service HTTP host | "" |
| MG_BOOTSTRAP_HTTP_PORT | Bootstrap service HTTP port | 9013 |
| MG_BOOTSTRAP_HTTP_SERVER_CERT | Path to server certificate in pem format | "" |
| MG_BOOTSTRAP_HTTP_SERVER_KEY | Path to server key in pem format | "" |
| MG_BOOTSTRAP_EVENT_CONSUMER | Bootstrap service event source consumer name | bootstrap |
| MG_ES_URL | Event store URL | <nats://localhost:4222> |
| MG_AUTH_GRPC_URL | Auth service Auth gRPC URL | <localhost:8181> |
| MG_AUTH_GRPC_TIMEOUT | Auth service Auth gRPC request timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded auth service Auth gRPC client certificate file | "" |
| MG_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded auth service Auth gRPC client key file | "" |
| MG_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded auth server Auth gRPC server trusted CA certificate file | "" |
| MG_THINGS_URL | Base url for Magistrala Things | <http://localhost:9000> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:14268/api/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_BOOTSTRAP_INSTANCE_ID | Bootstrap service instance ID | "" |
| Variable | Description | Default |
| ----------------------------- | -------------------------------------------------------------------------------- | -------------------------------- |
| MG_BOOTSTRAP_LOG_LEVEL | Log level for Bootstrap (debug, info, warn, error) | info |
| MG_BOOTSTRAP_DB_HOST | Database host address | localhost |
| MG_BOOTSTRAP_DB_PORT | Database host port | 5432 |
| MG_BOOTSTRAP_DB_USER | Database user | magistrala |
| MG_BOOTSTRAP_DB_PASS | Database password | magistrala |
| MG_BOOTSTRAP_DB_NAME | Name of the database used by the service | bootstrap |
| MG_BOOTSTRAP_DB_SSL_MODE | Database connection SSL mode (disable, require, verify-ca, verify-full) | disable |
| MG_BOOTSTRAP_DB_SSL_CERT | Path to the PEM encoded certificate file | "" |
| MG_BOOTSTRAP_DB_SSL_KEY | Path to the PEM encoded key file | "" |
| MG_BOOTSTRAP_DB_SSL_ROOT_CERT | Path to the PEM encoded root certificate file | "" |
| MG_BOOTSTRAP_ENCRYPT_KEY | Secret key for secure bootstrapping encryption | 12345678910111213141516171819202 |
| MG_BOOTSTRAP_HTTP_HOST | Bootstrap service HTTP host | "" |
| MG_BOOTSTRAP_HTTP_PORT | Bootstrap service HTTP port | 9013 |
| MG_BOOTSTRAP_HTTP_SERVER_CERT | Path to server certificate in pem format | "" |
| MG_BOOTSTRAP_HTTP_SERVER_KEY | Path to server key in pem format | "" |
| MG_BOOTSTRAP_EVENT_CONSUMER | Bootstrap service event source consumer name | bootstrap |
| MG_ES_URL | Event store URL | <nats://localhost:4222> |
| MG_AUTH_GRPC_URL | Auth service Auth gRPC URL | <localhost:8181> |
| MG_AUTH_GRPC_TIMEOUT | Auth service Auth gRPC request timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded auth service Auth gRPC client certificate file | "" |
| MG_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded auth service Auth gRPC client key file | "" |
| MG_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded auth server Auth gRPC server trusted CA certificate file | "" |
| MG_THINGS_URL | Base url for Magistrala Things | <http://localhost:9000> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:4318/v1/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_BOOTSTRAP_INSTANCE_ID | Bootstrap service instance ID | "" |
## Deployment
certs/README.md
+39 -40
View File
@@ -13,11 +13,11 @@ For lab purposes you can use docker-compose and script for setting up PKI in [ht
```bash
MG_CERTS_VAULT_HOST=<https://vault-domain:8200>
MG_CERTS_VAULT_NAMESPACE=<vault_namespace>
MG_CERTS_VAULT_APPROLE_ROLEID=<vault_approle_roleid>
MG_CERTS_VAULT_APPROLE_SECRET=<vault_approle_sceret>
MG_CERTS_VAULT_THINGS_CERTS_PKI_PATH=<vault_things_certs_pki_path>
MG_CERTS_VAULT_THINGS_CERTS_PKI_ROLE_NAME=<vault_things_certs_issue_role_name>
MG_CERTS_VAULT_NAMESPACE=<vault_namespace>
MG_CERTS_VAULT_APPROLE_ROLEID=<vault_approle_roleid>
MG_CERTS_VAULT_APPROLE_SECRET=<vault_approle_sceret>
MG_CERTS_VAULT_THINGS_CERTS_PKI_PATH=<vault_things_certs_pki_path>
MG_CERTS_VAULT_THINGS_CERTS_PKI_ROLE_NAME=<vault_things_certs_issue_role_name>
```
The certificates can also be revoked using `certs` service. To revoke a certificate you need to provide `thing_id` of the thing for which the certificate was issued.
@@ -30,41 +30,40 @@ curl -s -S -X DELETE http://localhost:9019/certs/revoke -H "Authorization: Beare
The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.
| Variable | Description | Default |
| :---------------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| MG_CERTS_LOG_LEVEL | Log level for the Certs (debug, info, warn, error) | info |
| MG_CERTS_HTTP_HOST | Service Certs host | "" |
| MG_CERTS_HTTP_PORT | Service Certs port | 9019 |
| MG_CERTS_HTTP_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_CERTS_HTTP_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_AUTH_GRPC_URL | Auth service gRPC URL | [localhost:8181](localhost:8181) |
| MG_AUTH_GRPC_TIMEOUT | Auth service gRPC request timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded auth service gRPC client certificate file | "" |
| MG_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded auth service gRPC client key file | "" |
| MG_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded auth server gRPC server trusted CA certificate file | "" |
| MG_CERTS_SIGN_CA_PATH | Path to the PEM encoded CA certificate file | ca.crt |
| MG_CERTS_SIGN_CA_KEY_PATH | Path to the PEM encoded CA key file | ca.key |
| MG_CERTS_VAULT_HOST | Vault host | http://vault:8200 |
| MG_CERTS_VAULT_NAMESPACE | Vault namespace in which pki is present | magistrala |
| MG_CERTS_VAULT_APPROLE_ROLEID | Vault AppRole auth RoleID | magistrala |
| MG_CERTS_VAULT_APPROLE_SECRET | Vault AppRole auth Secret | magistrala |
| MG_CERTS_VAULT_THINGS_CERTS_PKI_PATH | Vault PKI path for issuing Things Certificates | pki_int |
| MG_CERTS_VAULT_THINGS_CERTS_PKI_ROLE_NAME | Vault PKI Role Name for issuing Things Certificates | magistrala_things_certs |
| MG_CERTS_DB_HOST | Database host | localhost |
| MG_CERTS_DB_PORT | Database port | 5432 |
| MG_CERTS_DB_PASS | Database password | magistrala |
| MG_CERTS_DB_USER | Database user | magistrala |
| MG_CERTS_DB_NAME | Database name | certs |
| MG_CERTS_DB_SSL_MODE | Database SSL mode | disable |
| MG_CERTS_DB_SSL_CERT | Database SSL certificate | "" |
| MG_CERTS_DB_SSL_KEY | Database SSL key | "" |
| MG_CERTS_DB_SSL_ROOT_CERT | Database SSL root certificate | "" |
| MG_THINGS_URL | Things service URL | [localhost:9000](localhost:9000) |
| MG_JAEGER_URL | Jaeger server URL | [http://localhost:14268/api/traces](http://localhost:14268/api/traces) |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_CERTS_INSTANCE_ID | Service instance ID | "" |
| Variable | Description | Default |
| :---------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| MG_CERTS_LOG_LEVEL | Log level for the Certs (debug, info, warn, error) | info |
| MG_CERTS_HTTP_HOST | Service Certs host | "" |
| MG_CERTS_HTTP_PORT | Service Certs port | 9019 |
| MG_CERTS_HTTP_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_CERTS_HTTP_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_AUTH_GRPC_URL | Auth service gRPC URL | [localhost:8181](localhost:8181) |
| MG_AUTH_GRPC_TIMEOUT | Auth service gRPC request timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded auth service gRPC client certificate file | "" |
| MG_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded auth service gRPC client key file | "" |
| MG_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded auth server gRPC server trusted CA certificate file | "" |
| MG_CERTS_SIGN_CA_PATH | Path to the PEM encoded CA certificate file | ca.crt |
| MG_CERTS_SIGN_CA_KEY_PATH | Path to the PEM encoded CA key file | ca.key |
| MG_CERTS_VAULT_HOST | Vault host | http://vault:8200 |
| MG_CERTS_VAULT_NAMESPACE | Vault namespace in which pki is present | magistrala |
| MG_CERTS_VAULT_APPROLE_ROLEID | Vault AppRole auth RoleID | magistrala |
| MG_CERTS_VAULT_APPROLE_SECRET | Vault AppRole auth Secret | magistrala |
| MG_CERTS_VAULT_THINGS_CERTS_PKI_PATH | Vault PKI path for issuing Things Certificates | pki_int |
| MG_CERTS_VAULT_THINGS_CERTS_PKI_ROLE_NAME | Vault PKI Role Name for issuing Things Certificates | magistrala_things_certs |
| MG_CERTS_DB_HOST | Database host | localhost |
| MG_CERTS_DB_PORT | Database port | 5432 |
| MG_CERTS_DB_PASS | Database password | magistrala |
| MG_CERTS_DB_USER | Database user | magistrala |
| MG_CERTS_DB_NAME | Database name | certs |
| MG_CERTS_DB_SSL_MODE | Database SSL mode | disable |
| MG_CERTS_DB_SSL_CERT | Database SSL certificate | "" |
| MG_CERTS_DB_SSL_KEY | Database SSL key | "" |
| MG_CERTS_DB_SSL_ROOT_CERT | Database SSL root certificate | "" |
| MG_THINGS_URL | Things service URL | [localhost:9000](localhost:9000) |
| MG_JAEGER_URL | Jaeger server URL | [http://localhost:4318/v1/traces](http://localhost:4318//v1/traces) |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_CERTS_INSTANCE_ID | Service instance ID | "" |
## Deployment
cmd/auth/main.go
+1 -1
View File
@@ -57,7 +57,7 @@ const (
type config struct {
LogLevel string `env:"MG_AUTH_LOG_LEVEL" envDefault:"info"`
SecretKey string `env:"MG_AUTH_SECRET_KEY" envDefault:"secret"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_AUTH_ADAPTER_INSTANCE_ID" envDefault:""`
AccessDuration time.Duration `env:"MG_AUTH_ACCESS_TOKEN_DURATION" envDefault:"1h"`
cmd/bootstrap/main.go
+1 -1
View File
@@ -55,7 +55,7 @@ type config struct {
EncKey string `env:"MG_BOOTSTRAP_ENCRYPT_KEY" envDefault:"12345678910111213141516171819202"`
ESConsumerName string `env:"MG_BOOTSTRAP_EVENT_CONSUMER" envDefault:"bootstrap"`
ThingsURL string `env:"MG_THINGS_URL" envDefault:"http://localhost:9000"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_BOOTSTRAP_INSTANCE_ID" envDefault:""`
ESURL string `env:"MG_ES_URL" envDefault:"nats://localhost:4222"`
cmd/certs/main.go
+1 -1
View File
@@ -47,7 +47,7 @@ const (
type config struct {
LogLevel string `env:"MG_CERTS_LOG_LEVEL" envDefault:"info"`
ThingsURL string `env:"MG_THINGS_URL" envDefault:"http://localhost:9000"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_CERTS_INSTANCE_ID" envDefault:""`
TraceRatio float64 `env:"MG_JAEGER_TRACE_RATIO" envDefault:"1.0"`
cmd/coap/main.go
+1 -1
View File
@@ -42,7 +42,7 @@ const (
type config struct {
LogLevel string `env:"MG_COAP_ADAPTER_LOG_LEVEL" envDefault:"info"`
BrokerURL string `env:"MG_MESSAGE_BROKER_URL" envDefault:"nats://localhost:4222"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_COAP_ADAPTER_INSTANCE_ID" envDefault:""`
TraceRatio float64 `env:"MG_JAEGER_TRACE_RATIO" envDefault:"1.0"`
cmd/http/main.go
+1 -1
View File
@@ -49,7 +49,7 @@ const (
type config struct {
LogLevel string `env:"MG_HTTP_ADAPTER_LOG_LEVEL" envDefault:"info"`
BrokerURL string `env:"MG_MESSAGE_BROKER_URL" envDefault:"nats://localhost:4222"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_HTTP_ADAPTER_INSTANCE_ID" envDefault:""`
TraceRatio float64 `env:"MG_JAEGER_TRACE_RATIO" envDefault:"1.0"`
cmd/invitations/main.go
+1 -1
View File
@@ -48,7 +48,7 @@ type config struct {
UsersURL string `env:"MG_USERS_URL" envDefault:"http://localhost:9002"`
DomainsURL string `env:"MG_DOMAINS_URL" envDefault:"http://localhost:8189"`
InstanceID string `env:"MG_INVITATIONS_INSTANCE_ID" envDefault:""`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
TraceRatio float64 `env:"MG_JAEGER_TRACE_RATIO" envDefault:"1.0"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
}
cmd/journal/main.go
+1 -1
View File
@@ -47,7 +47,7 @@ const (
type config struct {
LogLevel string `env:"MG_JOURNAL_LOG_LEVEL" envDefault:"info"`
ESURL string `env:"MG_ES_URL" envDefault:"nats://localhost:4222"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://jaeger:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_JOURNAL_INSTANCE_ID" envDefault:""`
TraceRatio float64 `env:"MG_JAEGER_TRACE_RATIO" envDefault:"1.0"`
cmd/mqtt/main.go
+1 -1
View File
@@ -60,7 +60,7 @@ type config struct {
HTTPTargetPort string `env:"MG_MQTT_ADAPTER_WS_TARGET_PORT" envDefault:"8080"`
HTTPTargetPath string `env:"MG_MQTT_ADAPTER_WS_TARGET_PATH" envDefault:"/mqtt"`
Instance string `env:"MG_MQTT_ADAPTER_INSTANCE" envDefault:""`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
BrokerURL string `env:"MG_MESSAGE_BROKER_URL" envDefault:"nats://localhost:4222"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_MQTT_ADAPTER_INSTANCE_ID" envDefault:""`
cmd/postgres-writer/main.go
+1 -1
View File
@@ -44,7 +44,7 @@ type config struct {
LogLevel string `env:"MG_POSTGRES_WRITER_LOG_LEVEL" envDefault:"info"`
ConfigPath string `env:"MG_POSTGRES_WRITER_CONFIG_PATH" envDefault:"/config.toml"`
BrokerURL string `env:"MG_MESSAGE_BROKER_URL" envDefault:"nats://localhost:4222"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://jaeger:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_POSTGRES_WRITER_INSTANCE_ID" envDefault:""`
TraceRatio float64 `env:"MG_JAEGER_TRACE_RATIO" envDefault:"1.0"`
cmd/things/main.go
+1 -1
View File
@@ -68,7 +68,7 @@ type config struct {
LogLevel string `env:"MG_THINGS_LOG_LEVEL" envDefault:"info"`
StandaloneID string `env:"MG_THINGS_STANDALONE_ID" envDefault:""`
StandaloneToken string `env:"MG_THINGS_STANDALONE_TOKEN" envDefault:""`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://jaeger:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
CacheKeyDuration time.Duration `env:"MG_THINGS_CACHE_KEY_DURATION" envDefault:"10m"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_THINGS_INSTANCE_ID" envDefault:""`
cmd/timescale-writer/main.go
+1 -1
View File
@@ -44,7 +44,7 @@ type config struct {
LogLevel string `env:"MG_TIMESCALE_WRITER_LOG_LEVEL" envDefault:"info"`
ConfigPath string `env:"MG_TIMESCALE_WRITER_CONFIG_PATH" envDefault:"/config.toml"`
BrokerURL string `env:"MG_MESSAGE_BROKER_URL" envDefault:"nats://localhost:4222"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://jaeger:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_TIMESCALE_WRITER_INSTANCE_ID" envDefault:""`
TraceRatio float64 `env:"MG_JAEGER_TRACE_RATIO" envDefault:"1.0"`
cmd/users/main.go
+1 -1
View File
@@ -69,7 +69,7 @@ type config struct {
AdminPassword string `env:"MG_USERS_ADMIN_PASSWORD" envDefault:"12345678"`
PassRegexText string `env:"MG_USERS_PASS_REGEX" envDefault:"^.{8,}$"`
ResetURL string `env:"MG_TOKEN_RESET_ENDPOINT" envDefault:"/reset-request"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_USERS_INSTANCE_ID" envDefault:""`
ESURL string `env:"MG_ES_URL" envDefault:"nats://localhost:4222"`
cmd/ws/main.go
+1 -1
View File
@@ -46,7 +46,7 @@ const (
type config struct {
LogLevel string `env:"MG_WS_ADAPTER_LOG_LEVEL" envDefault:"info"`
BrokerURL string `env:"MG_MESSAGE_BROKER_URL" envDefault:"nats://localhost:4222"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:14268/api/traces"`
JaegerURL url.URL `env:"MG_JAEGER_URL" envDefault:"http://localhost:4318/v1/traces"`
SendTelemetry bool `env:"MG_SEND_TELEMETRY" envDefault:"true"`
InstanceID string `env:"MG_WS_ADAPTER_INSTANCE_ID" envDefault:""`
TraceRatio float64 `env:"MG_JAEGER_TRACE_RATIO" envDefault:"1.0"`
coap/README.md
+21 -21
View File
@@ -6,27 +6,27 @@ Magistrala CoAP adapter provides an [CoAP](http://coap.technology/) API for send
The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.
| Variable | Description | Default |
| -------------------------------- | ---------------------------------------------------------------------------------- | ----------------------------------- |
| MG_COAP_ADAPTER_LOG_LEVEL | Log level for the CoAP Adapter (debug, info, warn, error) | info |
| MG_COAP_ADAPTER_HOST | CoAP service listening host | "" |
| MG_COAP_ADAPTER_PORT | CoAP service listening port | 5683 |
| MG_COAP_ADAPTER_SERVER_CERT | CoAP service server certificate | "" |
| MG_COAP_ADAPTER_SERVER_KEY | CoAP service server key | "" |
| MG_COAP_ADAPTER_HTTP_HOST | Service HTTP listening host | "" |
| MG_COAP_ADAPTER_HTTP_PORT | Service listening port | 5683 |
| MG_COAP_ADAPTER_HTTP_SERVER_CERT | Service server certificate | "" |
| MG_COAP_ADAPTER_HTTP_SERVER_KEY | Service server key | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | <localhost:7000> |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded things service Auth gRPC client certificate file | "" |
| MG_THINGS_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded things service Auth gRPC client key file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded things server Auth gRPC server trusted CA certificate file | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | <nats://localhost:4222> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:14268/api/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_COAP_ADAPTER_INSTANCE_ID | CoAP adapter instance ID | "" |
| Variable | Description | Default |
| -------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------- |
| MG_COAP_ADAPTER_LOG_LEVEL | Log level for the CoAP Adapter (debug, info, warn, error) | info |
| MG_COAP_ADAPTER_HOST | CoAP service listening host | "" |
| MG_COAP_ADAPTER_PORT | CoAP service listening port | 5683 |
| MG_COAP_ADAPTER_SERVER_CERT | CoAP service server certificate | "" |
| MG_COAP_ADAPTER_SERVER_KEY | CoAP service server key | "" |
| MG_COAP_ADAPTER_HTTP_HOST | Service HTTP listening host | "" |
| MG_COAP_ADAPTER_HTTP_PORT | Service listening port | 5683 |
| MG_COAP_ADAPTER_HTTP_SERVER_CERT | Service server certificate | "" |
| MG_COAP_ADAPTER_HTTP_SERVER_KEY | Service server key | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | <localhost:7000> |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded things service Auth gRPC client certificate file | "" |
| MG_THINGS_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded things service Auth gRPC client key file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded things server Auth gRPC server trusted CA certificate file | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | <nats://localhost:4222> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:4318/v1/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_COAP_ADAPTER_INSTANCE_ID | CoAP adapter instance ID | "" |
## Deployment
consumers/writers/postgres/README.md
+21 -21
View File
@@ -8,27 +8,27 @@ The service is configured using the environment variables presented in the
following table. Note that any unset variables will be replaced with their
default values.
| Variable | Description | Default |
| ----------------------------------- | --------------------------------------------------------------------------------- | ------------------------------ |
| MG_POSTGRES_WRITER_LOG_LEVEL | Service log level | info |
| MG_POSTGRES_WRITER_CONFIG_PATH | Config file path with Message broker subjects list, payload type and content-type | /config.toml |
| MG_POSTGRES_WRITER_HTTP_HOST | Service HTTP host | localhost |
| MG_POSTGRES_WRITER_HTTP_PORT | Service HTTP port | 9010 |
| MG_POSTGRES_WRITER_HTTP_SERVER_CERT | Service HTTP server certificate path | "" |
| MG_POSTGRES_WRITER_HTTP_SERVER_KEY | Service HTTP server key | "" |
| MG_POSTGRES_HOST | Postgres DB host | postgres |
| MG_POSTGRES_PORT | Postgres DB port | 5432 |
| MG_POSTGRES_USER | Postgres user | magistrala |
| MG_POSTGRES_PASS | Postgres password | magistrala |
| MG_POSTGRES_NAME | Postgres database name | messages |
| MG_POSTGRES_SSL_MODE | Postgres SSL mode | disabled |
| MG_POSTGRES_SSL_CERT | Postgres SSL certificate path | "" |
| MG_POSTGRES_SSL_KEY | Postgres SSL key | "" |
| MG_POSTGRES_SSL_ROOT_CERT | Postgres SSL root certificate path | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | nats://localhost:4222 |
| MG_JAEGER_URL | Jaeger server URL | http://jaeger:14268/api/traces |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_POSTGRES_WRITER_INSTANCE_ID | Service instance ID | "" |
| Variable | Description | Default |
| ----------------------------------- | --------------------------------------------------------------------------------- | ----------------------------- |
| MG_POSTGRES_WRITER_LOG_LEVEL | Service log level | info |
| MG_POSTGRES_WRITER_CONFIG_PATH | Config file path with Message broker subjects list, payload type and content-type | /config.toml |
| MG_POSTGRES_WRITER_HTTP_HOST | Service HTTP host | localhost |
| MG_POSTGRES_WRITER_HTTP_PORT | Service HTTP port | 9010 |
| MG_POSTGRES_WRITER_HTTP_SERVER_CERT | Service HTTP server certificate path | "" |
| MG_POSTGRES_WRITER_HTTP_SERVER_KEY | Service HTTP server key | "" |
| MG_POSTGRES_HOST | Postgres DB host | postgres |
| MG_POSTGRES_PORT | Postgres DB port | 5432 |
| MG_POSTGRES_USER | Postgres user | magistrala |
| MG_POSTGRES_PASS | Postgres password | magistrala |
| MG_POSTGRES_NAME | Postgres database name | messages |
| MG_POSTGRES_SSL_MODE | Postgres SSL mode | disabled |
| MG_POSTGRES_SSL_CERT | Postgres SSL certificate path | "" |
| MG_POSTGRES_SSL_KEY | Postgres SSL key | "" |
| MG_POSTGRES_SSL_ROOT_CERT | Postgres SSL root certificate path | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | nats://localhost:4222 |
| MG_JAEGER_URL | Jaeger server URL | http://jaeger:4318/v1/traces |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_POSTGRES_WRITER_INSTANCE_ID | Service instance ID | "" |
## Deployment
consumers/writers/timescale/README.md
+21 -21
View File
@@ -8,27 +8,27 @@ The service is configured using the environment variables presented in the
following table. Note that any unset variables will be replaced with their
default values.
| Variable | Description | Default |
| ------------------------------------ | --------------------------------------------------------- | ------------------------------ |
| MG_TIMESCALE_WRITER_LOG_LEVEL | Service log level | info |
| MG_TIMESCALE_WRITER_CONFIG_PATH | Configuration file path with Message broker subjects list | /config.toml |
| MG_TIMESCALE_WRITER_HTTP_HOST | Service HTTP host | localhost |
| MG_TIMESCALE_WRITER_HTTP_PORT | Service HTTP port | 9012 |
| MG_TIMESCALE_WRITER_HTTP_SERVER_CERT | Service HTTP server certificate path | "" |
| MG_TIMESCALE_WRITER_HTTP_SERVER_KEY | Service HTTP server key | "" |
| MG_TIMESCALE_HOST | Timescale DB host | timescale |
| MG_TIMESCALE_PORT | Timescale DB port | 5432 |
| MG_TIMESCALE_USER | Timescale user | magistrala |
| MG_TIMESCALE_PASS | Timescale password | magistrala |
| MG_TIMESCALE_NAME | Timescale database name | messages |
| MG_TIMESCALE_SSL_MODE | Timescale SSL mode | disabled |
| MG_TIMESCALE_SSL_CERT | Timescale SSL certificate path | "" |
| MG_TIMESCALE_SSL_KEY | Timescale SSL key | "" |
| MG_TIMESCALE_SSL_ROOT_CERT | Timescale SSL root certificate path | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | nats://localhost:4222 |
| MG_JAEGER_URL | Jaeger server URL | http://jaeger:14268/api/traces |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_TIMESCALE_WRITER_INSTANCE_ID | Timescale writer instance ID | "" |
| Variable | Description | Default |
| ------------------------------------ | --------------------------------------------------------- | -------------------------------- |
| MG_TIMESCALE_WRITER_LOG_LEVEL | Service log level | info |
| MG_TIMESCALE_WRITER_CONFIG_PATH | Configuration file path with Message broker subjects list | /config.toml |
| MG_TIMESCALE_WRITER_HTTP_HOST | Service HTTP host | localhost |
| MG_TIMESCALE_WRITER_HTTP_PORT | Service HTTP port | 9012 |
| MG_TIMESCALE_WRITER_HTTP_SERVER_CERT | Service HTTP server certificate path | "" |
| MG_TIMESCALE_WRITER_HTTP_SERVER_KEY | Service HTTP server key | "" |
| MG_TIMESCALE_HOST | Timescale DB host | timescale |
| MG_TIMESCALE_PORT | Timescale DB port | 5432 |
| MG_TIMESCALE_USER | Timescale user | magistrala |
| MG_TIMESCALE_PASS | Timescale password | magistrala |
| MG_TIMESCALE_NAME | Timescale database name | messages |
| MG_TIMESCALE_SSL_MODE | Timescale SSL mode | disabled |
| MG_TIMESCALE_SSL_CERT | Timescale SSL certificate path | "" |
| MG_TIMESCALE_SSL_KEY | Timescale SSL key | "" |
| MG_TIMESCALE_SSL_ROOT_CERT | Timescale SSL root certificate path | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | nats://localhost:4222 |
| MG_JAEGER_URL | Jaeger server URL | http://jaeger:4318/v1/traces |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_TIMESCALE_WRITER_INSTANCE_ID | Timescale writer instance ID | "" |
## Deployment
docker/.env
+1 -1
View File
@@ -61,7 +61,7 @@ MG_ES_URL=${MG_MESSAGE_BROKER_URL}
MG_JAEGER_COLLECTOR_OTLP_ENABLED=true
MG_JAEGER_FRONTEND=16686
MG_JAEGER_OLTP_HTTP=4318
MG_JAEGER_URL=http://jaeger:4318
MG_JAEGER_URL=http://jaeger:4318/v1/traces
MG_JAEGER_TRACE_RATIO=1.0
MG_JAEGER_MEMORY_MAX_TRACES=5000
http/README.md
+1 -1
View File
@@ -19,7 +19,7 @@ The service is configured using the environment variables presented in the follo
| MG_THINGS_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded things service Auth gRPC client key file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded things server Auth gRPC server trusted CA certificate file | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | <nats://localhost:4222> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:14268/api/traces> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:4318/v1/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_HTTP_ADAPTER_INSTANCE_ID | Service instance ID | "" |
mqtt/README.md
+25 -25
View File
@@ -6,31 +6,31 @@ MQTT adapter provides an MQTT API for sending messages through the platform. MQT
The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.
| Variable | Description | Default |
| ---------------------------------------- | ---------------------------------------------------------------------------------- | ----------------------------------- |
| MG_MQTT_ADAPTER_LOG_LEVEL | Log level for the MQTT Adapter (debug, info, warn, error) | info |
| MG_MQTT_ADAPTER_MQTT_PORT | mProxy port | 1883 |
| MG_MQTT_ADAPTER_MQTT_TARGET_HOST | MQTT broker host | localhost |
| MG_MQTT_ADAPTER_MQTT_TARGET_PORT | MQTT broker port | 1883 |
| MG_MQTT_ADAPTER_MQTT_QOS | MQTT broker QoS | 1 |
| MG_MQTT_ADAPTER_FORWARDER_TIMEOUT | MQTT forwarder for multiprotocol communication timeout | 30s |
| MG_MQTT_ADAPTER_MQTT_TARGET_HEALTH_CHECK | URL of broker health check | "" |
| MG_MQTT_ADAPTER_WS_PORT | mProxy MQTT over WS port | 8080 |
| MG_MQTT_ADAPTER_WS_TARGET_HOST | MQTT broker host for MQTT over WS | localhost |
| MG_MQTT_ADAPTER_WS_TARGET_PORT | MQTT broker port for MQTT over WS | 8080 |
| MG_MQTT_ADAPTER_WS_TARGET_PATH | MQTT broker MQTT over WS path | /mqtt |
| MG_MQTT_ADAPTER_INSTANCE | Instance name for MQTT adapter | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | <localhost:7000> |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded things service Auth gRPC client certificate file | "" |
| MG_THINGS_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded things service Auth gRPC client key file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded things server Auth gRPC server trusted CA certificate file | "" |
| MG_ES_URL | Event sourcing URL | <nats://localhost:4222> |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | <nats://localhost:4222> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:14268/api/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_MQTT_ADAPTER_INSTANCE_ID | Service instance ID | "" |
| Variable | Description | Default |
| ---------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------- |
| MG_MQTT_ADAPTER_LOG_LEVEL | Log level for the MQTT Adapter (debug, info, warn, error) | info |
| MG_MQTT_ADAPTER_MQTT_PORT | mProxy port | 1883 |
| MG_MQTT_ADAPTER_MQTT_TARGET_HOST | MQTT broker host | localhost |
| MG_MQTT_ADAPTER_MQTT_TARGET_PORT | MQTT broker port | 1883 |
| MG_MQTT_ADAPTER_MQTT_QOS | MQTT broker QoS | 1 |
| MG_MQTT_ADAPTER_FORWARDER_TIMEOUT | MQTT forwarder for multiprotocol communication timeout | 30s |
| MG_MQTT_ADAPTER_MQTT_TARGET_HEALTH_CHECK | URL of broker health check | "" |
| MG_MQTT_ADAPTER_WS_PORT | mProxy MQTT over WS port | 8080 |
| MG_MQTT_ADAPTER_WS_TARGET_HOST | MQTT broker host for MQTT over WS | localhost |
| MG_MQTT_ADAPTER_WS_TARGET_PORT | MQTT broker port for MQTT over WS | 8080 |
| MG_MQTT_ADAPTER_WS_TARGET_PATH | MQTT broker MQTT over WS path | /mqtt |
| MG_MQTT_ADAPTER_INSTANCE | Instance name for MQTT adapter | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | <localhost:7000> |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded things service Auth gRPC client certificate file | "" |
| MG_THINGS_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded things service Auth gRPC client key file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded things server Auth gRPC server trusted CA certificate file | "" |
| MG_ES_URL | Event sourcing URL | <nats://localhost:4222> |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | <nats://localhost:4222> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:4318/v1/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_MQTT_ADAPTER_INSTANCE_ID | Service instance ID | "" |
## Deployment
readers/postgres/README.md
+27 -27
View File
@@ -8,33 +8,33 @@ The service is configured using the environment variables presented in the
following table. Note that any unset variables will be replaced with their
default values.
| Variable | Description | Default |
| ----------------------------------- | --------------------------------------------- | ------------------------------ |
| MG_POSTGRES_READER_LOG_LEVEL | Service log level | info |
| MG_POSTGRES_READER_HTTP_HOST | Service HTTP host | localhost |
| MG_POSTGRES_READER_HTTP_PORT | Service HTTP port | 9009 |
| MG_POSTGRES_READER_HTTP_SERVER_CERT | Service HTTP server cert | "" |
| MG_POSTGRES_READER_HTTP_SERVER_KEY | Service HTTP server key | "" |
| MG_POSTGRES_HOST | Postgres DB host | localhost |
| MG_POSTGRES_PORT | Postgres DB port | 5432 |
| MG_POSTGRES_USER | Postgres user | magistrala |
| MG_POSTGRES_PASS | Postgres password | magistrala |
| MG_POSTGRES_NAME | Postgres database name | messages |
| MG_POSTGRES_SSL_MODE | Postgres SSL mode | disabled |
| MG_POSTGRES_SSL_CERT | Postgres SSL certificate path | "" |
| MG_POSTGRES_SSL_KEY | Postgres SSL key | "" |
| MG_POSTGRES_SSL_ROOT_CERT | Postgres SSL root certificate path | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | localhost:7000 |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_TLS | Things service Auth gRPC TLS mode flag | false |
| MG_THINGS_AUTH_GRPC_CA_CERTS | Things service Auth gRPC CA certificates | "" |
| MG_AUTH_GRPC_URL | Auth service gRPC URL | localhost:7001 |
| MG_AUTH_GRPC_TIMEOUT | Auth service gRPC request timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_TLS | Auth service gRPC TLS mode flag | false |
| MG_AUTH_GRPC_CA_CERTS | Auth service gRPC CA certificates | "" |
| MG_JAEGER_URL | Jaeger server URL | http://jaeger:14268/api/traces |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_POSTGRES_READER_INSTANCE_ID | Postgres reader instance ID | |
| Variable | Description | Default |
| ----------------------------------- | --------------------------------------------- | ----------------------------- |
| MG_POSTGRES_READER_LOG_LEVEL | Service log level | info |
| MG_POSTGRES_READER_HTTP_HOST | Service HTTP host | localhost |
| MG_POSTGRES_READER_HTTP_PORT | Service HTTP port | 9009 |
| MG_POSTGRES_READER_HTTP_SERVER_CERT | Service HTTP server cert | "" |
| MG_POSTGRES_READER_HTTP_SERVER_KEY | Service HTTP server key | "" |
| MG_POSTGRES_HOST | Postgres DB host | localhost |
| MG_POSTGRES_PORT | Postgres DB port | 5432 |
| MG_POSTGRES_USER | Postgres user | magistrala |
| MG_POSTGRES_PASS | Postgres password | magistrala |
| MG_POSTGRES_NAME | Postgres database name | messages |
| MG_POSTGRES_SSL_MODE | Postgres SSL mode | disabled |
| MG_POSTGRES_SSL_CERT | Postgres SSL certificate path | "" |
| MG_POSTGRES_SSL_KEY | Postgres SSL key | "" |
| MG_POSTGRES_SSL_ROOT_CERT | Postgres SSL root certificate path | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | localhost:7000 |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_TLS | Things service Auth gRPC TLS mode flag | false |
| MG_THINGS_AUTH_GRPC_CA_CERTS | Things service Auth gRPC CA certificates | "" |
| MG_AUTH_GRPC_URL | Auth service gRPC URL | localhost:7001 |
| MG_AUTH_GRPC_TIMEOUT | Auth service gRPC request timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_TLS | Auth service gRPC TLS mode flag | false |
| MG_AUTH_GRPC_CA_CERTS | Auth service gRPC CA certificates | "" |
| MG_JAEGER_URL | Jaeger server URL | http://jaeger:4318/v1/traces |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_POSTGRES_READER_INSTANCE_ID | Postgres reader instance ID | |
## Deployment
readers/timescale/README.md
+27 -27
View File
@@ -8,33 +8,33 @@ The service is configured using the environment variables presented in the
following table. Note that any unset variables will be replaced with their
default values.
| Variable | Description | Default |
| ------------------------------------ | --------------------------------------------- | ------------------------------ |
| MG_TIMESCALE_READER_LOG_LEVEL | Service log level | info |
| MG_TIMESCALE_READER_HTTP_HOST | Service HTTP host | localhost |
| MG_TIMESCALE_READER_HTTP_PORT | Service HTTP port | 8180 |
| MG_TIMESCALE_READER_HTTP_SERVER_CERT | Service HTTP server certificate path | "" |
| MG_TIMESCALE_READER_HTTP_SERVER_KEY | Service HTTP server key path | "" |
| MG_TIMESCALE_HOST | Timescale DB host | localhost |
| MG_TIMESCALE_PORT | Timescale DB port | 5432 |
| MG_TIMESCALE_USER | Timescale user | magistrala |
| MG_TIMESCALE_PASS | Timescale password | magistrala |
| MG_TIMESCALE_NAME | Timescale database name | messages |
| MG_TIMESCALE_SSL_MODE | Timescale SSL mode | disabled |
| MG_TIMESCALE_SSL_CERT | Timescale SSL certificate path | "" |
| MG_TIMESCALE_SSL_KEY | Timescale SSL key | "" |
| MG_TIMESCALE_SSL_ROOT_CERT | Timescale SSL root certificate path | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | localhost:7000 |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_TLS | Things service Auth gRPC TLS enabled flag | false |
| MG_THINGS_AUTH_GRPC_CA_CERTS | Things service Auth gRPC CA certificates | "" |
| MG_AUTH_GRPC_URL | Auth service gRPC URL | localhost:7001 |
| MG_AUTH_GRPC_TIMEOUT | Auth service gRPC timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_TLS | Auth service gRPC TLS enabled flag | false |
| MG_AUTH_GRPC_CA_CERT | Auth service gRPC CA certificate | "" |
| MG_JAEGER_URL | Jaeger server URL | http://jaeger:14268/api/traces |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_TIMESCALE_READER_INSTANCE_ID | Timescale reader instance ID | "" |
| Variable | Description | Default |
| ------------------------------------ | --------------------------------------------- | ----------------------------- |
| MG_TIMESCALE_READER_LOG_LEVEL | Service log level | info |
| MG_TIMESCALE_READER_HTTP_HOST | Service HTTP host | localhost |
| MG_TIMESCALE_READER_HTTP_PORT | Service HTTP port | 8180 |
| MG_TIMESCALE_READER_HTTP_SERVER_CERT | Service HTTP server certificate path | "" |
| MG_TIMESCALE_READER_HTTP_SERVER_KEY | Service HTTP server key path | "" |
| MG_TIMESCALE_HOST | Timescale DB host | localhost |
| MG_TIMESCALE_PORT | Timescale DB port | 5432 |
| MG_TIMESCALE_USER | Timescale user | magistrala |
| MG_TIMESCALE_PASS | Timescale password | magistrala |
| MG_TIMESCALE_NAME | Timescale database name | messages |
| MG_TIMESCALE_SSL_MODE | Timescale SSL mode | disabled |
| MG_TIMESCALE_SSL_CERT | Timescale SSL certificate path | "" |
| MG_TIMESCALE_SSL_KEY | Timescale SSL key | "" |
| MG_TIMESCALE_SSL_ROOT_CERT | Timescale SSL root certificate path | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | localhost:7000 |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_TLS | Things service Auth gRPC TLS enabled flag | false |
| MG_THINGS_AUTH_GRPC_CA_CERTS | Things service Auth gRPC CA certificates | "" |
| MG_AUTH_GRPC_URL | Auth service gRPC URL | localhost:7001 |
| MG_AUTH_GRPC_TIMEOUT | Auth service gRPC timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_TLS | Auth service gRPC TLS enabled flag | false |
| MG_AUTH_GRPC_CA_CERT | Auth service gRPC CA certificate | "" |
| MG_JAEGER_URL | Jaeger server URL | http://jaeger:4318/v1/traces |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_TIMESCALE_READER_INSTANCE_ID | Timescale reader instance ID | "" |
## Deployment
things/README.md
+34 -34
View File
@@ -16,40 +16,40 @@ The service is configured using the environment variables presented in the
following table. Note that any unset variables will be replaced with their
default values.
| Variable | Description | Default |
| ------------------------------- | ----------------------------------------------------------------------- | -------------------------------- |
| MG_THINGS_LOG_LEVEL | Log level for Things (debug, info, warn, error) | info |
| MG_THINGS_HTTP_HOST | Things service HTTP host | localhost |
| MG_THINGS_HTTP_PORT | Things service HTTP port | 9000 |
| MG_THINGS_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_THINGS_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_THINGS_AUTH_GRPC_HOST | Things service gRPC host | localhost |
| MG_THINGS_AUTH_GRPC_PORT | Things service gRPC port | 7000 |
| MG_THINGS_AUTH_GRPC_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_THINGS_DB_HOST | Database host address | localhost |
| MG_THINGS_DB_PORT | Database host port | 5432 |
| MG_THINGS_DB_USER | Database user | magistrala |
| MG_THINGS_DB_PASS | Database password | magistrala |
| MG_THINGS_DB_NAME | Name of the database used by the service | things |
| MG_THINGS_DB_SSL_MODE | Database connection SSL mode (disable, require, verify-ca, verify-full) | disable |
| MG_THINGS_DB_SSL_CERT | Path to the PEM encoded certificate file | "" |
| MG_THINGS_DB_SSL_KEY | Path to the PEM encoded key file | "" |
| MG_THINGS_DB_SSL_ROOT_CERT | Path to the PEM encoded root certificate file | "" |
| MG_THINGS_CACHE_URL | Cache database URL | <redis://localhost:6379/0> |
| MG_THINGS_CACHE_KEY_DURATION | Cache key duration in seconds | 3600 |
| MG_THINGS_ES_URL | Event store URL | <localhost:6379> |
| MG_THINGS_ES_PASS | Event store password | "" |
| MG_THINGS_ES_DB | Event store instance name | 0 |
| MG_THINGS_STANDALONE_ID | User ID for standalone mode (no gRPC communication with Auth) | "" |
| MG_THINGS_STANDALONE_TOKEN | User token for standalone mode that should be passed in auth header | "" |
| MG_JAEGER_URL | Jaeger server URL | <http://jaeger:14268/api/traces> |
| MG_AUTH_GRPC_URL | Auth service gRPC URL | localhost:7001 |
| MG_AUTH_GRPC_TIMEOUT | Auth service gRPC request timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_TLS | Enable TLS for gRPC client | false |
| MG_AUTH_GRPC_CA_CERT | Path to the CA certificate file | "" |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server. | true |
| MG_THINGS_INSTANCE_ID | Things instance ID | "" |
| Variable | Description | Default |
| ------------------------------- | ----------------------------------------------------------------------- | ------------------------------- |
| MG_THINGS_LOG_LEVEL | Log level for Things (debug, info, warn, error) | info |
| MG_THINGS_HTTP_HOST | Things service HTTP host | localhost |
| MG_THINGS_HTTP_PORT | Things service HTTP port | 9000 |
| MG_THINGS_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_THINGS_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_THINGS_AUTH_GRPC_HOST | Things service gRPC host | localhost |
| MG_THINGS_AUTH_GRPC_PORT | Things service gRPC port | 7000 |
| MG_THINGS_AUTH_GRPC_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_THINGS_DB_HOST | Database host address | localhost |
| MG_THINGS_DB_PORT | Database host port | 5432 |
| MG_THINGS_DB_USER | Database user | magistrala |
| MG_THINGS_DB_PASS | Database password | magistrala |
| MG_THINGS_DB_NAME | Name of the database used by the service | things |
| MG_THINGS_DB_SSL_MODE | Database connection SSL mode (disable, require, verify-ca, verify-full) | disable |
| MG_THINGS_DB_SSL_CERT | Path to the PEM encoded certificate file | "" |
| MG_THINGS_DB_SSL_KEY | Path to the PEM encoded key file | "" |
| MG_THINGS_DB_SSL_ROOT_CERT | Path to the PEM encoded root certificate file | "" |
| MG_THINGS_CACHE_URL | Cache database URL | <redis://localhost:6379/0> |
| MG_THINGS_CACHE_KEY_DURATION | Cache key duration in seconds | 3600 |
| MG_THINGS_ES_URL | Event store URL | <localhost:6379> |
| MG_THINGS_ES_PASS | Event store password | "" |
| MG_THINGS_ES_DB | Event store instance name | 0 |
| MG_THINGS_STANDALONE_ID | User ID for standalone mode (no gRPC communication with Auth) | "" |
| MG_THINGS_STANDALONE_TOKEN | User token for standalone mode that should be passed in auth header | "" |
| MG_JAEGER_URL | Jaeger server URL | <http://jaeger:4318/v1/traces> |
| MG_AUTH_GRPC_URL | Auth service gRPC URL | localhost:7001 |
| MG_AUTH_GRPC_TIMEOUT | Auth service gRPC request timeout in seconds | 1s |
| MG_AUTH_GRPC_CLIENT_TLS | Enable TLS for gRPC client | false |
| MG_AUTH_GRPC_CA_CERT | Path to the CA certificate file | "" |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server. | true |
| MG_THINGS_INSTANCE_ID | Things instance ID | "" |
**Note** that if you want `things` service to have only one user locally, you should use `MG_THINGS_STANDALONE` env vars. By specifying these, you don't need `auth` service in your deployment for users' authorization.
users/README.md
+43 -43
View File
@@ -12,49 +12,49 @@ For in-depth explanation of the aforementioned scenarios, as well as thorough un
The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.
| Variable | Description | Default |
| ----------------------------- | ----------------------------------------------------------------------- | ----------------------------------- |
| MG_USERS_LOG_LEVEL | Log level for users service (debug, info, warn, error) | info |
| MG_USERS_ADMIN_EMAIL | Default user, created on startup | <admin@example.com> |
| MG_USERS_ADMIN_PASSWORD | Default user password, created on startup | 12345678 |
| MG_USERS_PASS_REGEX | Password regex | ^.{8,}$ |
| MG_TOKEN_RESET_ENDPOINT | Password request reset endpoint, for constructing link | /reset-request |
| MG_USERS_HTTP_HOST | Users service HTTP host | localhost |
| MG_USERS_HTTP_PORT | Users service HTTP port | 9002 |
| MG_USERS_HTTP_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_USERS_HTTP_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_USERS_HTTP_SERVER_CA_CERTS | Path to the PEM encoded server CA certificate file | "" |
| MG_USERS_HTTP_CLIENT_CA_CERTS | Path to the PEM encoded client CA certificate file | "" |
| MG_AUTH_GRPC_URL | Auth service GRPC URL | localhost:8181 |
| MG_AUTH_GRPC_TIMEOUT | Auth service GRPC timeout | 1s |
| MG_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded client certificate file | "" |
| MG_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded client key file | "" |
| MG_AUTH_GRPC_SERVER_CA_CERTS | Path to the PEM encoded server CA certificate file | "" |
| MG_USERS_DB_HOST | Database host address | localhost |
| MG_USERS_DB_PORT | Database host port | 5432 |
| MG_USERS_DB_USER | Database user | magistrala |
| MG_USERS_DB_PASS | Database password | magistrala |
| MG_USERS_DB_NAME | Name of the database used by the service | users |
| MG_USERS_DB_SSL_MODE | Database connection SSL mode (disable, require, verify-ca, verify-full) | disable |
| MG_USERS_DB_SSL_CERT | Path to the PEM encoded certificate file | "" |
| MG_USERS_DB_SSL_KEY | Path to the PEM encoded key file | "" |
| MG_USERS_DB_SSL_ROOT_CERT | Path to the PEM encoded root certificate file | "" |
| MG_EMAIL_HOST | Mail server host | localhost |
| MG_EMAIL_PORT | Mail server port | 25 |
| MG_EMAIL_USERNAME | Mail server username | "" |
| MG_EMAIL_PASSWORD | Mail server password | "" |
| MG_EMAIL_FROM_ADDRESS | Email "from" address | "" |
| MG_EMAIL_FROM_NAME | Email "from" name | "" |
| MG_EMAIL_TEMPLATE | Email template for sending emails with password reset link | email.tmpl |
| MG_USERS_ES_URL | Event store URL | <nats://localhost:4222> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:14268/api/traces> |
| MG_OAUTH_UI_REDIRECT_URL | OAuth UI redirect URL | <http://localhost:9095/domains> |
| MG_OAUTH_UI_ERROR_URL | OAuth UI error URL | <http://localhost:9095/error> |
| MG_USERS_DELETE_INTERVAL | Interval for deleting users | 24h |
| MG_USERS_DELETE_AFTER | Time after which users are deleted | 720h |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server. | true |
| MG_USERS_INSTANCE_ID | Magistrala instance ID | "" |
| Variable | Description | Default |
| ----------------------------- | ----------------------------------------------------------------------- | ---------------------------------- |
| MG_USERS_LOG_LEVEL | Log level for users service (debug, info, warn, error) | info |
| MG_USERS_ADMIN_EMAIL | Default user, created on startup | <admin@example.com> |
| MG_USERS_ADMIN_PASSWORD | Default user password, created on startup | 12345678 |
| MG_USERS_PASS_REGEX | Password regex | ^.{8,}$ |
| MG_TOKEN_RESET_ENDPOINT | Password request reset endpoint, for constructing link | /reset-request |
| MG_USERS_HTTP_HOST | Users service HTTP host | localhost |
| MG_USERS_HTTP_PORT | Users service HTTP port | 9002 |
| MG_USERS_HTTP_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_USERS_HTTP_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_USERS_HTTP_SERVER_CA_CERTS | Path to the PEM encoded server CA certificate file | "" |
| MG_USERS_HTTP_CLIENT_CA_CERTS | Path to the PEM encoded client CA certificate file | "" |
| MG_AUTH_GRPC_URL | Auth service GRPC URL | localhost:8181 |
| MG_AUTH_GRPC_TIMEOUT | Auth service GRPC timeout | 1s |
| MG_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded client certificate file | "" |
| MG_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded client key file | "" |
| MG_AUTH_GRPC_SERVER_CA_CERTS | Path to the PEM encoded server CA certificate file | "" |
| MG_USERS_DB_HOST | Database host address | localhost |
| MG_USERS_DB_PORT | Database host port | 5432 |
| MG_USERS_DB_USER | Database user | magistrala |
| MG_USERS_DB_PASS | Database password | magistrala |
| MG_USERS_DB_NAME | Name of the database used by the service | users |
| MG_USERS_DB_SSL_MODE | Database connection SSL mode (disable, require, verify-ca, verify-full) | disable |
| MG_USERS_DB_SSL_CERT | Path to the PEM encoded certificate file | "" |
| MG_USERS_DB_SSL_KEY | Path to the PEM encoded key file | "" |
| MG_USERS_DB_SSL_ROOT_CERT | Path to the PEM encoded root certificate file | "" |
| MG_EMAIL_HOST | Mail server host | localhost |
| MG_EMAIL_PORT | Mail server port | 25 |
| MG_EMAIL_USERNAME | Mail server username | "" |
| MG_EMAIL_PASSWORD | Mail server password | "" |
| MG_EMAIL_FROM_ADDRESS | Email "from" address | "" |
| MG_EMAIL_FROM_NAME | Email "from" name | "" |
| MG_EMAIL_TEMPLATE | Email template for sending emails with password reset link | email.tmpl |
| MG_USERS_ES_URL | Event store URL | <nats://localhost:4222> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:4318/v1/traces> |
| MG_OAUTH_UI_REDIRECT_URL | OAuth UI redirect URL | <http://localhost:9095/domains> |
| MG_OAUTH_UI_ERROR_URL | OAuth UI error URL | <http://localhost:9095/error> |
| MG_USERS_DELETE_INTERVAL | Interval for deleting users | 24h |
| MG_USERS_DELETE_AFTER | Time after which users are deleted | 720h |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server. | true |
| MG_USERS_INSTANCE_ID | Magistrala instance ID | "" |
## Deployment
ws/README.md
+17 -17
View File
@@ -6,23 +6,23 @@ WebSocket adapter provides a [WebSocket](https://en.wikipedia.org/wiki/WebSocket
The service is configured using the environment variables presented in the following table. Note that any unset variables will be replaced with their default values.
| Variable | Description | Default |
| -------------------------------- | ---------------------------------------------------------------------------------- | ----------------------------------- |
| MG_WS_ADAPTER_LOG_LEVEL | Log level for the WS Adapter (debug, info, warn, error) | info |
| MG_WS_ADAPTER_HTTP_HOST | Service WS host | "" |
| MG_WS_ADAPTER_HTTP_PORT | Service WS port | 8190 |
| MG_WS_ADAPTER_HTTP_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_WS_ADAPTER_HTTP_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | <localhost:7000> |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded things service Auth gRPC client certificate file | "" |
| MG_THINGS_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded things service Auth gRPC client key file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded things server Auth gRPC server trusted CA certificate file | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | <nats://localhost:4222> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:14268/api/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_WS_ADAPTER_INSTANCE_ID | Service instance ID | "" |
| Variable | Description | Default |
| -------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------- |
| MG_WS_ADAPTER_LOG_LEVEL | Log level for the WS Adapter (debug, info, warn, error) | info |
| MG_WS_ADAPTER_HTTP_HOST | Service WS host | "" |
| MG_WS_ADAPTER_HTTP_PORT | Service WS port | 8190 |
| MG_WS_ADAPTER_HTTP_SERVER_CERT | Path to the PEM encoded server certificate file | "" |
| MG_WS_ADAPTER_HTTP_SERVER_KEY | Path to the PEM encoded server key file | "" |
| MG_THINGS_AUTH_GRPC_URL | Things service Auth gRPC URL | <localhost:7000> |
| MG_THINGS_AUTH_GRPC_TIMEOUT | Things service Auth gRPC request timeout in seconds | 1s |
| MG_THINGS_AUTH_GRPC_CLIENT_CERT | Path to the PEM encoded things service Auth gRPC client certificate file | "" |
| MG_THINGS_AUTH_GRPC_CLIENT_KEY | Path to the PEM encoded things service Auth gRPC client key file | "" |
| MG_THINGS_AUTH_GRPC_SERVER_CERTS | Path to the PEM encoded things server Auth gRPC server trusted CA certificate file | "" |
| MG_MESSAGE_BROKER_URL | Message broker instance URL | <nats://localhost:4222> |
| MG_JAEGER_URL | Jaeger server URL | <http://localhost:4318/v1/traces> |
| MG_JAEGER_TRACE_RATIO | Jaeger sampling ratio | 1.0 |
| MG_SEND_TELEMETRY | Send telemetry to magistrala call home server | true |
| MG_WS_ADAPTER_INSTANCE_ID | Service instance ID | "" |
## Deployment