├── incidents.html
├── .dockerignore
├── .gitignore
├── .github
    ├── FUNDING.yml
    └── dependabot.yml
├── go.mod
├── .deepsource.toml
├── Dockerfile
├── go.sum
├── checks.yaml
├── env.go
├── README.md
├── tmpl.go
├── main.go
└── LICENSE


/incidents.html:
--------------------------------------------------------------------------------
1 | <h2>No Incidents Recorded till Now!</h2>
2 | 


--------------------------------------------------------------------------------
/.dockerignore:
--------------------------------------------------------------------------------
1 | **
2 | !go.*
3 | !*.go
4 | !*.html
5 | !checks.yaml
6 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | *.exe
2 | *.exe~
3 | *.dll
4 | *.so
5 | *.dylib
6 | *.test
7 | *.out
8 | vendor
9 | 


--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 | 
3 | github: annihilatorrrr
4 | 


--------------------------------------------------------------------------------
/go.mod:
--------------------------------------------------------------------------------
 1 | module gotinystatus
 2 | 
 3 | go 1.24.0
 4 | 
 5 | require (
 6 | 	github.com/gomarkdown/markdown v0.0.0-20250207164621-7a1f277a159e
 7 | 	github.com/joho/godotenv v1.5.1
 8 | 	github.com/sethvargo/go-envconfig v1.3.0
 9 | 	gopkg.in/yaml.v3 v3.0.1
10 | )
11 | 


--------------------------------------------------------------------------------
/.deepsource.toml:
--------------------------------------------------------------------------------
 1 | version = 1
 2 | 
 3 | [[analyzers]]
 4 | name = "go"
 5 | enabled = true
 6 | 
 7 |   [analyzers.meta]
 8 |   import_root = "github.com/annihilatorrrr/gotinystatus"
 9 | 
10 | [[transformers]]
11 | name = "gofmt"
12 | enabled = true
13 | 
14 | [[transformers]]
15 | name = "gofumpt"
16 | enabled = true
17 | 


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | updates:
 3 | - package-ecosystem: gomod
 4 |   directory: "/"
 5 |   schedule:
 6 |     interval: daily
 7 |     time: "23:30"
 8 |     timezone: "Asia/Kolkata"
 9 |   allow:
10 |     - dependency-type: "all"
11 |   open-pull-requests-limit: 10
12 |   target-branch: main
13 | - package-ecosystem: docker
14 |   directory: "/"
15 |   schedule:
16 |     interval: daily
17 |     time: "23:30"
18 |   open-pull-requests-limit: 10
19 |   target-branch: main
20 | 


--------------------------------------------------------------------------------
/Dockerfile:
--------------------------------------------------------------------------------
 1 | FROM golang:1.24.3-alpine3.20 AS builder
 2 | WORKDIR /gotinystatus
 3 | RUN apk update && apk upgrade --available && sync && apk add --no-cache --virtual .build-deps
 4 | COPY . .
 5 | RUN go build -ldflags="-w -s" .
 6 | FROM alpine:3.23.2
 7 | RUN apk update && apk upgrade --available && sync
 8 | COPY --from=builder /gotinystatus/gotinystatus /gotinystatus
 9 | COPY --from=builder /gotinystatus/incidents.html /incidents.html
10 | COPY --from=builder /gotinystatus/checks.yaml /checks.yaml
11 | ENTRYPOINT ["/gotinystatus"]
12 | 


--------------------------------------------------------------------------------
/go.sum:
--------------------------------------------------------------------------------
 1 | github.com/gomarkdown/markdown v0.0.0-20250207164621-7a1f277a159e h1:ESHlT0RVZphh4JGBz49I5R6nTdC8Qyc08vU25GQHzzQ=
 2 | github.com/gomarkdown/markdown v0.0.0-20250207164621-7a1f277a159e/go.mod h1:JDGcbDT52eL4fju3sZ4TeHGsQwhG9nbDV21aMyhwPoA=
 3 | github.com/google/go-cmp v0.6.0 h1:ofyhxvXcZhMsU5ulbFiLKl/XBFqE1GSq7atu8tAmTRI=
 4 | github.com/google/go-cmp v0.6.0/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 5 | github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
 6 | github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 7 | github.com/sethvargo/go-envconfig v1.3.0 h1:gJs+Fuv8+f05omTpwWIu6KmuseFAXKrIaOZSh8RMt0U=
 8 | github.com/sethvargo/go-envconfig v1.3.0/go.mod h1:JLd0KFWQYzyENqnEPWWZ49i4vzZo/6nRidxI8YvGiHw=
 9 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
10 | gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
11 | gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
12 | gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
13 | 


