Comments (2)
I agree.
I added a sample link and update the README with the instructions on how to use the models in the container.
from credential-digger.
Hi @marcorosa, I would advise to put all that is needed right in the section https://github.com/SAP/credential-digger#install
I would expect that when I run the steps in that section I end up with a fully functional instance (which is not the case, because I get no rules).
Overall, I would suggest to provide a very simple path from zero to a fully working instance of the tool in one clear set of steps. Optional or alternative ways should be identified as such and documented separately. Right now the readme provides too much information and alternatives, but not the single one-stop-shop for the curious newcomer and prospective adopter.
EDIT: also the section https://github.com/SAP/credential-digger#architecture should be moved down in the readm, or to a separate file altogether (better): that breaks the flow from the high-level description of what the tool does to how to actually try it; the question about how it is architected come later and only for a limited class of users.
from credential-digger.
Related Issues (20)
- Show credential digger version in UI
- Update the the total discoveries counter with the real number of issues
- broken scans shown as completed in the UI
- broken hyperscan dependency HOT 3
- Scan local repo without remote causes the scan to break
- Scan is slow when copying local repo
- Pull request scan trigger hook HOT 3
- update psycopg HOT 1
- postgres add_discoveries broken for NUL characters
- Macbook M1|2|3 support HOT 3
- scan single commit
- Error, blank web page HOT 1
- Unable to authorize privite Github repositories HOT 3
- Error while installing on brand new KALI linux VM HOT 5
- Enabling HTTPS on UI HOT 2
- Cred digger CLI base scan is not showing on UI
- ui/server.py breaks while performing the scan
- Update python versions support HOT 1
- [similarity] use a vector db for embeddings HOT 1
- add model to scan all repository under one github organization HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from credential-digger.