{"meta":{"slug":"uptime-kuma","name":"Uptime Kuma","category":"uptime-kuma","source":"pterodactyl","owner":"pterodactyl","repo":"application-eggs","branch":"main","path":"uptime-kuma/egg-uptime-kuma.json","rawUrl":"https://raw.githubusercontent.com/pterodactyl/application-eggs/main/uptime-kuma/egg-uptime-kuma.json","indexedAt":1792246788483},"egg":{"_comment":"DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL","meta":{"update_url":null,"version":"PTDL_v2"},"exported_at":"2024-06-02T14:40:55+00:00","name":"Uptime Kuma","author":"eggs@goover.dev","description":"Uptime Kuma is an easy-to-use self-hosted monitoring tool.","features":null,"docker_images":{"ghcr.io/ptero-eggs/apps:uptimekuma":"ghcr.io/ptero-eggs/apps:uptimekuma"},"file_denylist":[],"startup":"if [[ -d .git ]] && [[ {{AUTO_UPDATE}} == \"1\" ]]; then npm run setup; fi; /usr/local/bin/node /home/container/server/server.js --port={{SERVER_PORT}}","config":{"files":"{}","logs":"{}","startup":"{\r\n    \"done\": \"[SERVER] INFO: Listening on \"\r\n}","stop":"^^C"},"scripts":{"installation":{"container":"node:18-alpine","entrypoint":"ash","script":"#!/bin/ash\r\n# Uptime Kuma App Installation Script\r\n#\r\n# Server Files: /mnt/server\r\napk update\r\napk add --no-cache git curl jq file unzip make gcc g++ python3 python3-dev libtool\r\napk add --no-cache git-lfs --repository=https://dl-cdn.alpinelinux.org/alpine/latest-stable/community\r\n\r\n## npm update to latest\r\necho -e \"Updating npm to latest....\\n\"\r\nif [ -d \"/mnt/server/node_modules\" ]; then\r\n    rm -fR /mnt/server/node_modules\r\n    npm cache verify\r\nfi\r\nnpm install -g npm@latest\r\n\r\n## Uptime Kuma install & update\r\nmkdir -p /mnt/server\r\ncd /mnt/server\r\ngit config --global --add safe.directory /mnt/server\r\n\r\nif [ -d .git ]; then\r\n    echo -e \"Updating Uptime Kuma....\\n \"\r\n    npm run setup\r\nelse\r\n    echo -e \"Download and installing Uptime Kuma...\\n\"   \r\n    git clone https://github.com/louislam/uptime-kuma.git .\r\n    npm run setup\r\nfi\r\n\r\n## only create dir, when .git is present to prevent errors\r\nif [ -d .git ]; then\r\n    mkdir -p /mnt/server/data\r\nfi\r\n\r\nif [ ! -f \"/mnt/server/data/kuma.db\" ]; then\r\n    cp /mnt/server/db/kuma.db /mnt/server/data/kuma.db\r\nfi\r\n\r\n## install end\r\necho -e \"-----------------------------------------\"\r\necho -e \"Installation completed...\"\r\necho -e \"-----------------------------------------\"\r\nexit 0"}},"variables":[{"name":"Git Repo Address","description":"GitHub Repo to clone\r\n\r\nI.E. https://github.com/parkervcp/repo_name","env_variable":"GIT_ADDRESS","default_value":"https://github.com/louislam/uptime-kuma","user_viewable":false,"user_editable":false,"rules":"nullable|string","field_type":"text"},{"name":"JS file","description":"The file that starts the app","env_variable":"JS_FILE","default_value":"server/server.js","user_viewable":false,"user_editable":false,"rules":"required|string","field_type":"text"},{"name":"Auto Update","description":"","env_variable":"AUTO_UPDATE","default_value":"1","user_viewable":true,"user_editable":true,"rules":"required|boolean","field_type":"text"}]},"readme":"# Uptime Kuma\n\n## Author & Contributers\n| Name        | Github Profile  | Buy me a Coffee |\n| ------------- |-------------|-------------|\n|   gOOvER   | https://github.com/gOOvER | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B351D0Q) |\n\n## Description\nUptime Kuma is an easy-to-use self-hosted monitoring tool \nEgg is based on parkers generic nodejs egg\n\n## Links\nGithub: https://github.com/louislam/uptime-kuma\n\n## Admin & login\nAfter installation and successful start, browse to your <ip>:<port> and setup the Admin.\n\n## Server Ports\n\nUptime Kuma requires 1 port. You can choose any port you want\n\n| Port    | default       |\n|---------|---------------|\n| default |     3000      |\n\n## Cloudflared, Apprise & Chromium\n\nThe latest image provides support for Cloudflared and Apprise.\n\n### Cloudflared\nWith Cloudflared it is possible to create a proxy over Cloudflare without having to use an nginx proxy. More info here:\nhttps://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy-with-Cloudflare-Tunnel\n\n### Apprise\nApprise provides notifications for all kinds of services. Uptime Kuma has a built-in support for Apprise.\nMore info's here:\nhttps://github.com/caronc/apprise#supported-notifications\n\n### Monitor HTTP(s) - Browser Engine (Chromium) \nThe image supports the monitor \"HTTP(s) - Browser Engine\". \nTo use this monitor, enter the following path in the settings under \"General -> Chrome/Chromium Executable\" (at the bottom):\n\n/usr/bin/chromium-browser"}