2023-01-30 20:19:53 +01:00
# [`pcmt`](https://git.dotya.ml/mirre-mt/pcmt/)
> Password Compromise Monitoring Tool
2023-04-12 23:50:01 +02:00
[](https://github.com/pre-commit/pre-commit)
2023-04-12 22:49:10 +02:00
[](https://drone.dotya.ml/mirre-mt/pcmt)
2023-04-19 23:08:45 +02:00
[](https://goreportcard.com/report/git.dotya.ml/mirre-mt/pcmt)
[](https://godocs.io/git.dotya.ml/mirre-mt/pcmt)
2023-04-12 22:49:10 +02:00
2023-01-30 20:19:53 +01:00
> :construction: **note:** this project is being developed as a part of my
> [thesis](https://git.dotya.ml/mirre-mt/masters-thesis/) and is currently
> a work in progress. :construction:
2023-04-12 23:23:46 +02:00
< p align = "center" >
< figure align = "center" >
< img
2023-05-13 14:15:55 +02:00
src="https://git.dotya.ml/mirre-mt/pcmt/raw/branch/development/assets/public/img/logo-pcmt.svg"
2023-04-12 23:23:46 +02:00
alt="pcmt Gopher logo"
/>
< figcaption > pcmt Gopher logo based on the Egon Elbre's < a href = "https://github.com/egonelbre/gophers" target = "_blank" > awesome Gopher designs< / a > .< / figcaption >
< / figure >
< / p >
2023-01-30 20:19:53 +01:00
2023-05-20 18:27:32 +02:00
### How to try this out
with [`podman` ](https://podman.io/ ) and [`just` ](https://github.com/casey/just )
installed, run the following:
```sh
# build the image locally using kaniko.
just kaniko
# start postgres.
just dbstart
# make sure to supply real CONNSTRING values for production environment.
podman run --rm -it -e PCMT_DBTYPE=postgres \
-e PCMT_CONNSTRING="host=127.0.0.1 port=5432 sslmode=disable dbname=postgres password=postgres"
-e PCMT_LIVE=False docker.io/immawanderer/pcmt:testbuild \
-config /etc/pcmt/config.dhall
```
2023-05-20 18:31:59 +02:00
#### Custom config
Make sure to check out the Dhall configuration
[schema ](https://git.dotya.ml/mirre-mt/pcmt-config-schema/src/branch/development/schema.dhall )
to see what's possible, or have a look at the [example
config](exampleConfig.dhall).
If you're new to Dhall, its [documentation ](https://docs.dhall-lang.org/ ) page
is a good resource to start at.
2023-01-30 20:19:53 +01:00
### LICENSE
AGPL-3.0-only (see [LICENSE ](LICENSE ) for details).
