You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/_dev-guide/chapter_0/section_3.md
+64-10Lines changed: 64 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@ description: >-
9
9
10
10
At present we are not supporting macOS {{ site.product.short_name }} on our [[official repository|gh-syslog-ng]] on GitHub. However, you can install pre-built {{ site.product.short_name }} binaries from various sources or can compile yourself following [[this guide|dev-platform-build-macos#compiling-from-source]].
11
11
12
-
If you want to install {{ site.product.short_name }} on macOS you can use multiple packaga managers e.g. Homebrew
12
+
If you want to install {{ site.product.short_name }} on macOS you can use multiple packaga managers like Homebrew or MacPorts
13
13
14
-
### Homebrew
14
+
### Using Homebrew
15
15
16
16
First, check [[this|dev-platform-build-macos#dependencies]] if you have not got Homebrew installed and pre-configured yet.
17
17
@@ -20,7 +20,7 @@ Homebrew has now different home directories on ARM and X86 systems, also the loc
20
20
**Hint**: you can use `export HOMEBREW_PREFIX=$(brew --prefix)` in your scripts or shell environments to get and reference the actual location of your homewbrew installation
21
21
{: .notice--info}
22
22
23
-
### Checking dependencies
23
+
####Checking dependencies
24
24
25
25
The {{ site.product.short_name }} package on macOS in homebrew is organized into a formula called `syslog-ng`.
26
26
@@ -30,9 +30,9 @@ For checking [[dependencies|dev-platform-build-macos#dependencies]] of it you ca
30
30
brew deps syslog-ng
31
31
```
32
32
33
-
This will list all the required dependencies are needed to run {{ site.product.short_name }}, and homebrew would install automatically as needed.
33
+
This will list all the required dependencies are needed to run {{ site.product.short_name }}, and homebrew would install automatically as needed.
34
34
35
-
### Installation
35
+
####Installation
36
36
37
37
Using homebrew it is simple, use
38
38
@@ -42,7 +42,7 @@ brew install syslog-ng
42
42
43
43
This command line refers to the latest distribution of {{ site.product.short_name }} versions at the time of writing, and usually updated quickly by the homwbrew crew after a new release.
44
44
45
-
### Starting syslog-ng
45
+
####Starting syslog-ng
46
46
47
47
You can start `syslog-ng` many ways in foreground, e.g. in a terminal window
this will give you detailed information of what {{ site.product.short_name }} does.
62
62
63
+
### Using MacPorts
64
+
65
+
First, check [[this|dev-platform-build-macos#dependencies]] if you have not got MacPorts installed and pre-configured yet.
66
+
67
+
The installation location of MacPorts will be referenced as `${MACPORTS_PREFIX}` in this document. If you follow the installation instructions above, it will already be set correctly, regardless of your system.
68
+
**Hint**: you can use `export MACPORTS_PREFIX=/opt/local` in your scripts or shell environments to get and reference the actual location of your MacPorts installation
69
+
{: .notice--info}
70
+
71
+
#### Checking dependencies in MacPorts
72
+
73
+
For checking [[dependencies|dev-platform-build-macos#dependencies]] of it you can use
74
+
75
+
```shell
76
+
port deps syslog-ng-devel
77
+
```
78
+
79
+
**Note**: there is a `syslog-ng` package as well in MacPorts, the one with `-devel` suffix is usually a more fresh version.
80
+
{: .notice--info}
81
+
82
+
This will list all the required dependencies are needed to run {{ site.product.short_name }}, and MacPorts would install automatically as needed.
83
+
84
+
#### Installation via MacPorts
85
+
86
+
Using MacPorts it is simple, use
87
+
88
+
```shell
89
+
port install syslog-ng-devel
90
+
```
91
+
92
+
This command line refers to the latest distribution of {{ site.product.short_name }} versions at the time of writing, and usually updated quickly by the homwbrew crew after a new release.
93
+
94
+
#### Starting syslog-ng which installed from MacPorts
95
+
96
+
You can start `syslog-ng` many ways in foreground, e.g. in a terminal window
97
+
98
+
```shell
99
+
${MACPORTS_PREFIX}/sbin/syslog-ng -F
100
+
```
101
+
102
+
this will start it as a foreground process in the terminal and write only minimal information to the console during its run.
103
+
104
+
To see more details you can specify some debug flags, like
105
+
106
+
```shell
107
+
${MACPORTS_PREFIX}/sbin/syslog-ng -Fdevt
108
+
```
109
+
110
+
this will give you detailed information of what {{ site.product.short_name }} does.
111
+
63
112
### Running {{ site.product.short_name }} as daemon
64
113
114
+
> **Note:**
115
+
>
116
+
> Below examples use `YOUR_INSTALLATION_ROOT` which is depending on the package manager you used to install {{ site.product.short_name }}.
117
+
{: .notice}
118
+
65
119
You can start it manually as a backround daemon
66
120
67
121
```shell
68
-
${HOMEBREW_PREFIX}/sbin/syslog-ng
122
+
YOUR_INSTALLATION_ROOT/sbin/syslog-ng
69
123
```
70
124
71
125
however this is not a persistent state, after a system restart {{ site.product.short_name }} will not start automatically by default.
@@ -93,14 +147,14 @@ You can find several pages about `launchd` and how to add System or User Launch
0 commit comments