The CMS service is a microservice that allows managing taxonomies and contents. It is available as a Docker image and is designed to make it easy to edit and analyze content. This guide will walk you through the process of setting up the service and configuring it to meet your needs.
SECURITY_OAUTH2_BASE_SERVER_URL
- the base URL for the OAuth 2.0 Authorization Server, which is responsible for authentication and authorization for clients and users, it is used to authorize clients, as well as to issue and validate access tokensSECURITY_OAUTH2_CLIENT_CLIENT_ID
- a unique identifier for a client application that is registered with the OAuth 2.0 Authorization Server, this is used to authenticate the client application when it attempts to access resources on behalf of a userSECURITY_OAUTH2_CLIENT_CLIENT_SECRET
- secret key that is used to authenticate requests made by an authorization clientSECURITY_OAUTH2_REALM
- security configuration env var in the Spring Security OAuth2 framework, it is used to specify the realm name used when authenticating with OAuth2 providerSPRING_DATA_MONGODB_URI
- environment variable used to provide the connection string for a MongoDB database that is used with, this connection string provides the host, port, database name, user credentials, and other configuration details for the MongoDB serverSPRING_REDIS_HOST
- environment variable used to configure the hostname or IP address of a Redis server when using Spring Data RedisSPRING_REDIS_PASSWORD
- environment variable is used to store the password used to authenticate with a Redis server, it is used to secure access to the Redis server and should be kept confidentialREDIS_TTL
- environment variable is used to specify the maximum time-to-live (TTL) for a key in Redis, it is used to set a limit on how long a key can exist before it is automatically expired (Redis will delete the key after the specified TTL has expired)SPRING_KAFKA_BOOTSTRAP_SERVERS
- address of the Kafka server, it should be in the format “host:port”SPRING_KAFKA_CONSUMER_GROUP_ID
- a group of consumersKAFKA_CONSUMER_THREADS
- the number of Kafka consumer threadsKAFKA_AUTH_EXCEPTION_RETRY_INTERVAL
- the interval between retries after AuthorizationException
is thrown by KafkaConsumer
KAFKA_TOPIC_AUDIT_OUT
- the topic key for receiving audit logsEnvironment Variable | Default FLOWX.AI value (Customizable) |
---|---|
KAFKA_TOPIC_REQUEST_CONTENT_IN | ai.flowx.dev.plugin.cms.trigger.retrieve.content.v1 |
KAFKA_TOPIC_REQUEST_CONTENT_OUT | ai.flowx.dev.engine.receive.plugin.cms.retrieve.content.results.v1 |
KAFKA_TOPIC_REQUEST_CONTENT_IN
: This variable defines the topic used by the CMS to listen for incoming content retrieval requests.KAFKA_TOPIC_REQUEST_CONTENT_OUT
: This variable defines the topic where the CMS sends the results of content retrieval requests back to the FlowX Engine.LOGGING_LEVEL_ROOT
- the log level for the root spring boot microservice logsLOGGING_LEVEL_APP
- the log level for app-level logsLOGGING_LEVEL_MONGO_DRIVER
- the log level for mongo driverAPPLICATION_FILE_STORAGE_S3_SERVER_URL
- environment variable used to store the URL of the S3 server that is used to store files for the application.APPLICATION_FILE_STORAGE_S3_BUCKET_NAME
- environment variable used to store the name of the S3 bucket that is used to store files for the applicationAPPLICATION_FILE_STORAGE_S3_ROOT_DIRECTORY
- environment variable used to store the root directory within the S3 bucket where the files for the application are storedAPPLICATION_FILE_STORAGE_S3_CREATE_BUCKET
- environment variable used to indicate whether the S3 bucket should be created if it does not already exist, it can be set to true or falseAPPLICATION_FILE_STORAGE_S3_PUBLIC_URL
- the public URL of the S3 solution, it specifies the URL that can be used to access the files storedSPRING_SERVLET_MULTIPART_MAX_FILE_SIZE: ${MULTIPART_MAX_FILE_SIZE:50MB}
: Defines the maximum file size allowed for uploads. Default is 50 MB.SPRING_SERVLET_MULTIPART_MAX_REQUEST_SIZE: ${MULTIPART_MAX_REQUEST_SIZE:50MB}
: Defines the maximum request size allowed for uploads. Default is 50 MB.MANAGEMENT_METRICS_EXPORT_PROMETHEUS_ENABLED
: Enables or disables Prometheus metrics export.Environment Variable | Description | Default Value | Possible Values |
---|---|---|---|
MANAGEMENT_PROMETHEUS_METRICS_EXPORT_ENABLED | Enables or disables Prometheus metrics export. | false | true , false |