From dcd0add40028cf8ed098c337010d5e7d33016f93 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 21 Jun 2023 21:52:30 -0700 Subject: [PATCH] docs/VictoriaLogs/QuickStart.md: add an option to run VictoriaLogs from pre-built binaries --- docs/VictoriaLogs/QuickStart.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/VictoriaLogs/QuickStart.md b/docs/VictoriaLogs/QuickStart.md index a803b303e0..911acbb07f 100644 --- a/docs/VictoriaLogs/QuickStart.md +++ b/docs/VictoriaLogs/QuickStart.md @@ -8,10 +8,37 @@ before you start working with VictoriaLogs. There are the following options exist: +- [To run pre-built binaries](#pre-built-binaries) - [To run Docker image](#docker-image) - [To run in Kubernetes with Helm charts](#helm-charts) - [To build VictoriaLogs from source code](#building-from-source-code) +### Pre-built binaries + +Pre-built binaries for VictoriaLogs are availble at the [releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/) page. +Just download archive for the needed Operating system and architecture, unpack it and run `victoria-logs-prod` from it. + +For example, the following commands download VictoriaLogs archive for Linux/amd64, unpack and run it: + +```bash +curl https://github.com/VictoriaMetrics/VictoriaMetrics/releases/download/v0.1.0-victorialogs/victoria-logs-linux-amd64-v0.1.0-victorialogs.tar.gz +tar xzf victoria-logs-linux-amd64-v0.1.0-victorialogs.tar.gz +./victoria-logs-prod +``` + +VictoriaLogs is ready for [data ingestion](https://docs.victoriametrics.com/VictoriaLogs/data-ingestion/) +and [querying](https://docs.victoriametrics.com/VictoriaLogs/querying/) at the TCP port `9428` now! +It has no any external dependencies, so it may run in various environments without additional setup and configuration. +VictoriaLogs automatically adapts to the available CPU and RAM resources. It also automatically setups and creates +the needed indexes during [data ingestion](https://docs.victoriametrics.com/VictoriaLogs/data-ingestion/). + +See also: + +- [How to configure VictoriaLogs](#how-to-configure-victorialogs) +- [How to ingest logs into VictoriaLogs](https://docs.victoriametrics.com/VictoriaLogs/data-ingestion/) +- [How to query VictoriaLogs](https://docs.victoriametrics.com/VictoriaLogs/querying/) + + ### Docker image You can run VictoriaLogs in a Docker container. It is the easiest way to start using VictoriaLogs.