This guide describes the recommended way to install Graylog on Debian Linux 10 (Buster), 11 (Bullseye), and 12 (Bookworm). All links and packages are present at the time of writing.
Prerequisites
Graylog 6.0 requires the following to maintain compatibility with its software dependencies:
| Graylog Version | Minimum MongoDB Version | Maximum MongoDB Version | Minimum OpenSearch Version | Maximum OpenSearch Version |
|---|---|---|---|---|
|
6.0.x |
5.0.7 |
7.x |
1.1.x (or 1.3.x for Graylog Security) |
2.15.x |
Additionally, we recommend you review the version notes specific to your preferred version of Graylog for guidance on installing and configuring your Graylog instance.
Server Timezone
To set a specific time zone on the Graylog server, you can use the following command. (For more information on setting a time zone, we recommend this blog post.)
sudo timedatectl set-timezone UTCMongoDB
To install MongoDB on Debian, the official MongoDB documentation provides the most updated version and is the recommended way of installing MongoDB.
Follow the steps below to install MongoDB on Debian:
1. Install the cryptographic libraries required for the repository keys.
sudo apt-get install gnupg2. Import the key.
wget -qO - https://www.mongodb.org/static/pgp/server-6.0.asc | sudo apt-key add -3. Add the Debian repo to the APT list.
For Debian 10:
echo "deb http://repo.mongodb.org/apt/debian buster/mongodb-org/6.0 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.listFor Debian 11:
echo "deb http://repo.mongodb.org/apt/debian bullseye/mongodb-org/6.0 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.listFor Debian 12:
echo "deb http://repo.mongodb.org/apt/debian bookworm/mongodb-org/6.0 main" | sudo tee /etc/apt/sources.list.d/mongodb-org-6.0.list4. Update repository package.
sudo apt-get update5. Install the latest stable version of MongoDB.
sudo apt-get install -y mongodb-org6. Enable MongoDB during the operating system’s start up.
sudo systemctl daemon-reload
sudo systemctl enable mongod.service
sudo systemctl restart mongod.service
sudo systemctl --type=service --state=active | grep mongod7. Hold the currently installed version of the MongoDB package to prevent it from being automatically upgraded to a newer version when updates are installed.
sudo apt-mark hold mongodb-orgWhen you want to upgrade the package, be sure to remove the hold:
sudo apt-mark unhold <package-name>In the above code line, replace <package-name> with the correct package name.
OpenSearch
The recommended method of installation is to follow the user documentation provided by the OpenSearch service.
1. Install the necessary packages.
sudo apt-get update && sudo apt-get -y install lsb-release ca-certificates curl gnupg22. Import the public GPG key. This key is used to verify that the APT repository is signed.
curl -o- https://artifacts.opensearch.org/publickeys/opensearch.pgp | sudo gpg --dearmor --batch --yes -o /usr/share/keyrings/opensearch-keyring3. Create an APT repository for OpenSearch.
echo "deb [signed-by=/usr/share/keyrings/opensearch-keyring] https://artifacts.opensearch.org/releases/bundle/opensearch/2.x/apt stable main" | sudo tee /etc/apt/sources.list.d/opensearch-2.x.list4. Verify that the repository was created successfully.
sudo apt-get update5. With the repository information added, list all available versions of OpenSearch:
sudo apt list -a opensearch6. Choose the version of OpenSearch you want to install. Unless otherwise indicated, the latest available version of OpenSearch is installed.
OPENSEARCH_INITIAL_ADMIN_PASSWORD environment variable when installing. The password must be a minimum of eight characters with at least one uppercase letter, one lowercase letter, one number, and one special character.sudo OPENSEARCH_INITIAL_ADMIN_PASSWORD=$(tr -dc A-Z-a-z-0-9_@#%^-_=+ < /dev/urandom | head -c${1:-32}) apt-get -y install opensearch
To install a specific version of OpenSearch, specify the version manually using opensearch=<version>.
sudo OPENSEARCH_INITIAL_ADMIN_PASSWORD=$(tr -dc A-Z-a-z-0-9_@#%^-_=+ < /dev/urandom | head -c${1:-32}) apt-get -y install opensearch=2.12.07. Hold the currently installed version of the OpenSearch package to prevent it from being automatically upgraded to a newer version when updates are installed.
sudo apt-mark hold opensearchWhen you want to upgrade the package, be sure to remove the hold:
sudo apt-mark unhold <package-name>In the above code line, replace <package-name> with the correct package name.
Graylog Configuration for OpenSearch
1. Begin by opening the yml file.
sudo nano /etc/opensearch/opensearch.yml2. Update the following fields for a minimum unsecured running state (single node).
cluster.name: graylog
node.name: ${HOSTNAME}
path.data: /var/lib/opensearch
path.logs: /var/log/opensearch
discovery.type: single-node
network.host: 0.0.0.0
action.auto_create_index: false
plugins.security.disabled: true3. Enable JVM options.
sudo nano /etc/opensearch/jvm.options4. Now, update the Xms and Xmx settings with half of the installed system memory, like shown in the example below.
## JVM configuration
################################################################
## IMPORTANT: JVM heap size
################################################################
##
## You should always set the min and max JVM heap
## size to the same value. For example, to set
## the heap to 4 GB, set:
##
## -Xms4g
## -Xmx4g
##
## See https://opensearch.org/docs/opensearch/install/important-settings/
## for more information
##
################################################################
# Xms represents the initial size of total heap space
# Xmx represents the maximum size of total heap space
-Xms1g
-Xmx1g5. Configure the kernel parameters at runtime.
sudo sysctl -w vm.max_map_count=262144
sudo echo 'vm.max_map_count=262144' >> /etc/sysctl.conf6. Finally, enable the system service.
sudo systemctl daemon-reload
sudo systemctl enable opensearch.service
sudo systemctl start opensearch.serviceGraylog
1. Install the Graylog repository configuration and Graylog Open itself with the following commands.
wget https://packages.graylog2.org/repo/packages/graylog-6.0-repository_latest.deb
sudo dpkg -i graylog-6.0-repository_latest.deb
sudo apt-get update
sudo apt-get install graylog-server If you are installing Graylog Enterprise, then you will use the following commands.
wget https://packages.graylog2.org/repo/packages/graylog-6.0-repository_latest.deb
sudo dpkg -i graylog-6.0-repository_latest.deb
sudo apt-get update
sudo apt-get install graylog-enterprise2. Mark the package on-hold so that package updates do not accidentally upgrade the Graylog server.
For Graylog Open:
sudo apt-mark hold graylog-serverFor Graylog Enterprise:
sudo apt-mark hold graylog-enterpriseWhen you want to upgrade the package, be sure to remove the hold:
sudo apt-mark unhold <package-name>In the above code line, replace <package-name> with the correct package name.
Edit the Graylog Configuration File
1. Begin by opening the Graylog configuration file. Review the configuration file and edit as needed according to your preferences and environment.
sudo nano /etc/graylog/server/server.conf
password_secret and root_password_sha2 values to the configuration file as these are mandatory and Graylog will not start without them.
2. To create your password_secret, run the following command:
< /dev/urandom tr -dc A-Z-a-z-0-9 | head -c${1:-96};echo;3. Use the following command to create your root_password_sha2:
echo -n "Enter Password: " && head -1 </dev/stdin | tr -d '\n' | sha256sum | cut -d" " -f14. To be able to connect to Graylog, set the http_bind_address value in the configuration file to the public host name or a public IP address for the machine to which you can connect. More information about these settings can be found in Configuring the Web Interface. Alternatively, you can also set this configuration using this command:
sudo sed -i 's/#http_bind_address = 127.0.0.1.*/http_bind_address = 0.0.0.0:9000/g' /etc/graylog/server/server.conf
5. Edit the elasticsearch_hosts setting to include a list of comma-separated URIs to one or more valid OpenSearch nodes. A sample specification may look as follows:
elasticsearch_hosts = http://es-node-1.example.org:9200/foo,https://someuser:somepassword@es-node-2.example.org:9200
6. The last step is to enable Graylog during the operating system’s startup:
sudo systemctl daemon-reload
sudo systemctl enable graylog-server.service
sudo systemctl start graylog-server.service
sudo systemctl --type=service --state=active | grep graylogNow you can ingest messages into Graylog!
Getting Started
Now that you have installed Graylog, you can review your initial configuration settings and connect to the web interface!
Cluster Setup
If you plan to have multiple servers assuming different roles in your cluster like we have in this big production setup you need to modify only a few settings. This is covered in our multi-node setup guide. The default file location guide lists the locations of the files you need to modify.
