README.md

flux-field-value-storage

Field value storage

Set up

You need to fill placeholders (Wrapped in %), create secret files and adjust to your needs (Applies everywhere)

Mongo db

You need a mongo db server

Set up

You need to create a mongo db user flux-field-value-storage on database flux-field-value-storage

Docker

Compose

services:
    flux-field-value-storage:
        depends_on:
            - mongo-db
        environment:
            - FLUX_FIELD_VALUE_STORAGE_AUTHENTICATION_PASSWORD_FILE=/run/secrets/flux_field_value_storage_password
            - FLUX_FIELD_VALUE_STORAGE_MONGO_DB_PASSWORD_FILE=/run/secrets/mongo_db_flux_field_value_storage_password
        image: fluxfw/flux-field-value-storage:%version%
        secrets:
            - flux_field_value_storage_password
            - mongo_db_flux_field_value_storage_password
secrets:
    flux_field_value_storage_password:
        file: ./data/secrets/flux_field_value_storage_password
    mongo_db_flux_field_value_storage_password:
        file: ./data/secrets/mongo_db_flux_field_value_storage_password

Config

Config	Default value	Environment variable	Cli parameter	Config JSON file
Config JSON file (Root entry need to be an object)	-	FLUX_FIELD_VALUE_STORAGE_CONFIG_FILE	--config-file ...	-
Authentication password	-	FLUX_FIELD_VALUE_STORAGE_AUTHENTICATION_PASSWORD FLUX_FIELD_VALUE_STORAGE_AUTHENTICATION_PASSWORD_FILE	--authentication-password ... --authentication-password-file ...	"authentication-password": "..." "authentication-password-file": "..."
Authentication user	flux-field-value-storage	FLUX_FIELD_VALUE_STORAGE_AUTHENTICATION_USER FLUX_FIELD_VALUE_STORAGE_AUTHENTICATION_USER_FILE	--authentication-user ... --authentication-user-file ...	"authentication-user": "..." "authentication-user-file": "..."
MongoDb database	flux-field-value-storage	FLUX_FIELD_VALUE_STORAGE_MONGO_DB_DATABASE FLUX_FIELD_VALUE_STORAGE_MONGO_DB_DATABASE_FILE	--mongo-db-database ... --mongo-db-database-file ...	"mongo-db-database": "..." "mongo-db-database-file": "..."
MongoDb host	mongo-db	FLUX_FIELD_VALUE_STORAGE_MONGO_DB_HOST FLUX_FIELD_VALUE_STORAGE_MONGO_DB_HOST_FILE	--mongo-db-host ... --mongo-db-host-file ...	"mongo-db-host": "..." "mongo-db-host-file": "..."
MongoDb password	-	FLUX_FIELD_VALUE_STORAGE_MONGO_DB_PASSWORD FLUX_FIELD_VALUE_STORAGE_MONGO_DB_PASSWORD_FILE	--mongo-db-password ... --mongo-db-password-file ...	"mongo-db-password": "..." "mongo-db-password-file": "..."
MongoDb port	27017	FLUX_FIELD_VALUE_STORAGE_MONGO_DB_PORT FLUX_FIELD_VALUE_STORAGE_MONGO_DB_PORT_FILE	--mongo-db-port ... --mongo-db-port-file ...	"mongo-db-port": ... "mongo-db-port-file": ...
MongoDb user	flux-field-value-storage	FLUX_FIELD_VALUE_STORAGE_MONGO_DB_USER FLUX_FIELD_VALUE_STORAGE_MONGO_DB_USER_FILE	--mongo-db-user ... --mongo-db-user-file ...	"mongo-db-user": "..." "mongo-db-user-file": "..."
Server disable http if https is used	true	FLUX_FIELD_VALUE_STORAGE_SERVER_DISABLE_HTTP_IF_HTTPS FLUX_FIELD_VALUE_STORAGE_SERVER_DISABLE_HTTP_IF_HTTPS_FILE	--server-disable-http-if-https ... --server-disable-http-if-https-file ...	"server-disable-http-if-https": ... "server-disable-http-if-https-file": "..."
Server HTTPS certificate (HTTPS is only used if this config is set)	-	FLUX_FIELD_VALUE_STORAGE_SERVER_HTTPS_CERTIFICATE FLUX_FIELD_VALUE_STORAGE_SERVER_HTTPS_CERTIFICATE_FILE	--server-https-certificate ... --server-https-certificate-file ...	"server-https-certificate": "..." "server-https-certificate-file": "..."
Server HTTPS dh param	-	FLUX_FIELD_VALUE_STORAGE_SERVER_HTTPS_DHPARAM FLUX_FIELD_VALUE_STORAGE_SERVER_HTTPS_DHPARAM_FILE	--server-https-dhparam ... --server-https-dhparam-file ...	"server-https-dhparam": "..." "server-https-dhparam-file": "..."
Server HTTPS private key (HTTPS is only used if this config is set)	-	FLUX_FIELD_VALUE_STORAGE_SERVER_HTTPS_KEY FLUX_FIELD_VALUE_STORAGE_SERVER_HTTPS_KEY_FILE	--server-https-key ... --server-https-key-file ...	"server-https-key": "..." "server-https-key-file": "..."
Server listen HTTP port (Set to 0 for explicit disable HTTP)	80	FLUX_FIELD_VALUE_STORAGE_SERVER_LISTEN_HTTP_PORT FLUX_FIELD_VALUE_STORAGE_SERVER_LISTEN_HTTP_PORT_FILE	--server-listen-http-port ... --server-listen-http-port-file ...	"server-listen-http-port": ... "server-listen-http-port-file": "..."
Server listen HTTPS port (Set to 0 for explicit disable HTTPS)	443	FLUX_FIELD_VALUE_STORAGE_SERVER_LISTEN_HTTPS_PORT FLUX_FIELD_VALUE_STORAGE_SERVER_LISTEN_HTTPS_PORT_FILE	--server-listen-https-port ... --server-listen-https-port-file ...	"server-listen-https-port": ... "server-listen-https-port-file": "..."
Server listen interface	-	FLUX_FIELD_VALUE_STORAGE_SERVER_LISTEN_INTERFACE FLUX_FIELD_VALUE_STORAGE_SERVER_LISTEN_INTERFACE_FILE	--server-listen-interface ... --server-listen-interface-file ...	"server-listen-interface": "..." "server-listen-interface-file": "..."
Enable server redirects HTTP to HTTPS	false	FLUX_FIELD_VALUE_STORAGE_SERVER_REDIRECT_HTTP_TO_HTTPS FLUX_FIELD_VALUE_STORAGE_SERVER_REDIRECT_HTTP_TO_HTTPS_FILE	--server-redirect-http-to-https ... --server-redirect-http-to-https-file ...	"server-redirect-http-to-https": ... "server-redirect-http-to-https-file": "..."
Server redirect HTTP to HTTPS port	443	FLUX_FIELD_VALUE_STORAGE_SERVER_REDIRECT_HTTP_TO_HTTPS_PORT FLUX_FIELD_VALUE_STORAGE_SERVER_REDIRECT_HTTP_TO_HTTPS_PORT_FILE	--server-redirect-http-to-https-port ... --server-redirect-http-to-https-port-file ...	"server-redirect-http-to-https-port": ... "server-redirect-http-to-https-port-file": "..."
HTTP status code server redirects HTTP to HTTPS	302	FLUX_FIELD_VALUE_STORAGE_SERVER_REDIRECT_HTTP_TO_HTTPS_STATUS_CODE FLUX_FIELD_VALUE_STORAGE_SERVER_REDIRECT_HTTP_TO_HTTPS_STATUS_CODE_FILE	--server-redirect-http-to-https-status-code ... --server-redirect-http-to-https-status-code-file ...	"server-redirect-http-to-https-status-code": ... "server-redirect-http-to-https-status-code-file": "..."

Required config are bold