refactor: Update setup scripts and documentation#153
refactor: Update setup scripts and documentation#153skywinder wants to merge 4 commits intoUshadow-io:devfrom
Conversation
- Replaced references to `quick-start.sh` with `go.sh` and `dev.sh` for clarity in setup instructions. - Updated README and setup documentation to reflect new script usage for environment setup and service startup. - Adjusted docker-compose instructions to align with the new script structure.
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 26807594 | Triggered | Username Password | 6ef6531 | setup/run.py | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secret safely. Learn here the best practices.
- Revoke and rotate this secret.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
- Added section for starting infrastructure only using `make infra-up`. - Clarified use cases for running the ushadow app separately and managing infrastructure services. - Provided concise commands for starting and stopping infrastructure.
|
@thestumonkey one more pr to review |
quick-start.shwithgo.shanddev.shfor clarity in setup instructions.