go-pingbot/README.md

38 lines
1.4 KiB
Markdown
Raw Normal View History

2021-08-20 14:06:29 +00:00
# [Pingbot](https://pingbot.cf/) - Backend
2021-07-11 21:19:37 +00:00
2021-08-20 14:06:29 +00:00
[![Repo Size](https://img.shields.io/github/repo-size/MedzikUser/go-pingbot)](https://github.com/MedzikUser/go-pingbot)
[![Build](https://img.shields.io/github/workflow/status/MedzikUser/go-pingbot/release/main)](https://github.com/MedzikUser/go-pingbot/actions/workflows/release.yml)
This application "pings" websites every few minutes (to be set in config). It can be used to keep the application alive on e.g. [glitch.me](https://glitch.com/) or [repl.it](https://replit.com/).
2021-08-17 21:26:19 +00:00
2021-08-23 19:19:44 +00:00
## ⚡ Install Pre-Compile binary
2021-07-11 21:19:37 +00:00
2021-08-20 14:06:29 +00:00
* 💻 Linux amd64
* [Download](https://github.com/MedzikUser/go-pingbot/releases) latest version
* Unpack file `tar xf pingbot_*_linux_amd64.tar.xz`
2021-08-22 10:04:12 +00:00
* Done your binary is `pingbot.out`
2021-08-23 19:19:44 +00:00
## 👨‍💻 Compile from Source Code
‼️ Not recommended because automatic updates don't work
2021-08-22 10:04:12 +00:00
2021-08-23 19:19:44 +00:00
### 🖥️ Requirements
2021-08-22 10:04:12 +00:00
* [Go](https://golang.org/dl) (recommended latest version)
2021-08-23 19:19:44 +00:00
### ⭐ Compile
2021-08-22 10:04:12 +00:00
* Download source code `git clone https://github.com/MedzikUser/go-pingbot.git --depth 1`
* Go to folder with source code `cd go-pingbot`
* Download dependencies `go mod tidy`
* Build `go build -o pingbot.out`
* Done your compined binary is `pingbot.out`
2021-08-23 19:19:44 +00:00
## ⚙️ Configurate
2021-08-22 10:04:12 +00:00
* Complete .env according to schema.env
2021-08-22 10:04:12 +00:00
* And fill in config.toml according to config.schema.toml
2021-08-23 19:19:44 +00:00
## 🔧 Run
2021-08-22 10:04:12 +00:00
2021-08-31 18:18:36 +00:00
* `./pingbot.out` or `./start.sh` (auto restart e.g. if exit on update is enabled)