Skip to content

Commit 8052583

Browse files
authored
Update readme
- installation steps, code formatting
1 parent d48402e commit 8052583

File tree

1 file changed

+28
-29
lines changed

1 file changed

+28
-29
lines changed

README.md

Lines changed: 28 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -37,43 +37,42 @@ There are multiple ways to install Splunk Connect for Docker, Splunk recommends
3737

3838
### Install the Plugin from Docker Store
3939

40-
1. Create the plugin from the package.
41-
42-
$ docker plugin install splunk/docker-logging-plugin --alias splunk-logging-plugin
43-
44-
2. Enable the plugin:
45-
46-
$ docker plugin enable splunk-logging-plugin:latest
47-
40+
1. Pull the plugin from docker hub.
41+
```
42+
$ docker plugin install splunk/docker-logging-plugin --alias splunk-logging-plugin
43+
```
44+
2. Enable the plugin if needed:
45+
```
46+
$ docker plugin enable splunk-logging-plugin:latest
47+
```
4848
### Install the plugin from the tar file
4949

5050
1. Clone the repository and check out release branch
51-
52-
$ git clone https://github.com/splunk/docker-logging-plugin.git
53-
54-
$ git checkout release/2.0.0
55-
51+
```
52+
$ git clone https://github.com/splunk/docker-logging-plugin.git
53+
$ git checkout release/2.0.0
54+
```
5655
2. Create the plugin package
57-
58-
$ cd docker-logging-plugin
59-
$ make package # this creates a splunk-logging-plugin.tar.gz
60-
56+
```
57+
$ cd docker-logging-plugin
58+
$ make package # this creates a splunk-logging-plugin.tar.gz
59+
```
6160
3. unzip the package
62-
63-
$ tar -xzf splunk-logging-plugin.tar.gz
64-
61+
```
62+
$ tar -xzf splunk-logging-plugin.tar.gz
63+
```
6564
4. Create the plugin
66-
67-
$ docker plugin create splunk-logging-plugin:latest splunk-logging-plugin/
68-
65+
```
66+
$ docker plugin create splunk-logging-plugin:latest splunk-logging-plugin/
67+
```
6968
5. Verify that the plugin is installed by running the following command:
70-
71-
$ docker plugin ls
72-
69+
```
70+
$ docker plugin ls
71+
```
7372
6. Enable the plugin
74-
75-
$ docker plugin enable splunk-logging-plugin:latest
76-
73+
```
74+
$ docker plugin enable splunk-logging-plugin:latest
75+
```
7776
## Step 3: Run containers with the plugin installed
7877

7978
Splunk Connect for Docker continually listens for logs, but your containers must also be running so that the container logs are forwarded to Splunk Connect for Docker. The following examples describe how to configure containers to run with Splunk Connect for Docker.

0 commit comments

Comments
 (0)