mirror of
https://github.com/octoleo/telegram-bot-bash.git
synced 2024-11-30 02:53:52 +00:00
62 lines
3.2 KiB
HTML
62 lines
3.2 KiB
HTML
|
<!DOCTYPE html>
|
||
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
|
||
|
<head>
|
||
|
<meta charset="utf-8" />
|
||
|
<meta name="generator" content="pandoc" />
|
||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
|
||
|
<title>Bashobot Documentation - examples/README.html</title>
|
||
|
<style>
|
||
|
code{white-space: pre-wrap;}
|
||
|
span.smallcaps{font-variant: small-caps;}
|
||
|
span.underline{text-decoration: underline;}
|
||
|
div.column{display: inline-block; vertical-align: top; width: 50%;}
|
||
|
</style>
|
||
|
<!--[if lt IE 9]>
|
||
|
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
|
||
|
<![endif]-->
|
||
|
</head>
|
||
|
<body>
|
||
|
<header id="title-block-header">
|
||
|
<h1 class="title">Bashobot Documentation - examples/README.html</h1>
|
||
|
</header>
|
||
|
<h4><a href="../README.html">Home</a></h4>
|
||
|
<h2>Bashbot examples</h2>
|
||
|
<h3>bashbot multi</h3>
|
||
|
<p>An example wrapper to run multiple instances of bashbot, use <code>./bashbot-multi.sh botname command</code></p>
|
||
|
<h3>bashbot.cron</h3>
|
||
|
<p>An example crontab is provided in <code>examples/bashbot.cron</code>, see <a href="../html/4_expert.html">Expert use</a></p>
|
||
|
<h3>Interactive chats</h3>
|
||
|
<p>Two examples for interactive scripts are provided as <strong>calc.sh</strong> and <strong>question.sh</strong>, see <a href="../html/3_advanced.html">Advanced use</a></p>
|
||
|
<h3>Background scripts</h3>
|
||
|
<p>Background jobs are an easy way to provide sceduled messages or alerts if something happens. <strong>notify.sh</strong> is a simple example on how to send a message every x seonds, e.g. current time.</p>
|
||
|
<p><strong>background-scripts</strong> contains a more useful example on how to start and stop different scripts plus some example background scripts.</p>
|
||
|
<pre><code> mycommands.sh - /run_xxx and /kill-xxx will start any script named run_xxx.sh
|
||
|
|
||
|
run_diskusage.sh - shows disk usage every 100 seconds
|
||
|
run_filename.sh - shown the name of new files in a named dir
|
||
|
run_filecontent.sh - shown the content of new files in a named dir
|
||
|
run_notify.sh - same as notify.sh
|
||
|
</code></pre>
|
||
|
<p><strong>Note:</strong> Output of system commands often contains newlines, each newline results in a telegram message, the function 'send_telegram' in mycommands.sh avoids this by converting each newline to ' mynewlinestartshere ' before output the string.</p>
|
||
|
<h3>System Status</h3>
|
||
|
<p><strong>send-system-status</strong> contains an example for commands showing status of different subsystems. This example is adapted from https://github.com/RG72/telegram-bot-bash to current bashbot commands, but not fully tested. This will show how easy you can convert existing bots.</p>
|
||
|
<pre><code> mycommands.sh - commands to show system status
|
||
|
botacl - controls who can show system status
|
||
|
|
||
|
*Available commands*:
|
||
|
/se *sensors*
|
||
|
/smb *smbstatus*
|
||
|
/free *memory status*
|
||
|
/md *raid status*
|
||
|
/lvm *lvm status*
|
||
|
/lvsd *Datailed lvm status*
|
||
|
/df *disk space*
|
||
|
/ifconfig *ifconfig output*
|
||
|
/smart *sda* _smart status for sda drive_
|
||
|
</code></pre>
|
||
|
<h3>External scripts</h3>
|
||
|
<p><strong>external-use</strong> will contain some examples on how to send messages from external scripts to Telegram chats or users.</p>
|
||
|
<h4>$$VERSION$$ v0.98-pre2-0-ga597303</h4>
|
||
|
</body>
|
||
|
</html>
|