Skip to content

docs: restructure binary installation to match VictoriaMetrics Quick Start#1610

Open
jespino wants to merge 4 commits into
masterfrom
binary-install-docs
Open

docs: restructure binary installation to match VictoriaMetrics Quick Start#1610
jespino wants to merge 4 commits into
masterfrom
binary-install-docs

Conversation

@jespino

@jespino jespino commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Replace the brief 'Pre-built binaries' section with the same structure used in the VictoriaMetrics Quick Start: 'Starting VictoriaLogs Single Node from a Binary' with step-by-step systemd service setup, and 'Starting VictoriaLogs Cluster from Binaries' with per-component (vlstorage, vlinsert, vlselect) installation instructions.

This is for bring consistency with the VictoriaMetrics Quick start, and also makes the "setup instructions" more robust for users, in my opinion.

@jespino
jespino requested a review from hagen1778 July 15, 2026 17:13
- [To build VictoriaLogs from source code](https://docs.victoriametrics.com/victorialogs/quickstart/#building-from-source-code)

### Pre-built binaries
### Starting VictoriaLogs Single Node from a Binary {id="pre-built-binaries"}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is overwriting the id intentionally to ensure not breaking links from other documents here.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 issue found across 1 file

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="docs/victorialogs/QuickStart.md">

<violation number="1" location="docs/victorialogs/QuickStart.md:77">
P2: The cluster component systemd units (vlstorage, vlinsert, vlselect) are missing `ProtectHome=yes` that the single-node service includes. This is a security hardening directive that restricts access to `/home`, `/root`, and `/run/user`. Unless there is a specific reason cluster components need home directory access, add `ProtectHome=yes` to all three cluster service units for consistent security posture.</violation>
</file>

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/victorialogs/QuickStart.md
…Start

Replace the brief 'Pre-built binaries' section with the same structure
used in the VictoriaMetrics Quick Start: 'Starting VictoriaLogs Single
Node from a Binary' with step-by-step systemd service setup, and
'Starting VictoriaLogs Cluster from Binaries' with per-component
(vlstorage, vlinsert, vlselect) installation instructions.

Signed-off-by: Jesús Espino <jespinog@gmail.com>
@jespino
jespino force-pushed the binary-install-docs branch from 0ad011b to 7cf121e Compare July 15, 2026 17:27
@jespino
jespino marked this pull request as draft July 15, 2026 17:35
@jespino

jespino commented Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

I'm keeping this in draft until I explicitly go myself through the whole installation process manually.

Signed-off-by: Jesús Espino <jespinog@gmail.com>
@jespino

jespino commented Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

@hagen1778 this is "porting" the manual installation process shape from VictoriaMetrics to here, I tested it, and it works (in the case of the cluster one, you need to run those in different nodes, but that is exactly what is recommended in the text)

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 1 file

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/victorialogs/QuickStart.md Outdated
@jespino
jespino force-pushed the binary-install-docs branch from c5da44d to c6464de Compare July 20, 2026 16:30
@vadimalekseev

Copy link
Copy Markdown
Member

Fully support this PR. See also related PR that simplifies binary downloading using one bash script: #1307

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants