--- title: Charmhub | Deploy Graylog using Charmhub - The Open Operator Collection description: Deploy the latest version of Graylog on any cloud. url: https://charmhub.io/graylog/configurations --- # Graylog [Llama (LMA) Charmers](https://charmhub.io/publisher/llama-charmers "View all packages from Llama (LMA) Charmers") * [Llama (LMA) Charmers](https://charmhub.io/publisher/llama-charmers "View all packages from Llama (LMA) Charmers") Platform: 22.04 20.04 18.04 16.04 stable 23.10 ``` juju deploy graylog ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) * [beats\_port](https://charmhub.io/graylog/configurations#beats_port) * [channel](https://charmhub.io/graylog/configurations#channel) * [elasticsearch\_cluster\_name](https://charmhub.io/graylog/configurations#elasticsearch_cluster_name) * [email\_auth\_password](https://charmhub.io/graylog/configurations#email_auth_password) * [email\_auth\_username](https://charmhub.io/graylog/configurations#email_auth_username) * [email\_enabled](https://charmhub.io/graylog/configurations#email_enabled) * [email\_from](https://charmhub.io/graylog/configurations#email_from) * [email\_hostname](https://charmhub.io/graylog/configurations#email_hostname) * [email\_port](https://charmhub.io/graylog/configurations#email_port) * [email\_ssl\_enabled](https://charmhub.io/graylog/configurations#email_ssl_enabled) * [email\_subject\_prefix](https://charmhub.io/graylog/configurations#email_subject_prefix) * [email\_tls\_enabled](https://charmhub.io/graylog/configurations#email_tls_enabled) * [email\_use\_auth](https://charmhub.io/graylog/configurations#email_use_auth) * [email\_web\_url](https://charmhub.io/graylog/configurations#email_web_url) * [gelf\_port](https://charmhub.io/graylog/configurations#gelf_port) * [index\_replicas](https://charmhub.io/graylog/configurations#index_replicas) * [index\_retention\_count](https://charmhub.io/graylog/configurations#index_retention_count) * [index\_rotation\_msg\_count](https://charmhub.io/graylog/configurations#index_rotation_msg_count) * [index\_rotation\_period](https://charmhub.io/graylog/configurations#index_rotation_period) * [index\_rotation\_size](https://charmhub.io/graylog/configurations#index_rotation_size) * [index\_rotation\_strategy](https://charmhub.io/graylog/configurations#index_rotation_strategy) * [index\_shards](https://charmhub.io/graylog/configurations#index_shards) * [jvm\_heap\_size](https://charmhub.io/graylog/configurations#jvm_heap_size) * [ldap\_auth](https://charmhub.io/graylog/configurations#ldap_auth) * [ldap\_default\_graylog\_roles](https://charmhub.io/graylog/configurations#ldap_default_graylog_roles) * [ldap\_password](https://charmhub.io/graylog/configurations#ldap_password) * [ldap\_server\_ip](https://charmhub.io/graylog/configurations#ldap_server_ip) * [ldap\_server\_port](https://charmhub.io/graylog/configurations#ldap_server_port) * [ldap\_tls\_verify\_certificates](https://charmhub.io/graylog/configurations#ldap_tls_verify_certificates) * [ldap\_use\_tls](https://charmhub.io/graylog/configurations#ldap_use_tls) * [ldap\_user](https://charmhub.io/graylog/configurations#ldap_user) * [ldap\_user\_full\_name\_attribute](https://charmhub.io/graylog/configurations#ldap_user_full_name_attribute) * [ldap\_user\_name\_attribute](https://charmhub.io/graylog/configurations#ldap_user_name_attribute) * [ldap\_user\_search\_base](https://charmhub.io/graylog/configurations#ldap_user_search_base) * [ldap\_user\_search\_pattern](https://charmhub.io/graylog/configurations#ldap_user_search_pattern) * [ldap\_user\_unique\_id\_attribute](https://charmhub.io/graylog/configurations#ldap_user_unique_id_attribute) * [log\_inputs](https://charmhub.io/graylog/configurations#log_inputs) * [max\_check\_attempts](https://charmhub.io/graylog/configurations#max_check_attempts) * [nagios\_context](https://charmhub.io/graylog/configurations#nagios_context) * [nagios\_servicegroups](https://charmhub.io/graylog/configurations#nagios_servicegroups) * [nagios\_uncommitted\_crit](https://charmhub.io/graylog/configurations#nagios_uncommitted_crit) * [nagios\_uncommitted\_warn](https://charmhub.io/graylog/configurations#nagios_uncommitted_warn) * [rest\_transport\_uri](https://charmhub.io/graylog/configurations#rest_transport_uri) * [site\_name](https://charmhub.io/graylog/configurations#site_name) * [snapd\_refresh](https://charmhub.io/graylog/configurations#snapd_refresh) * [web\_endpoint\_uri](https://charmhub.io/graylog/configurations#web_endpoint_uri) * [web\_listen\_uri](https://charmhub.io/graylog/configurations#web_listen_uri) [Learn about configurations >](https://juju.is/docs/juju/configuration#heading--application-configuration) * beats\_port | int Default: 5044 TCP port for Beats input when relation is joined * channel | string Default: 3/stable Snap channel used to install/refresh the graylog snap. This option has no effect when a valid graylog.snap resource is attached. * elasticsearch\_cluster\_name | string If the elastic search cluster name is not passed in the relation set it here. * email\_auth\_password | string Set smtp password * email\_auth\_username | string Set smtp username * email\_enabled | boolean Email config enabled * email\_from | string Default: graylog@example.com Email config settings * email\_hostname | string Default: mail.example.com Email hostname settings * email\_port | int Default: 587 Email port settings * email\_ssl\_enabled | boolean Enable SMTP over SSL (SMTPS) for encrypted connections * email\_subject\_prefix | string Default: [graylog] Tag email header with "graylog" * email\_tls\_enabled | boolean Enable SMTP with STARTTLS for encrypted connections * email\_use\_auth | boolean Email auth enabled * email\_web\_url | string Default: https://graylog.example.com Specify this to include links to the stream in your stream alert mails. This should define the fully qualified base url to your web interface exactly the same way as it is accessed by your users. * gelf\_port | int Default: 12201 TCP port for GELF input when relation is joined * index\_replicas | int Number of Elasticsearch replicas used per index in this index set. * index\_retention\_count | int Default: 6 Maximum number of indices to keep before deleting the oldest ones * index\_rotation\_msg\_count | int Default: 20000000 When rotation strategy is "msg\_count", maximum number of documents in an index before it gets rotated * index\_rotation\_period | string Default: P7D When rotation strategy is "time" based, rotation period (ISO8601 Duration) - How long an index gets written to before it is rotated. * index\_rotation\_size | int Default: 1073741824 When rotation strategy is "size" based, maximum size of an index before it gets rotated. Defaults to 1073741824 (1GB). * index\_rotation\_strategy | string Default: time Type of rotation strategy ("time" based, "size" based, no. messages "msg\_count"). * index\_shards | int Default: 2 Number of Elasticsearch shards used per index in this index set. Set this to '0' to let the charm automatically calculate based on how many Elasticsearch units. * jvm\_heap\_size | string Default: 1G JVM Heap memory size (default 1G). Unit can be K/M/G here. When unit ommited, it will be Bytes. JVM Heap size should be smaller than machine total memory. * ldap\_auth | boolean Whether to enable LDAP authentication, defaults to False. * ldap\_default\_graylog\_roles | string Default: Reader Comma separated list of roles that new users from the LDAP authentication backend should be granted upon first login to graylog. * ldap\_password | string Password to use to bind to the LDAP authentication backend * ldap\_server\_ip | string LDAP server IP for Graylog LDAP authentication backend. * ldap\_server\_port | string Default: 636 LDAP port to communicate to LDAP authentication backend * ldap\_tls\_verify\_certificates | boolean Default: True Enable certificate verification for LDAPS * ldap\_use\_tls | boolean Default: True Specify if LDAP authentication backend should use TLS * ldap\_user | string Username (Distinguished Name) used to bind to LDAP identity server. Example - cn=admin,dc=example,dc=com * ldap\_user\_full\_name\_attribute | string Default: fullName The attribute in LDAP records that defines the full name of the user. * ldap\_user\_name\_attribute | string Default: uid This attribute should be the login name of the user and will substitute in place of {0} in the user search pattern above. * ldap\_user\_search\_base | string User search base DN - Example - ou=users,dc=example,dc=com * ldap\_user\_search\_pattern | string Default: (&(uid={0})(class=inetOrgPerson)) Define how to match a valid user record under the user search base when provided with the username attempting to login. The string {0} will be replaced by the entered username. Deeper examples may include being a member of a specific group such as (&(&(uid={0})(class=inetOrgPerson))(memberOf=cn=graylog\_users,ou=groups,dc=example,dc=com)) * ldap\_user\_unique\_id\_attribute | string Default: cn The attribute that uniquely identifies a user in the LDAP database. * log\_inputs | string YAML-formatted list of log inputs. First input gets passed through relations. Any input not defined here will be removed unless it is prefixed with "Custom" in the title. * max\_check\_attempts | string The maxiumum number of attempts to check the via nrpe a service before switching an alert to HARD status rather than SOFT. Default for Nagios is 4, if this is set, the default will be overwritten for the Graylog Health check only. * nagios\_context | string Default: juju Used by the nrpe-external-master subordinate charm. A string that will be prepended to instance name to set the host name in nagios. So for instance the hostname would be something like: juju-myservice-0 If you're running multiple environments with the same services in them this allows you to differentiate between them. * nagios\_servicegroups | string A comma-separated list of nagios servicegroups. If left empty, the nagios\_context will be used as the servicegroup. * nagios\_uncommitted\_crit | int Default: 2048 Number of journaled uncommitted messages that will generate a nagios CRITICAL alert * nagios\_uncommitted\_warn | int Default: 1024 Number of journaled uncommitted messages that will generate a nagios WARN * rest\_transport\_uri | string Default: http://0.0.0.0:9001/api/ This setting is only required when external access to the Graylog nodes is required to pass through a proxy/load balancer. This address is used by the Web Interface to access the REST API. For Graylog 2, the proxy should connect back to the Graylog node on port 9001 (the default). For Graylog 3, this setting is ignored. `web_endpoint_uri` is used as the universal proxy setting. + If the ip address 0.0.0.0 is specified, the charm will attempt to deduct the network interface that is used for connections to the default gateway and use the associated ip address. * site\_name | string An unique site name for Graylog deployment * snapd\_refresh | string How often snapd handles updates for installed snaps. The default (an empty string) is 4x per day. Set to "max" to check once per month based on the charm deployment date. You may also set a custom string as described in the 'refresh.timer' section here: https://forum.snapcraft.io/t/system-options/87 * web\_endpoint\_uri | string This setting is only required when external access to the Graylog nodes is required to pass through a proxy/load balancer. This address is used by the Web Interface to download secondary assets (JavaScript/CSS/etc). This setting should be the public address of the proxy, which will direct traffic to Graylog. For Graylog 2, the proxy should connect back to the address set in 'web\_listen\_uri' \*. The 'web\_listen\_uri' will be used as the default value if this config is left blank. For Graylog 3, the proxy should connect back to the Graylog node on port 9000 (the default). If this config is left blank, the charm will attempt to determine the correct network interfance \*. + If the ip address 0.0.0.0 is specified, the charm will attempt to deduct the network interface that is used for connections to the default gateway and use the associated ip address. * web\_listen\_uri | string Default: http://0.0.0.0:9000/ For Graylog 2, this URI specifies which IP and port Graylog will LISTEN to for the Web Interface. For Graylog 3, this setting is ignored. The Web Interface and REST API listen on the same IP and port.