1---
2last_modified_on: "2020-07-13"
3title: Install Vector via Homebrew
4sidebar_label: Homebrew
5description: Install Vector through the Homebrew package manager
6---
7
8import ConfigExample from '@site/src/components/ConfigExample';
9import DaemonDiagram from '@site/src/components/DaemonDiagram';
10import Jump from '@site/src/components/Jump';
11import Steps from '@site/src/components/Steps';
12import Tabs from '@theme/Tabs';
13import TabItem from '@theme/TabItem';
14
15Vector can be installed through [Homebrew][urls.homebrew] which is generally
16used on MacOS systems.
17
18<!--
19     THIS FILE IS AUTOGENERATED!
20
21     To make changes please edit the template located at:
22
23     website/docs/setup/installation/package-managers/homebrew.md.erb
24-->
25
26## Install
27
28<Tabs
29  block={true}
30  defaultValue="daemon"
31  values={[{"label":"As a Daemon","value":"daemon"}]}>
32<TabItem value="daemon">
33
34The [daemon deployment strategy][docs.strategies#daemon] is designed for data
35collection on a single host. Vector runs in the background, in its own process,
36collecting _all_ data for that host.
37Typically data is collected from a process manager, such as Journald via
38Vector's [`journald` source][docs.sources.journald], but can be collected
39through any of Vector's [sources][docs.sources].
40The following diagram demonstrates how it works.
41
42<DaemonDiagram
43  platformName={null}
44  sourceName={null}
45  sinkName={null} />
46
47---
48
49<Tabs
50  centered={true}
51  className={"rounded"}
52  defaultValue={"homebrew"}
53  placeholder="Please choose an installation method..."
54  select={false}
55  size={null}
56  values={[{"group":"Package managers","label":"Homebrew","value":"homebrew"}]}>
57<TabItem value="homebrew">
58
59<Steps headingDepth={3}>
60<ol>
61<li>
62
63### Add the Timber tap and install `vector`
64
65```bash
66brew tap timberio/brew && brew install vector
67```
68
69[Looking for a specific version?][docs.package_managers.homebrew]
70
71</li>
72<li>
73
74### Configure Vector
75
76<ConfigExample
77  format="toml"
78  path={"/etc/vector/vector.toml"}
79  sourceName={"file"}
80  sinkName={null} />
81
82</li>
83<li>
84
85### Start Vector
86
87```bash
88brew services start vector
89```
90
91</li>
92</ol>
93</Steps>
94
95</TabItem>
96</Tabs>
97</TabItem>
98</Tabs>
99
100## Configuring
101
102The Vector configuration file is placed in:
103
104```text
105/usr/local/etc/vector/vector.toml
106```
107
108A full spec is located at `/usr/local/etc/vector/vector.spec.toml` and examples
109are located in `/usr/local/etc/vector/examples/*`. You can learn more about
110configuring Vector in the [Configuration][docs.configuration] section.
111
112## Deploying
113
114How you deploy Vector is largely dependent on your use case and environment.
115Please see the [deployment section][docs.deployment] for more info on how to
116deploy Vector.
117
118## Administering
119
120Vector can be managed through the [Homebrew services][urls.homebrew_services]
121manager:
122
123<Jump to="/docs/administration">Administration</Jump>
124
125## Uninstalling
126
127```bash
128brew remove vector
129```
130
131## Updating
132
133```bash
134brew update && brew upgrade vector
135```
136
137## Package
138
139### Architectures
140
141Vector's Homebrew packages only support the X86_64 arhcitecture.
142
143### Versions
144
145Historical Vector versions can be found in the [releases][urls.vector_releases].
146Once you've found the version you'd like to install you can specify it with:
147
148```bash
149brew install vector@X.X.X
150```
151
152Due to limitations of Homebrew, Vector cannot pin specific major or minor
153versions. If this is a requirement, then we recommend installing Vector
154directly [from an archive][docs.manual.from-archives].
155
156### Source Files
157
158Vector's Homebrew source files are located in
159[Vector's brew repo][urls.vector_homebrew_source_files].
160
161[docs.configuration]: /docs/setup/configuration/
162[docs.deployment]: /docs/setup/deployment/
163[docs.manual.from-archives]: /docs/setup/installation/manual/from-archives/
164[docs.package_managers.homebrew]: /docs/setup/installation/package-managers/homebrew/
165[docs.sources.journald]: /docs/reference/sources/journald/
166[docs.sources]: /docs/reference/sources/
167[docs.strategies#daemon]: /docs/setup/deployment/strategies/#daemon
168[urls.homebrew]: https://brew.sh/
169[urls.homebrew_services]: https://github.com/Homebrew/homebrew-services
170[urls.vector_homebrew_source_files]: https://github.com/timberio/homebrew-brew/blob/master/Formula/vector.rb
171[urls.vector_releases]: https://vector.dev/releases/latest/
172