Skip to content

Commit 9027ea2

Browse files
authored
Merge branch 'master' into develop
2 parents 67b7c2e + fdf78d8 commit 9027ea2

File tree

2 files changed

+27
-4
lines changed

2 files changed

+27
-4
lines changed

CHANGELOG.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,24 @@ This major version release brings multiple updates to GitLab Watchman in usabili
1919

2020
## [2.0.0] - 2022-03-22
2121
### Added:
22-
- Complete rewrite of the codebase to make searching faster and more efficient.
23-
- More modern packaging and distribution.
24-
- Logs now include more data
2522
- New scopes for finding exposed data in:
2623
- notes
2724
- snippets
25+
- Docker image now available from the Docker hub, or by building from source. (Credit [@adioss](https://github.com/adioss) for the inspiration)
26+
- Complete rewrite of the codebase to make searching faster and more efficient.
27+
- More modern packaging and distribution.
28+
- Logs now include more data
2829
- Additional signatures added to find more leaked data
30+
- Updated logo to play nicely with dark mode displays
2931

3032
### Removed:
31-
- Logging to file and TCP stream - logs to stdout like a true 12 factor app. Reroute stdout as you see fit.
33+
34+
- Logging to file and TCP stream - logs to stdout like a true 12 factor app. Reroute stdout as you see fit. --output
3235
- .conf file for configuration options. Pass the environment variables `GITLAB_WATCHMAN_TOKEN` and `GITLAB_WATCHMAN_URL`
3336

37+
**Breaking changes:**
38+
- The --output flag is no longer required, and therefore not supported
39+
3440

3541
## [1.4.0] - 2020-12-24
3642
### Added:

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,23 @@ python3 -m build
117117
python3 -m pip install --force-reinstall dist/*.whl
118118
```
119119

120+
## Docker Image
121+
122+
GitLab Watchman is also available from the Docker hub as a Docker image:
123+
124+
`docker pull papermountain/gitlab-watchman:latest`
125+
126+
You can then run GitLab Watchman in a container, making sure you pass the required environment variables:
127+
128+
```
129+
// help
130+
docker run --rm papermountain/gitlab-watchman -h
131+
132+
// scan all
133+
docker run --rm -e GITLAB_WATCHMAN_TOKEN=abc123 -e GITLAB_WATCHMAN_URL=https://example.gitlab.com papermountain/gitlab-watchman --timeframe a --all
134+
docker run --rm --env-file .env papermountain/gitlab-watchman --timeframe a --all
135+
```
136+
120137
## Usage
121138
GitLab Watchman will be installed as a global command, use as follows:
122139
```

0 commit comments

Comments
 (0)