--------------------------------------------------------------------------------
/checks.yaml:
--------------------------------------------------------------------------------
 1 | - title: 'Group 1'
 2 |   checks:
 3 |     - name: GitHub Home
 4 |       type: http
 5 |       host: https://github.com
 6 |       url: https://docs.github.com/en
 7 |       expected_code: 200
 8 | 
 9 |     - name: GitHub API
10 |       type: http
11 |       host: https://api.github.com
12 |       url: https://api.github.com/users
13 |       expected_code: 200
14 | 
15 |     - name: Wikipedia Home
16 |       type: http
17 |       host: https://www.wikipedia.org
18 |       url: https://en.wikipedia.org/wiki/Main_Page
19 |       expected_code: 200
20 | 
21 |     - name: Wikipedia API
22 |       type: http
23 |       host: https://en.wikipedia.org/w/api.php
24 |       expected_code: 200
25 | 
26 |     - name: Hacker News
27 |       type: http
28 |       host: https://news.ycombinator.com
29 |       expected_code: 200
30 | 
31 | - title: 'Group 2'
32 |   checks:
33 |     - name: Cloudflare DNS Checker
34 |       type: ping
35 |       host: 1.1.1.1
36 | 
37 |     - name: Google Public DNS
38 |       type: ping
39 |       host: 8.8.8.8
40 | 
41 |     - name: Dummy Postgres Database
42 |       type: port
43 |       host: ec2-54-173-89-248.compute-1.amazonaws.com
44 |       port: 5432
45 | 
46 |     - name: Dummy MySQL Database
47 |       type: port
48 |       host: db.example.com
49 |       port: 3306
50 | 
51 |     - name: Google Home
52 |       type: http
53 |       host: https://www.google.com
54 |       expected_code: 200
55 | 
56 | 
57 | - title: 'Group 3'
58 |   checks:
59 |     - name: Amazon Web Services
60 |       type: http
61 |       host: https://aws.amazon.com
62 |       expected_code: 200
63 | 
64 |     - name: AWS S3 API
65 |       type: http
66 |       host: https://s3.amazonaws.com
67 |       expected_code: 200
68 | 
69 |     - name: Twitter
70 |       type: http
71 |       host: https://twitter.com
72 |       expected_code: 200
73 | 
74 |     - name: Localhost
75 |       type: ping
76 |       host: localhost
77 | 
78 |     - name: Home Server with Self-Signed Certs
79 |       type: http
80 |       host: https://homeserver.local
81 |       ssc: True
82 |       expected_code: 200


