octoleo/octokuma
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
Llewellyn van der Merwe 2024-10-26 09:08:11 +02:00
commit 7f8f3e4eca
Signed by: Llewellyn
GPG Key ID: A9201372263741E7
4 changed files with 1014 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
.idea

341
LICENSE Normal file
View File

@ -0,0 +1,341 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.

433
README.md Normal file
View File

@ -0,0 +1,433 @@
<h2><img align="middle" src="https://raw.githubusercontent.com/odb/official-bash-logo/master/assets/Logos/Icons/PNG/64x64.png" >
Octokuma - Easy Monitor and Reboot Lightsail Instances
</h2>
**octokuma** is a script designed to monitor specific Uptime Kuma monitors and automatically reboot corresponding Amazon Lightsail instances if any of them go down. It leverages the `octosail` script to manage the Lightsail instances and can be scheduled to run at regular intervals using systemd timers.
## Table of Contents
- [Features](#features)
- [How It Works](#how-it-works)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Configuration](#configuration)
- [Automatic Configuration](#automatic-configuration)
- [Manual Configuration](#manual-configuration)
- [Running the Script](#running-the-script)
- [Setting Up Systemd Timer](#setting-up-systemd-timer)
- [Create the Service File](#create-the-service-file)
- [Create the Timer File](#create-the-timer-file)
- [Enable and Start the Timer](#enable-and-start-the-timer)
- [Logging](#logging)
- [Troubleshooting](#troubleshooting)
- [Additional Notes](#additional-notes)
- [Running the Script as Current User](#running-the-script-as-current-user)
- [Environment Variables](#environment-variables)
- [Ensuring AWS CLI Access](#ensuring-aws-cli-access)
- [Permissions for octosail Script](#permissions-for-octosail-script)
- [Testing the Setup](#testing-the-setup)
- [Monitoring the Service](#monitoring-the-service)
- [Stopping the Timer](#stopping-the-timer)
- [License](#free-software-license)
## Features
- Monitors specified Uptime Kuma monitors.
- Automatically reboots corresponding Amazon Lightsail instances if a monitor is down.
- Interactive configuration setup using `whiptail`.
- Dependency checks and automatic installation prompts.
- Designed to run as a systemd service for regular monitoring.
- **Runs as the current user** to access user-specific configurations.
- **Logs are stored in `~/.local/log/`** to keep your home directory organized.
## How It Works
1. **Dependency Checks:**
- Ensures that `jq`, `whiptail`, and `octosail` are installed.
- Prompts the user to install any missing dependencies.
2. **Configuration Loading:**
- Reads configuration from a JSON file located in the user's home directory.
- If the configuration file is not found, prompts the user to create it interactively.
3. **Monitoring Logic:**
- Iterates over each monitor specified in the configuration.
- Checks the status of each monitor via Uptime Kuma's API.
- If a monitor is down, uses `octosail` to reboot the associated Lightsail instance.
## Prerequisites
- **AWS CLI:** The script requires the AWS Command Line Interface (CLI) to interact with your AWS account.
- **AWS Credentials:** You need to have your AWS credentials configured. The `octosail` script will help you set this up if not already configured.
- **Dependencies:**
- `jq`: For JSON parsing.
- `whiptail`: For interactive prompts.
- `octosail`: Script to manage Lightsail instances.
## Installation
1. **Download the Script:**
```bash
sudo curl -L "https://git.vdm.dev/api/v1/repos/octoleo/octokuma/raw/src/octokuma" -o /usr/local/bin/octokuma
sudo chmod +x /usr/local/bin/octokuma
```
2. **Ensure Dependencies are Installed:**
The script will check for dependencies and prompt you to install any that are missing when you run it for the first time.
## Configuration
The script uses a JSON configuration file to store settings, including the Uptime Kuma URL and the list of monitors to check.
### Automatic Configuration
When you run the script for the first time, it will check for the configuration file. If not found, it will prompt you to create it interactively using `whiptail`.
**Steps:**
1. **Run the Script:**
```bash
octokuma
```
2. **Follow the Prompts:**
- **Uptime Kuma URL:**
- You will be asked to enter your Uptime Kuma URL.
- **Add Monitors:**
- The script will ask if you want to add a monitor.
- If you select "Yes," you will be prompted to enter the Monitor ID and the corresponding Lightsail Instance Name.
- Repeat the process to add multiple monitors.
- **Save Configuration:**
- Once you have added all monitors, the configuration will be saved to the default path (`$HOME/.config/octokuma/config.json`).
### Manual Configuration
If you prefer to create or edit the configuration file manually, follow these steps:
1. **Create the Configuration Directory:**
```bash
mkdir -p $HOME/.config/octokuma
```
2. **Create the Configuration File:**
```bash
nano $HOME/.config/octokuma/config.json
```
3. **Add the Following Content:**
```json
{
"uptime_kuma_url": "https://your-uptime-kuma-url",
"monitors": [
{
"monitor_id": 24,
"instance_name": "YourInstanceName1"
},
{
"monitor_id": 25,
"instance_name": "YourInstanceName2"
}
]
}
```
- Replace `"https://your-uptime-kuma-url"` with your actual Uptime Kuma URL.
- Replace `monitor_id` and `instance_name` with your actual monitor IDs and corresponding Lightsail instance names.
4. **Save and Close the File:**
Press `Ctrl+O` to save and `Ctrl+X` to exit.
**Note:** You can also specify a custom configuration file path using the `--config` option:
```bash
octokuma --config /path/to/your/config.json
```
## Running the Script
To run the script manually, simply execute:
```bash
octokuma
```
- If you have specified a custom configuration file, use:
```bash
octokuma --config /path/to/your/config.json
```
- Running the script manually allows you to ensure that it functions correctly before automating it with systemd.
## Setting Up Systemd Timer
To run `octokuma` at regular intervals (e.g., every 5 minutes), you can set up a systemd service and timer. We'll configure the service to run as the current user to ensure that the script can access user-specific configurations.
### Create the Service File
Create a file named `octokuma.service` in your user's systemd directory:
```bash
mkdir -p ~/.config/systemd/user
nano ~/.config/systemd/user/octokuma.service
```
Add the following content:
```ini
[Unit]
Description=OctoKuma Monitoring Service
[Service]
Type=oneshot
ExecStart=/usr/local/bin/octokuma
User=%U
Group=%G
Environment="PATH=$HOME/.local/bin:/usr/local/bin:/usr/bin:/bin"
StandardOutput=append:%h/.local/log/octokuma.log
StandardError=append:%h/.local/log/octokuma.log
```
**Explanation:**
- **User and Group:**
- `User=%U` and `Group=%G` ensure that the service runs as the current user and group.
- **Environment:**
- Sets the `PATH` environment variable to include common binary directories. Adjust as needed.
- **StandardOutput and StandardError:**
- Redirects output and errors to a log file at `~/.local/log/octokuma.log`.
- **User Service Directory:**
- By placing the service file in `~/.config/systemd/user/`, we create a user-level systemd service.
### Create the Timer File
Create a file named `octokuma.timer` in the same directory:
```bash
nano ~/.config/systemd/user/octokuma.timer
```
Add the following content:
```ini
[Unit]
Description=Run OctoKuma Monitoring Service every 5 minutes
[Timer]
OnBootSec=1min
OnUnitActiveSec=5min
Unit=octokuma.service
[Install]
WantedBy=timers.target
```
### Enable and Start the Timer
Reload the user systemd daemon to recognize the new unit files:
```bash
systemctl --user daemon-reload
```
Enable and start the timer:
```bash
systemctl --user enable --now octokuma.timer
```
**Note:** If you get an error about `Failed to connect to bus: No such file or directory`, you may need to enable lingering for your user:
```bash
sudo loginctl enable-linger $USER
```
### Verify the Timer
Check the status of the timer:
```bash
systemctl --user list-timers --all | grep octokuma
```
You should see something like:
```
Tue YYYY-MM-DD HH:MM:SS UTC 5min left n/a n/a octokuma.timer octokuma.service
```
## Logging
By configuring the service to run as the current user and redirecting output to a log file in `~/.local/log/`, you can easily monitor the script's activity without cluttering your home directory.
- **Log File Location:** The log file will be located at `~/.local/log/octokuma.log`.
- **Create Log Directory:** Ensure the log directory exists and set appropriate permissions:
```bash
mkdir -p ~/.local/log
```
- **Permissions:** Since the log file is in your home directory, no special permissions are needed.
Reload the user systemd daemon to apply changes:
```bash
systemctl --user daemon-reload
```
## Troubleshooting
- **Dependencies Not Installed:**
If the script reports that `jq`, `whiptail`, or `octosail` are not installed, follow the prompts to install them. You can also install them manually:
```bash
# Install jq
sudo apt-get install -y jq # Debian/Ubuntu
sudo yum install -y jq # CentOS/RHEL
brew install jq # macOS
# Install whiptail
sudo apt-get install -y whiptail # Debian/Ubuntu
sudo yum install -y newt # CentOS/RHEL
brew install newt # macOS
# Install octosail
sudo curl -L "https://git.vdm.dev/api/v1/repos/octoleo/octosail/raw/src/octosail" -o /usr/local/bin/octosail
sudo chmod +x /usr/local/bin/octosail
```
- **Configuration File Issues:**
Ensure that the JSON configuration file is correctly formatted. You can validate the JSON file using `jq`:
```bash
jq '.' /path/to/config.json
```
If there are errors, fix them in the configuration file.
- **Script Not Executing:**
Ensure that the script has execute permissions:
```bash
sudo chmod +x /usr/local/bin/octokuma
```
- **Permissions Issues:**
Since the script runs as your user, ensure that your user has the necessary permissions to:
- Access the AWS CLI and manage Lightsail instances.
- Read and write to the configuration and log files in your home directory.
- **AWS CLI Configuration:**
Ensure that the AWS CLI is installed and configured with the necessary credentials. Run `aws configure` as your user:
```bash
aws configure
```
- **Systemd User Services Not Working:**
Ensure that your system supports user-level systemd services. If you encounter issues, you may need to enable lingering for your user:
```bash
sudo loginctl enable-linger $USER
```
This allows your user-level services to run even when you're not logged in.
## Additional Notes
### Running the Script as Current User
By configuring the systemd service to run as the current user, the script can access user-specific configurations and environments. This approach ensures that:
- The script uses the AWS credentials configured for your user.
- The script reads the configuration file from your home directory.
- There are no permission issues with accessing files in your home directory.
### Environment Variables
Systemd services have a limited environment. To ensure the script has access to the necessary environment variables (like `PATH`), we've added the `Environment` directive in the service file.
```ini
Environment="PATH=$HOME/.local/bin:/usr/local/bin:/usr/bin:/bin"
```
- Adjust the `PATH` as needed based on where your commands are located.
### Ensuring AWS CLI Access
Make sure that your user has the AWS CLI configured in their home directory (`~/.aws/credentials` and `~/.aws/config`).
- Run `aws configure` as your user if you haven't already.
- Verify that you can run AWS CLI commands without issues.
### Permissions for octosail Script
Ensure that the `octosail` script is executable and accessible to your user.
- Install `octosail` in a directory accessible to your user (e.g., `/usr/local/bin`).
- Set the execute permission:
```bash
sudo chmod +x /usr/local/bin/octosail
```
### Testing the Setup
Before relying on the automated systemd timer, test the entire setup manually:
1. **Run `octokuma` Manually:**
```bash
octokuma
```
2. **Check for Errors:**
- Resolve any issues that arise.
- Ensure that the script can access the configuration file and AWS CLI.
3. **Check Logs:**
- If you have set up logging, check the log file (`~/.local/log/octokuma.log`) for any errors or warnings.
### Monitoring the Service
You can check the status of the service and timer using:
```bash
systemctl --user status octokuma.service
systemctl --user status octokuma.timer
```
### Stopping the Timer
If you need to stop the timer, you can disable it:
```bash
systemctl --user disable --now octokuma.timer
```
---
# Free Software License
```txt
@copyright Copyright (C) 2021 Llewellyn van der Merwe. All rights reserved.
@license GNU General Public License version 2; see LICENSE
```
**Disclaimer:** Be cautious when using scripts that can reboot servers. Ensure that you have proper access controls and safeguards in place to prevent unintended actions. Test the script thoroughly in a safe environment before deploying it to production.

239
src/octokuma Executable file
View File

@ -0,0 +1,239 @@
#!/bin/bash
# octokuma - Monitor Uptime Kuma monitors and reboot Lightsail instances if down
# Default configuration file path
DEFAULT_CONFIG="$HOME/.config/octokuma/config.json"
# Path to the octosail script (adjust if necessary)
OCTOSAIL_CMD="/usr/local/bin/octosail"
# Function to display usage
function usage() {
echo "Usage: $0 [--config <config_file_path>]"
echo " --config <config_file_path> Specify the configuration file path."
echo " Default: $DEFAULT_CONFIG"
exit 1
}
# Parse command-line arguments
CONFIG_FILE=""
while [[ "$#" -gt 0 ]]; do
case "$1" in
--config)
CONFIG_FILE="$2"
shift 2
;;
-h|--help)
usage
;;
*)
echo "Unknown parameter: $1"
usage
;;
esac
done
# Set CONFIG_FILE to default if not provided
if [[ -z "$CONFIG_FILE" ]]; then
CONFIG_FILE="$DEFAULT_CONFIG"
fi
# Create config directory if it doesn't exist
CONFIG_DIR=$(dirname "$CONFIG_FILE")
if [[ ! -d "$CONFIG_DIR" ]]; then
mkdir -p "$CONFIG_DIR"
fi
###############################################################################
# Dependency Checks
###############################################################################
# Function to check if a command is installed
function check_command_installed() {
local cmd_name="$1"
local install_instructions="$2"
if ! command -v "$cmd_name" &> /dev/null; then
echo "$cmd_name is required but not installed."
read -p "Do you want to install it now? (y/n): " install_cmd
if [[ "$install_cmd" =~ ^[Yy]$ ]]; then
echo "Installing $cmd_name..."
eval "$install_instructions"
# Check again if the command is installed
if ! command -v "$cmd_name" &> /dev/null; then
echo "Installation failed. Please install $cmd_name manually."
return 1
fi
else
echo "Cannot proceed without $cmd_name installed. Exiting."
return 1
fi
fi
return 0
}
# Check for jq
check_command_installed "jq" "sudo apt-get install -y jq || sudo yum install -y jq || brew install jq" || exit 1
# Check for whiptail
check_command_installed "whiptail" "sudo apt-get install -y whiptail || sudo yum install -y newt || brew install newt" || exit 1
# Check if octosail is installed
if [[ ! -x "$OCTOSAIL_CMD" ]]; then
echo "octosail is not installed."
read -p "Do you want to install it now? (y/n): " install_octosail
if [[ "$install_octosail" =~ ^[Yy]$ ]]; then
echo "Installing octosail..."
sudo curl -L "https://git.vdm.dev/api/v1/repos/octoleo/octosail/raw/src/octosail" -o "$OCTOSAIL_CMD"
sudo chmod +x "$OCTOSAIL_CMD"
# Check if installation was successful
if [[ ! -x "$OCTOSAIL_CMD" ]]; then
echo "Failed to install octosail. Please install it manually."
exit 1
fi
else
echo "Cannot proceed without octosail installed. Exiting."
exit 1
fi
fi
###############################################################################
# Configuration Setup
###############################################################################
# Function to create configuration interactively using whiptail
function create_configuration() {
echo "Creating configuration file at $CONFIG_FILE..."
# Prompt for Uptime Kuma URL
UPTIME_KUMA_URL=$(whiptail --inputbox "Enter your Uptime Kuma URL:" 8 60 3>&1 1>&2 2>&3)
exitstatus=$?
if [[ $exitstatus -ne 0 || -z "$UPTIME_KUMA_URL" ]]; then
echo "Uptime Kuma URL is required. Exiting."
exit 1
fi
# Initialize configuration JSON
CONFIG_JSON="{\"uptime_kuma_url\": \"$UPTIME_KUMA_URL\", \"monitors\": []}"
# Loop to add monitors
while true; do
# Prompt to add a monitor
if ! whiptail --yesno "Do you want to add a monitor?" 8 60; then
break
fi
# Prompt for Monitor ID
MONITOR_ID=$(whiptail --inputbox "Enter Monitor ID:" 8 60 3>&1 1>&2 2>&3)
if [[ $? -ne 0 || -z "$MONITOR_ID" ]]; then
echo "Monitor ID is required. Skipping."
continue
fi
# Prompt for Instance Name
INSTANCE_NAME=$(whiptail --inputbox "Enter Lightsail Instance Name for Monitor ID $MONITOR_ID:" 8 60 3>&1 1>&2 2>&3)
if [[ $? -ne 0 || -z "$INSTANCE_NAME" ]]; then
echo "Instance Name is required. Skipping."
continue
fi
# Add monitor to configuration
CONFIG_JSON=$(echo "$CONFIG_JSON" | jq --argjson monitor "{\"monitor_id\": $MONITOR_ID, \"instance_name\": \"$INSTANCE_NAME\"}" '.monitors += [$monitor]')
done
# Save configuration to file
echo "$CONFIG_JSON" | jq '.' > "$CONFIG_FILE"
echo "Configuration saved to $CONFIG_FILE."
}
# Check if the configuration file exists
if [[ ! -f "$CONFIG_FILE" ]]; then
echo "Configuration file $CONFIG_FILE not found."
if whiptail --yesno "Configuration file not found. Do you want to create it now?" 8 60; then
create_configuration
else
echo "Cannot proceed without a configuration file. Exiting."
exit 1
fi
fi
###############################################################################
# Load Configuration
###############################################################################
# Read the Uptime Kuma URL from the configuration file
UPTIME_KUMA_URL=$(jq -r '.uptime_kuma_url' "$CONFIG_FILE")
if [[ -z "$UPTIME_KUMA_URL" || "$UPTIME_KUMA_URL" == "null" ]]; then
echo "Uptime Kuma URL is not set in the configuration file."
exit 1
fi
# Read the monitors array from the configuration file
MONITORS=$(jq -c '.monitors[]' "$CONFIG_FILE")
if [[ -z "$MONITORS" ]]; then
echo "No monitors found in the configuration file."
exit 1
fi
###############################################################################
# Monitor Checking Logic
###############################################################################
# Iterate over each monitor
echo "Starting monitoring at $(date)"
echo "Uptime Kuma URL: $UPTIME_KUMA_URL"
echo "$MONITORS" | while IFS= read -r monitor; do
MONITOR_ID=$(echo "$monitor" | jq -r '.monitor_id')
INSTANCE_NAME=$(echo "$monitor" | jq -r '.instance_name')
if [[ -z "$MONITOR_ID" || -z "$INSTANCE_NAME" ]]; then
echo "Monitor ID or Instance Name is missing in the configuration."
continue
fi
echo "Checking Monitor ID $MONITOR_ID for Instance $INSTANCE_NAME..."
# Construct the badge URL
BADGE_URL="$UPTIME_KUMA_URL/api/badge/$MONITOR_ID/status"
# Fetch the monitor status as SVG
MONITOR_RESPONSE=$(curl -s "$BADGE_URL")
# Extract the status from the SVG using sed
STATUS=$(echo "$MONITOR_RESPONSE" | sed -n 's/.*<text[^>]*>\([^<]*\)<\/text>.*/\1/p' | tail -1)
# Debug statements (optional)
# echo "Monitor Response: $MONITOR_RESPONSE"
# echo "Extracted Status: $STATUS"
if [[ -n "$STATUS" ]]; then
echo "Monitor ID $MONITOR_ID status: $STATUS"
if [[ "$STATUS" != "Up" ]]; then
echo "Monitor ID $MONITOR_ID is down. Rebooting instance $INSTANCE_NAME..."
# Call the octosail script to reboot the instance
"$OCTOSAIL_CMD" --reboot "$INSTANCE_NAME"
if [[ $? -eq 0 ]]; then
echo "Successfully initiated reboot for instance $INSTANCE_NAME."
else
echo "Failed to reboot instance $INSTANCE_NAME."
fi
else
echo "Monitor ID $MONITOR_ID is up. No action required."
fi
else
echo "Failed to retrieve the status of monitor ID $MONITOR_ID."
echo "Please check the Uptime Kuma server and monitor configuration."
fi
echo "----------------------------------------"
done
echo "Monitoring completed at $(date)"