Skip to content

Commit 7840b74

Browse files
authored
feat: add uptime-kuma to appstore list (#2)
1 parent a158c01 commit 7840b74

File tree

5 files changed

+231
-0
lines changed

5 files changed

+231
-0
lines changed

apps/list.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -237,6 +237,20 @@
237237
"website": "https://www.sonatype.com/products/nexus-repository",
238238
"github": "https://github.com/sonatype/docker-nexus3",
239239
"document": "https://help.sonatype.com/repomanager3"
240+
},
241+
{
242+
"key": "uptime-kuma",
243+
"name": "Uptime Kuma",
244+
"tags": ["Tool"],
245+
"versions": ["1.20.2"],
246+
"shortDescZh": "一个自托管服务监控工具",
247+
"shortDescEn": "A fancy self-hosted monitoring tool",
248+
"type": "tool",
249+
"limit": 0,
250+
"crossVersionUpdate": false,
251+
"website": "https://uptime.kuma.pet/",
252+
"github": "https://github.com/louislam/uptime-kuma",
253+
"document": "https://github.com/louislam/uptime-kuma/wiki"
240254
}
241255
]
242256
}

apps/uptime-kuma/metadata/logo.svg

Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 181 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,181 @@
1+
# Uptime Kuma
2+
3+
<a target="_blank" href="https://github.com/louislam/uptime-kuma"><img src="https://img.shields.io/github/stars/louislam/uptime-kuma" /></a> <a target="_blank" href="https://hub.docker.com/r/louislam/uptime-kuma"><img src="https://img.shields.io/docker/pulls/louislam/uptime-kuma" /></a> <a target="_blank" href="https://hub.docker.com/r/louislam/uptime-kuma"><img src="https://img.shields.io/docker/v/louislam/uptime-kuma/latest?label=docker%20image%20ver." /></a> <a target="_blank" href="https://github.com/louislam/uptime-kuma"><img src="https://img.shields.io/github/last-commit/louislam/uptime-kuma" /></a> <a target="_blank" href="https://opencollective.com/uptime-kuma"><img src="https://opencollective.com/uptime-kuma/total/badge.svg?label=Open%20Collective%20Backers&color=brightgreen" /></a>
4+
[![GitHub Sponsors](https://img.shields.io/github/sponsors/louislam?label=GitHub%20Sponsors)](https://github.com/sponsors/louislam) <a href="https://weblate.kuma.pet/projects/uptime-kuma/uptime-kuma/">
5+
<img src="https://weblate.kuma.pet/widgets/uptime-kuma/-/svg-badge.svg" alt="Translation status" />
6+
</a>
7+
8+
<div align="center" width="100%">
9+
<img src="./public/icon.svg" width="128" alt="" />
10+
</div>
11+
12+
Uptime Kuma is an easy-to-use self-hosted monitoring tool.
13+
14+
<img src="https://user-images.githubusercontent.com/1336778/212262296-e6205815-ad62-488c-83ec-a5b0d0689f7c.jpg" width="700" alt="" />
15+
16+
## 🥔 Live Demo
17+
18+
Try it!
19+
20+
- Tokyo Demo Server: https://demo.uptime.kuma.pet (Sponsored by [Uptime Kuma Sponsors](https://github.com/louislam/uptime-kuma#%EF%B8%8F-sponsors))
21+
22+
It is a temporary live demo, all data will be deleted after 10 minutes. Use the one that is closer to you, but I suggest that you should install and try it out for the best demo experience.
23+
24+
## ⭐ Features
25+
26+
* Monitoring uptime for HTTP(s) / TCP / HTTP(s) Keyword / Ping / DNS Record / Push / Steam Game Server / Docker Containers
27+
* Fancy, Reactive, Fast UI/UX
28+
* Notifications via Telegram, Discord, Gotify, Slack, Pushover, Email (SMTP), and [90+ notification services, click here for the full list](https://github.com/louislam/uptime-kuma/tree/master/src/components/notifications)
29+
* 20 second intervals
30+
* [Multi Languages](https://github.com/louislam/uptime-kuma/tree/master/src/lang)
31+
* Multiple status pages
32+
* Map status pages to specific domains
33+
* Ping chart
34+
* Certificate info
35+
* Proxy support
36+
* 2FA support
37+
38+
## 🔧 How to Install
39+
40+
### 🐳 Docker
41+
42+
```bash
43+
docker run -d --restart=always -p 3001:3001 -v uptime-kuma:/app/data --name uptime-kuma louislam/uptime-kuma:1
44+
```
45+
46+
⚠️ Please use a **local volume** only. Other types such as NFS are not supported.
47+
48+
Uptime Kuma is now running on http://localhost:3001
49+
50+
### 💪🏻 Non-Docker
51+
52+
Required Tools:
53+
- [Node.js](https://nodejs.org/en/download/) >= 14
54+
- [npm](https://docs.npmjs.com/cli/) >= 7
55+
- [Git](https://git-scm.com/downloads)
56+
- [pm2](https://pm2.keymetrics.io/) - For running Uptime Kuma in the background
57+
58+
```bash
59+
# Update your npm to the latest version
60+
npm install npm -g
61+
62+
git clone https://github.com/louislam/uptime-kuma.git
63+
cd uptime-kuma
64+
npm run setup
65+
66+
# Option 1. Try it
67+
node server/server.js
68+
69+
# (Recommended) Option 2. Run in background using PM2
70+
# Install PM2 if you don't have it:
71+
npm install pm2 -g && pm2 install pm2-logrotate
72+
73+
# Start Server
74+
pm2 start server/server.js --name uptime-kuma
75+
76+
77+
```
78+
Uptime Kuma is now running on http://localhost:3001
79+
80+
More useful PM2 Commands
81+
82+
```bash
83+
# If you want to see the current console output
84+
pm2 monit
85+
86+
# If you want to add it to startup
87+
pm2 save && pm2 startup
88+
```
89+
90+
### Advanced Installation
91+
92+
If you need more options or need to browse via a reverse proxy, please read:
93+
94+
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%94%A7-How-to-Install
95+
96+
## 🆙 How to Update
97+
98+
Please read:
99+
100+
https://github.com/louislam/uptime-kuma/wiki/%F0%9F%86%99-How-to-Update
101+
102+
## 🆕 What's Next?
103+
104+
I will mark requests/issues to the next milestone.
105+
106+
https://github.com/louislam/uptime-kuma/milestones
107+
108+
Project Plan:
109+
110+
https://github.com/users/louislam/projects/4/views/1
111+
112+
## ❤️ Sponsors
113+
114+
Thank you so much! (GitHub Sponsors will be updated manually. OpenCollective sponsors will be updated automatically, the list will be cached by GitHub though. It may need some time to be updated)
115+
116+
<img src="https://uptime.kuma.pet/sponsors?v=6" alt />
117+
118+
## 🖼 More Screenshots
119+
120+
Light Mode:
121+
122+
<img src="https://uptime.kuma.pet/img/light.jpg" width="512" alt="" />
123+
124+
Status Page:
125+
126+
<img src="https://user-images.githubusercontent.com/1336778/134628766-a3fe0981-0926-4285-ab46-891a21c3e4cb.png" width="512" alt="" />
127+
128+
Settings Page:
129+
130+
<img src="https://louislam.net/uptimekuma/2.jpg" width="400" alt="" />
131+
132+
Telegram Notification Sample:
133+
134+
<img src="https://louislam.net/uptimekuma/3.jpg" width="400" alt="" />
135+
136+
## Motivation
137+
138+
* I was looking for a self-hosted monitoring tool like "Uptime Robot", but it is hard to find a suitable one. One of the close ones is statping. Unfortunately, it is not stable and no longer maintained.
139+
* Want to build a fancy UI.
140+
* Learn Vue 3 and vite.js.
141+
* Show the power of Bootstrap 5.
142+
* Try to use WebSocket with SPA instead of REST API.
143+
* Deploy my first Docker image to Docker Hub.
144+
145+
If you love this project, please consider giving me a ⭐.
146+
147+
## 🗣️ Discussion
148+
149+
### Issues Page
150+
151+
You can discuss or ask for help in [issues](https://github.com/louislam/uptime-kuma/issues).
152+
153+
### Subreddit
154+
155+
My Reddit account: [u/louislamlam](https://reddit.com/u/louislamlam).
156+
You can mention me if you ask a question on Reddit.
157+
[r/Uptime kuma](https://www.reddit.com/r/UptimeKuma/)
158+
159+
## Contribute
160+
161+
### Test Pull Requests
162+
163+
There are a lot of pull requests right now, but I don't have time to test them all.
164+
165+
If you want to help, you can check this:
166+
https://github.com/louislam/uptime-kuma/wiki/Test-Pull-Requests
167+
168+
### Test Beta Version
169+
170+
Check out the latest beta release here: https://github.com/louislam/uptime-kuma/releases
171+
172+
### Bug Reports / Feature Requests
173+
If you want to report a bug or request a new feature, feel free to open a [new issue](https://github.com/louislam/uptime-kuma/issues).
174+
175+
### Translations
176+
If you want to translate Uptime Kuma into your language, please visit [Weblate Readme](https://github.com/louislam/uptime-kuma/blob/master/src/lang/README.md).
177+
178+
Feel free to correct my grammar in this README, source code, or wiki, as my mother language is not English and my grammar is not that great.
179+
180+
### Create Pull Requests
181+
If you want to modify Uptime Kuma, please read this guide and follow the rules here: https://github.com/louislam/uptime-kuma/blob/master/CONTRIBUTING.md
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"formFields": [
3+
{
4+
"type": "number",
5+
"labelZh": "端口",
6+
"labelEn": "Port",
7+
"required": true,
8+
"default": 3001,
9+
"rule": "paramPort",
10+
"envKey": "PANEL_APP_PORT_HTTP",
11+
"edit": true
12+
}
13+
]
14+
}
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# from https://github.com/louislam/uptime-kuma/blob/master/docker/docker-compose.yml
2+
version: '3'
3+
services:
4+
uptime-kuma:
5+
image: louislam/uptime-kuma:1.20.2
6+
container_name: ${CONTAINER_NAME}
7+
restart: always
8+
networks:
9+
- 1panel-network
10+
volumes:
11+
- ./data:/app/data
12+
ports:
13+
- ${PANEL_APP_PORT_HTTP}:3001
14+
labels:
15+
createdBy: "Apps"
16+
17+
networks:
18+
1panel-network:
19+
external: true

0 commit comments

Comments
 (0)