--------------------------------------------------------------------------------
/env.go:
--------------------------------------------------------------------------------
 1 | package main
 2 | 
 3 | import (
 4 | 	"context"
 5 | 	"fmt"
 6 | 	"log"
 7 | 	"os"
 8 | 	"path"
 9 | 
10 | 	"github.com/gomarkdown/markdown"
11 | 	"github.com/joho/godotenv"
12 | 	"github.com/sethvargo/go-envconfig"
13 | 	"gopkg.in/yaml.v3"
14 | )
15 | 
16 | type Config struct {
17 | 	CheckInterval       int    `env:"CHECK_INTERVAL, default=60"`
18 | 	MaxHistoryEntries   int    `env:"MAX_HISTORY_ENTRIES, default=10"`
19 | 	ChecksFile          string `env:"CHECKS_FILE, default=checks.yaml"`
20 | 	IncidentsFile       string `env:"INCIDENTS_FILE, default=incidents.html"`
21 | 	HistoryFile         string `env:"HISTORY_FILE, default=history.json"`
22 | 	HtmlOutputDirectory string `env:"HTML_OUTPUT_DIRECTORY, default=status"`
23 | 	Port                int    `env:"PORT"`
24 | 	Token               string `env:"TOKEN"`
25 | 	Chatid              string `env:"CHATID"`
26 | }
27 | 
28 | func readEnv() Config {
29 | 	if err := godotenv.Load(); err != nil {
30 | 		log.Println("Error loading .env file, falling back to default environment variables")
31 | 	}
32 | 	var ret Config
33 | 	if err := envconfig.Process(context.Background(), &ret); err != nil {
34 | 		log.Fatal(err)
35 | 	}
36 | 	if err := os.MkdirAll(ret.HtmlOutputDirectory, 0755); err != nil {
37 | 		log.Fatal(err)
38 | 	}
39 | 	return ret
40 | }
41 | 
42 | func (c *Config) PrintEnv() {
43 | 	fmt.Println("---------------------")
44 | 	fmt.Printf("CHECK_INTERVAL=%d\n", c.CheckInterval)
45 | 	fmt.Printf("MAX_HISTORY_ENTRIES=%d\n", c.MaxHistoryEntries)
46 | 	fmt.Printf("HTML_OUTPUT_DIRECTORY=%s\n", c.HtmlOutputDirectory)
47 | 	fmt.Printf("CHECKS_FILE=%s\n", c.ChecksFile)
48 | 	fmt.Printf("INCIDENTS_FILE=%s\n", c.IncidentsFile)
49 | 	fmt.Printf("STATUS_HISTORY_FILE=%s\n", c.HistoryFile)
50 | 	fmt.Printf("PORT=%d\n", c.Port)
51 | 	fmt.Printf("TOKEN=%s\n", c.Token)
52 | 	fmt.Printf("CHATID=%s\n", c.Chatid)
53 | 	fmt.Println("---------------------")
54 | }
55 | 
56 | func (c *Config) IndexHtmlFile() string {
57 | 	return path.Join(c.HtmlOutputDirectory, "index.html")
58 | }
59 | 
60 | func (c *Config) HistoryHtmlFile() string {
61 | 	return path.Join(c.HtmlOutputDirectory, "history.html")
62 | }
63 | 
64 | func (c *Config) ListenHost() string {
65 | 	return fmt.Sprintf(":%d", c.Port)
66 | }
67 | 
68 | func (c *Config) ReadIncidentHtml() []byte {
69 | 	incidentMarkdown, err := os.ReadFile(c.IncidentsFile)
70 | 	if err != nil {
71 | 		log.Println("Failed to load incidents:", err)
72 | 		incidentMarkdown = []byte("## All Fine!")
73 | 	}
74 | 	return markdown.ToHTML(incidentMarkdown, nil, nil)
75 | }
76 | 
77 | func (c *Config) ReadChecks() []Group {
78 | 	checksData, err := os.ReadFile(c.ChecksFile)
79 | 	if err != nil {
80 | 		log.Fatal("Failed to load checks file:", err)
81 | 	}
82 | 	var groups []Group
83 | 	if err = yaml.Unmarshal(checksData, &groups); err != nil {
84 | 		log.Fatal("Failed to parse checks file:", err)
85 | 	}
86 | 	return groups
87 | }
88 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # GoTinyStatus
  2 | 
  3 | GoTinyStatus is a simple, customizable status page generator that allows you to monitor the status of various services and display them on a clean, dark mode, responsive web page.
  4 | 
  5 | 
  6 | ![Demo](https://github.com/user-attachments/assets/9611f924-22c5-4335-ab78-84b771edc023)
  7 | 
  8 | ## NOTE:
  9 | 
 10 | - Same as https://github.com/harsxv/tinystatus BUT made in GO!
 11 | 
 12 | ## Features
 13 | 
 14 | - Monitor HTTP endpoints, ping hosts, ipv6 address and check open ports
 15 | - Responsive design for both status page and history page
 16 | - Customizable service checks via YAML configuration
 17 | - Incident history tracking
 18 | - Automatic status updates at configurable intervals
 19 | - The generated HTML is only 5KB in size
 20 | - Telegram notification.
 21 | 
 22 | ## Prerequisites
 23 | 
 24 | - Go
 25 | 
 26 | ## Installation
 27 | 
 28 | 1. Clone the repository or download the source code:
 29 |    ```
 30 |    git clone https://github.com/annihilatorrrr/gotinystatus.git
 31 |    cd gotinystatus
 32 |    ```
 33 | 
 34 | 2. Install the required dependencies and run:
 35 |    ```
 36 |    go run .
 37 |    ```
 38 | 
 39 | ## Configuration
 40 | 
 41 | 1. Create a `.env` file in the project root and customize the variables:
 42 |    ```
 43 |    CHECK_INTERVAL=30
 44 |    MAX_HISTORY_ENTRIES=10
 45 |    CHECKS_FILE=checks.yaml
 46 |    INCIDENTS_FILE=incidents.html
 47 |    STATUS_HISTORY_FILE=history.json
 48 |    PORT= Optional Port
 49 |    TOKEN= Optional Telegram Bot TOKEN
 50 |    CHATID= Optional Telegram Chat Id for notification
 51 |    ```
 52 | 
 53 | 2. Edit the `checks.yaml` file to add or modify the services you want to monitor. Example:
 54 |    Example:
 55 |    ```yaml
 56 |     - title: 'Group 1'
 57 |       checks:
 58 |         - name: GitHub Home
 59 |           type: http
 60 |           host: https://github.com
 61 |           url: https://docs.github.com/en
 62 |           expected_code: 200
 63 | 
 64 |         - name: Google Public DNS
 65 |           type: ping
 66 |           host: 8.8.8.8
 67 | 
 68 |         - name: Dummy MySQL Database
 69 |           type: port
 70 |           host: db.example.com
 71 |           port: 3306
 72 | 
 73 |        - name: Home Server with Self-Signed Certs
 74 |           type: http
 75 |           host: https://homeserver.local
 76 |           ssc: True
 77 |           expected_code: 200
 78 |    ```
 79 | 
 80 | 3. (Optional) Customize the `incidents.md` file to add any known incidents or maintenance schedules.
 81 | 
 82 | 4. (Optional) Modify the `templateFile` and `historyTemplateFile` constant to customize the look and feel of your status pages.
 83 | 
 84 | ## Usage
 85 | 
 86 | 1. Run the TinyStatus script:
 87 |    ```
 88 |    go run main.go
 89 |    ```
 90 | 
 91 | 2. The script will generate 3 files:
 92 |    - `index.html`: The main status page
 93 |    - `history.html`: The status history page
 94 |    - `history.json`: The status history and timestamp hdata
 95 | 
 96 | 3. To keep the status page continuously updated, you can run the script in the background:
 97 |    - On Unix-like systems (Linux, macOS):
 98 |    Build:
 99 |      ```
100 |      go build -ldflags="-w -s" .
101 |      ```
102 |    Now just run the go app as service.
103 |    - On Windows, you can use the Task Scheduler to run the exe file at startup.
104 | 
105 | 4. Serve the generated HTML files using HTTP server at specific PORT.
106 | 
107 | ## Using Docker
108 | 
109 | In order to run the script using Docker:
110 | 
111 |    ```
112 |     docker build -t gotinystatus .
113 |     docker run -ti --rm --name gotinystatus -v "$PWD":/usr/src/myapp -w /usr/src/myapp gotinystatus
114 |    ```
115 | 
116 | ## Customization
117 | 
118 | - Adjust the configuration variables in the `.env` file to customize the behavior of GoTinyStatus.
119 | - Customize the appearance of the status page by editing the CSS in `templateFile` and `historyTemplateFile`.
120 | - Add or remove services by modifying the `checks.yaml` file.
121 | 
122 | ## Contributing
123 | 
124 | Contributions are welcome! Please feel free to submit a Pull Request.
125 | 
126 | ## License
127 | 
128 | This project is open source and available under the [MIT License](LICENSE).
129 | 


--------------------------------------------------------------------------------
/tmpl.go:
--------------------------------------------------------------------------------
  1 | package main
  2 | 
  3 | const templateFile = `<!DOCTYPE html>
  4 | <html lang="en">
  5 | <head>
  6 |     <meta charset="UTF-8">
  7 |     <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8 |     <title>Go TinyStatus</title>
  9 |     <style>
 10 |         body {
 11 |             font-family: sans-serif;
 12 |             line-height: 1.6;
 13 |             color: #e0e0e0;
 14 |             max-width: 1200px;
 15 |             margin: 0 auto;
 16 |             padding: 20px;
 17 |             background: #181818;
 18 |             transition: background 0.3s ease, color 0.3s ease;
 19 |         }
 20 |         h1, h2 {
 21 |             color: #e0e0e0;
 22 |             text-align: center;
 23 |         }
 24 |         .status-grid {
 25 |             display: grid;
 26 |             grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));
 27 |             gap: 15px;
 28 |             margin-bottom: 40px;
 29 |         }
 30 |         .status-item {
 31 |             background: #242424;
 32 |             border-radius: 8px;
 33 |             padding: 15px;
 34 |             box-shadow: 0 2px 4px rgba(255,255,255,0.1);
 35 |             text-align: center;
 36 |             transition: transform .2s, background 0.3s ease;
 37 |         }
 38 |         .status-item:hover {
 39 |             transform: translateY(-5px);
 40 |         }
 41 |         .status-item h3 {
 42 |             margin: 0 0 10px;
 43 |         }
 44 |         .status-up { color: #27ae60; }
 45 |         .status-down { color: #e74c3c; }
 46 |         .incidents {
 47 |             background: #242424;
 48 |             border-radius: 8px;
 49 |             padding: 20px;
 50 |             box-shadow: 0 2px 4px rgba(255,255,255,0.1);
 51 |             margin-bottom: 40px;
 52 |         }
 53 |         .footer {
 54 |             text-align: center;
 55 |             font-size: .9em;
 56 |             color: #a0a0a0;
 57 |             margin-top: 40px;
 58 |         }
 59 |         .footer a {
 60 |             color: #9b59b6;
 61 |             text-decoration: none;
 62 |         }
 63 |         .footer a:hover { text-decoration: underline; }
 64 |     </style>
 65 | </head>
 66 | <body>
 67 | <h1>Go TinyStatus</h1>
 68 | <h2>Current Status:</h2>
 69 | {{range $group := .groups}}
 70 | <h3>{{$group.Title}} Status</h3>
 71 | <div class="status-grid">
 72 |     {{range $result := $group.CheckResults}}
 73 |     <div class="status-item">
 74 |         <h3>{{$result.Name}}</h3>
 75 |         <p class="{{if $result.Status}}status-up{{else}}status-down{{end}}">
 76 |             {{if $result.Status}}Operational{{else}}Down{{end}}
 77 |         </p>
 78 |     </div>
 79 |     {{end}}
 80 | </div>
 81 | {{end}}
 82 | <h2>Incident History</h2>
 83 | <div class="incidents">
 84 |     {{.incidents}}
 85 | </div>
 86 | <div class="footer">
 87 |     <p>Last updated: {{.last_updated}}</p>
 88 |     <p><a href="history.html">View Status History</a></p>
 89 | 	<p>Powered by <a href="https://github.com/annihilatorrrr/gotinystatus">GoTinyStatus</a></p>
 90 | </div>
 91 | </body>
 92 | </html>`
 93 | 
 94 | const historyTemplateFile = `<!DOCTYPE html>
 95 | <html lang="en">
 96 | <head>
 97 |     <meta charset="UTF-8">
 98 |     <meta name="viewport" content="width=device-width, initial-scale=1.0">
 99 |     <title>Go TinyStatus History</title>
100 |     <style>
101 |         body {
102 |             font-family: sans-serif;
103 |             line-height: 1.6;
104 |             color: #e0e0e0;
105 |             max-width: 1200px;
106 |             margin: auto;
107 |             padding: 20px;
108 |             background: #181818;
109 |             transition: background 0.3s ease, color 0.3s ease;
110 |         }
111 |         h1, h2 {
112 |             color: #e0e0e0;
113 |             text-align: center;
114 |         }
115 |         .history-grid {
116 |             display: grid;
117 |             grid-template-columns: repeat(auto-fill, minmax(250px, 1fr));
118 |             gap: 20px;
119 |             margin-bottom: 40px;
120 |         }
121 |         .history-item {
122 |             background: #242424;
123 |             border-radius: 8px;
124 |             padding: 15px;
125 |             box-shadow: 0 2px 4px rgba(255,255,255,0.1);
126 |             max-height: 300px;
127 |             overflow: auto;
128 |         }
129 |         .history-item h2 {
130 |             font-size: 1.2rem;
131 |             margin: 0;
132 |         }
133 |         .history-entry {
134 |             margin-bottom: 5px;
135 |             font-size: 0.9rem;
136 |             display: flex;
137 |             justify-content: space-between;
138 |         }
139 |         .status-up { color: #27ae60; }
140 |         .status-down { color: #e74c3c; }
141 |         .footer {
142 |             text-align: center;
143 |             font-size: .9em;
144 |             color: #a0a0a0;
145 |             margin-top: 40px;
146 |         }
147 |         .footer a {
148 |             color: #9b59b6;
149 |             text-decoration: none;
150 |         }
151 |         .footer a:hover { text-decoration: underline; }
152 |     </style>
153 | </head>
154 | <body>
155 | <h1>Go TinyStatus History</h1>
156 | <div class="history-grid">
157 |     {{ range $service, $entries := .history }}
158 |     <div class="history-item">
159 |         <h2>{{ $service }}</h2>
160 |         {{ range $entry := $entries }}
161 |         <div class="history-entry">
162 |             <span>{{ index (split $entry.Timestamp "T") 0 }} {{ slice (index (split $entry.Timestamp "T") 1) 0 8 }}</span>
163 |             <span class="{{ if $entry.Status }}status-up{{ else }}status-down{{ end }}">
164 |                 {{ if $entry.Status }}Up{{ else }}Down{{ end }}
165 |             </span>
166 |         </div>
167 |         {{ end }}
168 |     </div>
169 |     {{ end }}
170 | </div>
171 | <div class="footer">
172 |     <p>Last updated: {{.last_updated}}</p>
173 |     <p><a href="/">Back to Current Status</a></p>
174 | 	<p>Powered by <a href="https://github.com/annihilatorrrr/gotinystatus">GoTinyStatus</a></p>
175 | </div>
176 | </body>
177 | </html>`
178 | 


--------------------------------------------------------------------------------
/main.go:
--------------------------------------------------------------------------------
  1 | package main
  2 | 
  3 | import (
  4 | 	"bytes"
  5 | 	"encoding/json"
  6 | 	"fmt"
  7 | 	"html/template"
  8 | 	"log"
  9 | 	"net"
 10 | 	"net/http"
 11 | 	"net/url"
 12 | 	"os"
 13 | 	"os/exec"
 14 | 	"runtime"
 15 | 	"sort"
 16 | 	"strings"
 17 | 	"sync"
 18 | 	"time"
 19 | )
 20 | 
 21 | type Group struct {
 22 | 	Title  string  `yaml:"title"`
 23 | 	Checks []Check `yaml:"checks"`
 24 | }
 25 | 
 26 | type Check struct {
 27 | 	Name         string `yaml:"name"`
 28 | 	Type         string `yaml:"type"`
 29 | 	Host         string `yaml:"host"`
 30 | 	Address      string `yaml:"address"`
 31 | 	Port         int    `yaml:"port"`
 32 | 	ExpectedCode int    `yaml:"expected_code"`
 33 | }
 34 | 
 35 | type HistoryEntry struct {
 36 | 	Timestamp string `json:"timestamp"`
 37 | 	Status    bool   `json:"status"`
 38 | }
 39 | 
 40 | type GroupCheckResult struct {
 41 | 	Title        string
 42 | 	CheckResults []CheckResult
 43 | }
 44 | 
 45 | type CheckResult struct {
 46 | 	Name   string
 47 | 	Status bool
 48 | }
 49 | 
 50 | func checkHTTP(url string, expectedCode int) bool {
 51 | 	client := &http.Client{Timeout: time.Second * 5}
 52 | 	resp, err := client.Get(url)
 53 | 	if err != nil {
 54 | 		return false
 55 | 	}
 56 | 	_ = resp.Body.Close()
 57 | 	return resp.StatusCode == expectedCode
 58 | }
 59 | 
 60 | func pingIPv6(address string) bool {
 61 | 	var cmd *exec.Cmd
 62 | 	switch runtime.GOOS {
 63 | 	case "windows":
 64 | 		cmd = exec.Command("ping", "-n", "1", "-w", "5000", address)
 65 | 	case "darwin":
 66 | 		cmd = exec.Command("ping", "-c", "1", "-W", "5", address)
 67 | 	default:
 68 | 		cmd = exec.Command("ping", "-6", "-c", "1", "-W", "5", address)
 69 | 	}
 70 | 	return cmd.Run() == nil
 71 | }
 72 | 
 73 | func checkPing(host string) bool {
 74 | 	var cmd *exec.Cmd
 75 | 	switch runtime.GOOS {
 76 | 	case "windows":
 77 | 		cmd = exec.Command("ping", "-n", "1", "-w", "5000", host)
 78 | 	default:
 79 | 		cmd = exec.Command("ping", "-c", "1", "-W", "5", host)
 80 | 	}
 81 | 	return cmd.Run() == nil
 82 | }
 83 | 
 84 | func checkPort(host string, port int) bool {
 85 | 	conn, err := net.DialTimeout("tcp", fmt.Sprintf("%s:%d", host, port), 5*time.Second)
 86 | 	if err != nil {
 87 | 		return false
 88 | 	}
 89 | 	_ = conn.Close()
 90 | 	return true
 91 | }
 92 | 
 93 | func runChecks(groups []Group) []GroupCheckResult {
 94 | 	numGroups := len(groups)
 95 | 	results := make([]GroupCheckResult, numGroups)
 96 | 	wg := sync.WaitGroup{}
 97 | 	for idx, group := range groups {
 98 | 		wg.Add(1)
 99 | 		go func(g Group) {
100 | 			defer wg.Done()
101 | 			results[idx] = checkGroup(g)
102 | 		}(group)
103 | 	}
104 | 	wg.Wait()
105 | 	return results
106 | }
107 | 
108 | func checkGroup(g Group) GroupCheckResult {
109 | 	numResults := len(g.Checks)
110 | 	checkResults := make([]CheckResult, numResults)
111 | 	wg := sync.WaitGroup{}
112 | 	for idx, check := range g.Checks {
113 | 		wg.Add(1)
114 | 		go func(c Check) {
115 | 			defer wg.Done()
116 | 			var status bool
117 | 			switch c.Type {
118 | 			case "http":
119 | 				status = checkHTTP(c.Host, c.ExpectedCode)
120 | 			case "ping":
121 | 				status = checkPing(c.Host)
122 | 			case "Port":
123 | 				status = checkPort(c.Host, c.Port)
124 | 			case "ipv6":
125 | 				status = pingIPv6(c.Address)
126 | 			}
127 | 			checkResults[idx] = CheckResult{c.Name, status}
128 | 		}(check)
129 | 	}
130 | 	wg.Wait()
131 | 	return GroupCheckResult{g.Title, checkResults}
132 | }
133 | 
134 | func (c *Config) loadHistory() map[string][]HistoryEntry {
135 | 	file, err := os.Open(c.HistoryFile)
136 | 	if err != nil {
137 | 		return map[string][]HistoryEntry{}
138 | 	}
139 | 	defer func(file *os.File) {
140 | 		_ = file.Close()
141 | 	}(file)
142 | 	var history map[string][]HistoryEntry
143 | 	_ = json.NewDecoder(file).Decode(&history)
144 | 	if history == nil {
145 | 		history = make(map[string][]HistoryEntry)
146 | 	}
147 | 	return history
148 | }
149 | 
150 | func (c *Config) saveHistory(history map[string][]HistoryEntry) {
151 | 	file, err := os.Create(c.HistoryFile)
152 | 	if err != nil {
153 | 		log.Println("Failed to save history:", err)
154 | 		return
155 | 	}
156 | 	defer func(file *os.File) {
157 | 		_ = file.Close()
158 | 	}(file)
159 | 	_ = json.NewEncoder(file).Encode(history)
160 | }
161 | 
162 | func (c *Config) updateHistory(results []GroupCheckResult) {
163 | 	history := c.loadHistory()
164 | 	currentTime := time.Now().Format(time.RFC3339)
165 | 	for _, group := range results {
166 | 		for _, result := range group.CheckResults {
167 | 			name := result.Name
168 | 			if _, exists := history[name]; !exists {
169 | 				history[name] = []HistoryEntry{}
170 | 			}
171 | 			history[name] = append(history[name], HistoryEntry{currentTime, result.Status})
172 | 			sort.Slice(history[name], func(i, j int) bool {
173 | 				timeI, _ := time.Parse(time.RFC3339, history[name][i].Timestamp)
174 | 				timeJ, _ := time.Parse(time.RFC3339, history[name][j].Timestamp)
175 | 				return timeI.After(timeJ)
176 | 			})
177 | 			if len(history[name]) > c.MaxHistoryEntries {
178 | 				history[name] = history[name][:c.MaxHistoryEntries]
179 | 			}
180 | 		}
181 | 	}
182 | 	c.saveHistory(history)
183 | }
184 | 
185 | func renderTemplate(data map[string]interface{}) string {
186 | 	tmpl, err := template.New("status").Parse(templateFile)
187 | 	if err != nil {
188 | 		log.Fatal(err)
189 | 	}
190 | 	var buf bytes.Buffer
191 | 	if err = tmpl.Execute(&buf, data); err != nil {
192 | 		log.Fatal(err)
193 | 	}
194 | 	return buf.String()
195 | }
196 | 
197 | func (c *Config) generateHistoryPage() {
198 | 	history := c.loadHistory()
199 | 	tmpl, err := template.New("history").Funcs(template.FuncMap{
200 | 		"split": func(s, sep string) []string {
201 | 			return strings.Split(s, sep)
202 | 		},
203 | 	}).Parse(historyTemplateFile)
204 | 	if err != nil {
205 | 		log.Fatal("Failed to parse history template:", err)
206 | 	}
207 | 	data := map[string]interface{}{
208 | 		"history":      history,
209 | 		"last_updated": time.Now().Format("2006-01-02 15:04:05"),
210 | 	}
211 | 	var buf bytes.Buffer
212 | 	if err = tmpl.Execute(&buf, data); err != nil {
213 | 		log.Fatal("Failed to execute history template:", err)
214 | 	}
215 | 	if err = os.WriteFile(c.HistoryHtmlFile(), buf.Bytes(), 0644); err != nil {
216 | 		log.Fatal("Failed to write history page:", err)
217 | 	}
218 | }
219 | 
220 | func (c *Config) monitorServices() {
221 | 	for {
222 | 		groups := c.ReadChecks()
223 | 		// log.Printf("Groups: %+v", groups)
224 | 		results := runChecks(groups)
225 | 		c.updateHistory(results)
226 | 		data := map[string]interface{}{
227 | 			"groups":       results,
228 | 			"incidents":    template.HTML(c.ReadIncidentHtml()),
229 | 			"last_updated": time.Now().Format("2006-01-02 15:04:05"),
230 | 		}
231 | 		html := renderTemplate(data)
232 | 		if err := os.WriteFile(c.IndexHtmlFile(), []byte(html), 0644); err != nil {
233 | 			log.Fatal("Failed to write index.html:", err)
234 | 		}
235 | 		c.generateHistoryPage()
236 | 		log.Println("Status pages updated!")
237 | 		if c.Token != "" && c.Chatid != "" {
238 | 			log.Println("Notifying on telegram ...")
239 | 			for key, hdata := range c.loadHistory() {
240 | 				if total := len(hdata); total >= 2 {
241 | 					latestdata := hdata[:2]
242 | 					if latestdata[0].Status == latestdata[1].Status {
243 | 						continue
244 | 					}
245 | 					lastst := latestdata[1].Status
246 | 					newinterval := c.CheckInterval
247 | 					for x, y := range hdata {
248 | 						if x > 1 {
249 | 							if y.Status == lastst {
250 | 								newinterval += 60
251 | 							} else {
252 | 								break
253 | 							}
254 | 						}
255 | 					}
256 | 					tosend := fmt.Sprintf("<b>✅ %s is now Up!</b>\nSeen Down from last %ds!", key, newinterval)
257 | 					if !latestdata[0].Status {
258 | 						tosend = fmt.Sprintf("<b> 🛑 %s is now Down!</b>\nWas seen Up from last %ds!", key, newinterval)
259 | 					}
260 | 					_ = checkHTTP(fmt.Sprintf("https://api.telegram.org/bot%s/sendMessage?chat_id=%s&parse_mode=html&text=%s", c.Token, c.Chatid, url.QueryEscape(tosend)), 200)
261 | 				} else {
262 | 					tosend := fmt.Sprintf("<b> 🛑 %s is now Down!</b>", key)
263 | 					if hdata[0].Status {
264 | 						tosend = fmt.Sprintf("<b>✅ %s is now Up!</b>", key)
265 | 					}
266 | 					_ = checkHTTP(fmt.Sprintf("https://api.telegram.org/bot%s/sendMessage?chat_id=%s&parse_mode=html&text=%s", c.Token, c.Chatid, url.QueryEscape(tosend)), 200)
267 | 				}
268 | 			}
269 | 			log.Println("Notified on telegram!")
270 | 		}
271 | 		time.Sleep(time.Duration(c.CheckInterval) * time.Second)
272 | 	}
273 | }
274 | 
275 | func serveFile(w http.ResponseWriter, r *http.Request, filePath string) {
276 | 	if _, err := os.Stat(filePath); os.IsNotExist(err) {
277 | 		http.NotFound(w, r)
278 | 		return
279 | 	}
280 | 	http.ServeFile(w, r, filePath)
281 | }
282 | 
283 | func handleHome(w http.ResponseWriter, r *http.Request) {
284 | 	if r.Method != http.MethodGet {
285 | 		http.Error(w, "Method Not Allowed!", http.StatusMethodNotAllowed)
286 | 		return
287 | 	}
288 | 	_, _ = fmt.Fprintf(w, `
289 | <!DOCTYPE html>
290 | <html lang="en">
291 | <head>
292 |     <meta charset="UTF-8">
293 |     <meta name="viewport" content="width=device-width, initial-scale=1.0">
294 |     <title>Service Status</title>
295 |     <style>
296 |         body {
297 |             background-color: #121212;
298 |             color: #e0e0e0;
299 |             font-family: Arial, sans-serif;
300 |             line-height: 1.6;
301 |             margin: 0;
302 |             padding: 20px;
303 |         }
304 |         h1 {
305 |             color: #bb86fc;
306 |         }
307 |         pre {
308 |             background-color: #1e1e1e;
309 |             padding: 10px;
310 |             border-radius: 5px;
311 |             overflow-x: auto;
312 |         }
313 |     </style>
314 | </head>
315 | <body>
316 |     <h1>I'm alive!</h1>
317 |     <p>Go Version: %s</p>
318 |     <p>Go Routines: %d</p>
319 |     <p>Source Code: <a href="https://github.com/annihilatorrrr/gotinystatus" style="color: #bb86fc;">Gotinystatus</a></p>
320 | </body>
321 | </html>`, runtime.Version(), runtime.NumGoroutine())
322 | }
323 | 
324 | func main() {
325 | 	c := readEnv()
326 | 	log.Println("Monitoring services ...")
327 | 	// c.PrintEnv()
328 | 	if c.Port != 0 {
329 | 		log.Printf("Listening on host: %s\n", c.ListenHost())
330 | 		go c.monitorServices()
331 | 		http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
332 | 			if r.URL.Path == "/" {
333 | 				serveFile(w, r, "./"+c.IndexHtmlFile())
334 | 			} else {
335 | 				http.NotFound(w, r)
336 | 			}
337 | 		})
338 | 		http.HandleFunc("/status", func(w http.ResponseWriter, r *http.Request) {
339 | 			if strings.HasPrefix(r.URL.Path, "/status") {
340 | 				handleHome(w, r)
341 | 			} else {
342 | 				http.NotFound(w, r)
343 | 			}
344 | 		})
345 | 		http.HandleFunc("/history.html", func(w http.ResponseWriter, r *http.Request) {
346 | 			if strings.HasPrefix(r.URL.Path, "/history") {
347 | 				serveFile(w, r, "./"+c.HistoryHtmlFile())
348 | 			} else {
349 | 				http.NotFound(w, r)
350 | 			}
351 | 		})
352 | 		log.Println("Server started!")
353 | 		if err := http.ListenAndServe(c.ListenHost(), nil); err != nil {
354 | 			log.Println(err.Error())
355 | 		}
356 | 	} else {
357 | 		c.monitorServices()
358 | 	}
359 | 	log.Println("Bye!")
360 | }
361 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate hdata communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------