Skip to content

Commit

Permalink
update README, edit actions
Browse files Browse the repository at this point in the history
  • Loading branch information
linuxfight committed Apr 6, 2024
1 parent feb5d77 commit 3c3d3f4
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 22 deletions.
2 changes: 0 additions & 2 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,6 @@ jobs:
- name: Publish Release
id: publish_release
uses: softprops/action-gh-release@v2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
files: |
release.tar.gz
Expand Down
44 changes: 40 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,43 @@
# Simple WoL bot, built on top of teloxide

# Installation
1. Copy systemd service to ```/etc/systemd/system/wol.service```.
2. Replace workdir and path.
3. Create config like ```config.json``` in workdir
4. Enable and start it.
1. Edit systemd service to ```/etc/systemd/system/wol.service```.
2. Create config in workdir.
3. Enable and start it.

# Example ```config.json```
```json
{
"bot_token": "telegram bot token here",
"ip": "192.168.0.X",
"mac": "A1:B2:C3:D4:E5:F6",
"admin_id": 123456789
}
```

You can get bot token from https://t.me/BotFather.

User id from https://t.me/userinfobot.

Get your ip and mac address from pc, that you want to turn on.

# Example systemd service

```unit file (systemd)
[Unit]
Description=Run the Wake-On-Lan (WOL) bot
After=network.target
[Service]
Type=simple
ExecStart=PATH_TO_WTP_BIN
WorkingDirectory=PATH_TO_WORKDIR
Restart=always
RestartSec=5
StandardOutput=syslog
StandardError=syslog
SyslogIdentifier=wol
[Install]
WantedBy=multi-user.target
```
16 changes: 0 additions & 16 deletions wol.service

This file was deleted.

0 comments on commit 3c3d3f4

Please sign in to comment.