Add setup, activation and update instructions to README
This commit is contained in:
22
README.md
22
README.md
@@ -21,6 +21,8 @@ claude
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone http://100.120.125.113:3000/pdm/security-tools.git
|
git clone http://100.120.125.113:3000/pdm/security-tools.git
|
||||||
|
cd security-tools
|
||||||
|
bash setup.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
To clone to a specific path:
|
To clone to a specific path:
|
||||||
@@ -28,3 +30,23 @@ To clone to a specific path:
|
|||||||
```bash
|
```bash
|
||||||
git clone http://100.120.125.113:3000/pdm/security-tools.git /path/to/destination
|
git clone http://100.120.125.113:3000/pdm/security-tools.git /path/to/destination
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Activating on a New VM
|
||||||
|
|
||||||
|
After cloning, run `setup.sh` once. It will:
|
||||||
|
- Ask for your Telegram bot token and chat ID
|
||||||
|
- Register cron jobs to run scans daily at 08:00
|
||||||
|
- Send a test Telegram message confirming the VM is active
|
||||||
|
- Create a `logs/` folder — logs are kept for 60 days then auto-deleted
|
||||||
|
|
||||||
|
## Updating an Existing VM
|
||||||
|
|
||||||
|
When changes are pushed to this repo, update any VM by running:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd ~/security-tools
|
||||||
|
git pull
|
||||||
|
bash setup.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
`setup.sh` is safe to re-run — it skips steps already completed.
|
||||||
|
|||||||
Reference in New Issue
Block a user