Skip to content
LogScale Self-Hosted Deployment
This is an archived version of the documentation downloaded from LogScale Documentation Archives. Up to date documentation, and documentation for later versions, is available on LogScale Documentation

## Basic Configuration

LogScale's basic functionality is configured through environment variables that must be consistently set across all nodes in a deployment, requiring restarts when changes are made. The configuration options cover essential settings including backup management, Kafka integration, storage configurations, authentication parameters, email settings, proxy configurations, and various performance-related parameters that can be customized according to specific deployment needs.

To configure LogScale's basic functionality, environment variables are used to set different configuration values. The example configuration file below contains the LogScale environment variables that might typically need to be included. The configuration file should be the same on each node.

### Important

Changes made to the configuration files must be made on all nodes, and each node will need to be restarted for the changes to take effect.

The LogScale Launcher Script script sets appropriate defaults according to the infrastructure (CPU count, or RAM availability).

ini

    BACKUP_NAME=my-backup-name
    BACKUP_DIR="/backup"
    BACKUP_KEY=my-secret-key-used-for-encryption
    DELETE_BACKUP_AFTER_MILLIS=604800000

    BOOTSTRAP_HOST_ID=1
    # BOOTSTRAP_HOST_UUID_COOKIE

    EXTERNAL_URL=https://humio01.example.com
    PUBLIC_URL=https://humio.mycompany.com

    IDLE_POLL_TIME_BEFORE_DASHBOARD_QUERY_IS_CANCELLED_MINUTES=4320
    WARN_ON_INGEST_DELAY_MILLIS=30000
    INGEST_QUEUE_REPLICATION_FACTOR=2

    KAFKA_SERVERS=kafkahost01:9092,kafkahost02:9092
    KAFKA_MANAGED_BY_HUMIO=true
    DELETE_ON_INGEST_QUEUE=true
    EXTRA_KAFKA_CONFIGS_FILE=extra_kafka_properties.properties
    HUMIO_KAFKA_TOPIC_PREFIX=

    MAX_HOURS_SEGMENT_OPEN=24
    FLUSH_BLOCK_SECONDS=1800
    NODE_ROLES=all
    #ENABLE_QUERY_LOAD_BALANCING=true
    #SHUTDOWN_ABORT_FLUSH_TIMEOUT_MILLIS=300000

    # GC_KILL_THRESHOLD_MILLIS=60000

    POSTMARK_SERVER_SECRET=abc2454232
    POSTMARK_FROM=LogScale <humio@example.com>

    #SMTP_HOST=smtp.gmail.com
    #SMTP_PORT=587
    #SMTP_SENDER_ADDRESS=you@domain.com
    #SMTP_USE_STARTTLS=true
    #SMTP_USERNAME=you@domain.com
    #SMTP_PASSWORD=your-secret-password

    SMTP_HOST=localhost
    SMTP_PORT=25
    SMTP_SENDER_ADDRESS=you@domain.com
    SMTP_USE_STARTTLS=false

    HTTP_PROXY_HOST=proxy.myorganisation.com
    HTTP_PROXY_PORT=3129
    HTTP_PROXY_USERNAME=you
    HTTP_PROXY_PASSWORD=your-secret-password

    # HTTP_PROXY_ALLOW_NOTIFIERS_NOT_USE=true
    # IP_FILTER_NOTIFIERS=allow 192.168.0.16

    HUMIO_PORT=8080
    ELASTIC_PORT=9200
    PROMETHEUS_METRICS_PORT=8081
    HUMIO_SOCKET_BIND=0.0.0.0

    HUMIO_HTTP_BIND=0.0.0.0

    S3_ARCHIVING_ACCESSKEY=$ACCESS_KEY
    S3_ARCHIVING_SECRETKEY=$SECRET_KEY
    # S3_ARCHIVING_ENDPOINT_BASE=http://my-own-s3:8080
    S3_ARCHIVING_WORKERCOUNT=1

    # S3_ARCHIVING_USE_HTTP_PROXY=false

    S3_STORAGE_ACCESSKEY=$ACCESS_KEY
    S3_STORAGE_SECRETKEY=$SECRET_KEY

    # AWS_ACCESS_KEY_ID=$ACCESS_KEY
    # AWS_SECRET_ACCESS_KEY=$SECRET_KEY

    S3_STORAGE_ENDPOINT_BASE=http://my-own-s3:8080
    S3_STORAGE_BUCKET=$BUCKET_NAME
    S3_STORAGE_REGION=$BUCKET_REGION
    S3_STORAGE_ENCRYPTION_KEY=$ENCRYPTION_SECRET
    # S3_STORAGE_OBJECT_KEY_PREFIX=/basefolder

    # S3_STORAGE_USE_HTTP_PROXY=false

    S3_STORAGE_CONCURRENCY=vcores/2

    # USING_EPHEMERAL_DISKS=false
    LOCAL_STORAGE_PERCENTAGE=80
    LOCAL_STORAGE_MIN_AGE_DAYS=0

    # SHARED_DASHBOARDS_ENABLED=false

    AUTO_CREATE_USER_ON_SUCCESSFUL_LOGIN=false
    AUTO_UPDATE_GROUP_MEMBERSHIPS_ON_SUCCESSFUL_LOGIN=false
    ONLY_CREATE_USER_IF_SYNCED_GROUPS_HAVE_ACCESS=false

    DEFAULT_GROUPS=group1, group2
    # ENABLE_PERSONAL_API_TOKENS = true
    MAX_INGEST_DELAY_SECONDS=3600

    # LIVEQUERY_CANCEL_TRIGGER_DELAY_MS=60000
    # LIVEQUERY_CANCEL_COST_PERCENTAGE=10

    MAX_SERIES_LIMIT=50
    MAX_SERIES_MEMLIMIT=1KiB
    MAX_FILEUPLOAD_SIZE=104857600
    MAX_BUCKET_POINTS=10000

    SECONDARY_DATA_DIRECTORY=/secondaryMountPoint/humio-data2
    PRIMARY_STORAGE_PERCENTAGE=80
    PRIMARY_STORAGE_MAX_FILL_PERCENTAGE=95
    SECODARY_STORAGE_MAX_FILL_PERCENTAGE=95
    CACHE_STORAGE_DIRECTORY=/humio-cache
    CACHE_STORAGE_PERCENTAGE=90

    DUMP_THREADS_SECONDS=10
    STREAMING_QUERY_KEEPALIVE_NEWLINES=false
    STREAMING_QUERY_KEEPALIVE_NEWLINES_ON_NODES=false
    STREAMING_QUERY_KEEPALIVE_TIMEOUT=10
    MAX_CHARS_TO_FIND_TIMESTAMP=128

    AUTO_UPDATE_IP_LOCATION_DB=true

    MAXMIND_ACCOUNT_ID=your-account-id
    MAXMIND_LICENSE_KEY=your-license-key
    MAXMIND_EDITION_ID=GeoLite2-City
    MAXMIND_BASE_URL=http://my-maxmind-proxy.local

    #ZONE=dc1

    MAX_NUMBER_OF_GLOBALDATA_DUMPS_TO_KEEP=20
    ENABLE_ALERTS=true
    ALERT_MAX_THROTTLE_FIELD_VALUES_STORED=100

    ALERT_DESPITE_WARNINGS=false

#### Enter search term