Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #54

Merged
merged 1 commit into from
Aug 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 5 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,15 @@ A Splunk app for reporting Bitwarden event logs.

Follow the steps in [Bitwarden Splunk SIEM][Bitwarden Splunk SIEM]

## Contributing
# Contributing

This app requires Python 3.8 installed.
Install [Poetry][poetry] if not already installed.
Please refer to [Bitwarden Contributing Docs - Splunk app][contributingdocs].

Activate shell: `poetry shell`

Install dependencies: `poetry install --with dev`

### Local development

- Install docker.
- Run splunk enterprise
`docker run --rm --name splunk -d -p 8001:8000 -p 8089:8089 -e SPLUNK_START_ARGS='--accept-license' -e SPLUNK_PASSWORD='password' splunk/splunk:latest`
- Package and Deploy to splunk:
- `./package.sh`
- `./deploy.sh`
- Access logs:
- `docker exec -u splunk -it splunk bash`
- `tail -f /opt/splunk/var/log/splunk/bitwarden_event_logs_beta.log`
- Access Splunk url in the browser: http://localhost:8001
- Enter credentials, login: `admin`, password: `password`
- Click on the _Apps_ -> _Bitwarden Event Logs_
- Complete the Setup

### Preparing for release
# Preparing for release

Modify the version in the [pyproject.toml](pyproject.toml)

#### Preparing for prod (non-beta) release
## Preparing for prod (non-beta) release

Remove the `_beta` suffix from:

Expand All @@ -48,3 +27,4 @@ Remove the `_beta` suffix from:

[Bitwarden Splunk SIEM]: https://bitwarden.com/help/splunk-siem/
[poetry]: https://python-poetry.org/docs/#installation
[contributingdocs]: https://contributing.bitwarden.com/getting-started/business/splunk-app
4 changes: 2 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ readme = "README.md"
keywords = ["splunk", "bitwarden"]

[tool.poetry.dependencies]
python = ">=3.7.17"
python = ">=3.7.17, <=3.10"
requests = "2.31.0"
splunk-sdk = "2.0.1"
splunktaucclib = { version = "6.2.1", python = "^3.7" }
Expand All @@ -22,7 +22,7 @@ python-dateutil = "2.9.0.post0"
optional = true

[tool.poetry.group.dev.dependencies]
python = ">=3.7"
python = ">=3.7, <=3.10"
python-dotenv = "0.21.1"
types-requests = "2.31.0.6"
splunk-add-on-ucc-framework = { version = "5.46.0", python = "^3.7" }
Expand Down
Loading