folioci/mod-notes repository overview

⁠FOLIO - mod-notes

Notes on all types of objects

Code Repository: https://github.com/folio-org/mod-notes⁠

⁠Metadata

• Container memory (bytes): 542293850
• Module ports: 8081/tcp

⁠Default environment variables

• JAVA_OPTIONS:
  • -XX:MaxRAMPercentage=66.0
• FOLIO database connection: true
• FOLIO database common environment:
  • DB_DATABASE, DB_HOST, DB_PORT, DB_USERNAME, DB_PASSWORD, DB_CHARSET
• FOLIO database other environment:
  • DB_MAXPOOLSIZE
    • Default value: 5
  • DB_QUERYTIMEOUT
    • Default value: 60000
• ENV
  • Description: The logical name of the deployment, must be unique across all environments using the same shared Kafka/Elasticsearch clusters, a-z (any case), 0-9, -, _ symbols only allowed
  • Default value: folio
• KAFKA_HOST
  • Default value: kafka
• KAFKA_NOTE_TOPIC_PARTITIONS
  • Description: Number of partitions for the notes.note topic.
  • Default value: 1
• KAFKA_NOTE_TOPIC_REPLICATION_FACTOR
  • Description: Replication factor for the notes.note topic. When not set, the broker default is used.
• KAFKA_PORT
  • Default value: 9092
• KAFKA_SECURITY_PROTOCOL
  • Description: Kafka security protocol used to communicate with brokers (SSL or PLAINTEXT)
  • Default value: PLAINTEXT
• KAFKA_SSL_KEYSTORE_LOCATION
  • Description: The location of the Kafka key store file. This is optional for client and can be used for two-way authentication for client.
• KAFKA_SSL_KEYSTORE_PASSWORD
  • Description: The store password for the Kafka key store file. This is optional for client and only needed if 'ssl.keystore.location' is configured.
• KAFKA_SSL_TRUSTSTORE_LOCATION
  • Description: The location of the Kafka trust store file.
• KAFKA_SSL_TRUSTSTORE_PASSWORD
  • Description: The password for the Kafka trust store file. If a password is not set, trust store file configured will still be used, but integrity checking is disabled.
• NOTES_TYPES_DEFAULTS_LIMIT
  • Default value: 25