Uptime-Kuma-Web-API icon indicating copy to clipboard operation
Uptime-Kuma-Web-API copied to clipboard

Run in Pterodactyl

Open Phyroks opened this issue 2 years ago • 4 comments

My uptime kuma runs in a pterodactyl egg. i would like to run this API in pterodactyl too. Is that possible?

Phyroks avatar Jan 04 '23 14:01 Phyroks

i have no idea what pterodactyl is but if it supports containers then I'm pretty sure the API will work

MedAziz11 avatar Jan 09 '23 15:01 MedAziz11

So my Problem is i use this egg for running uptime kuma https://github.com/parkervcp/eggs/tree/master/software/uptime-kuma Is it possible to run the python code in an other container? Without running it in the same container as pterodactyl

Phyroks avatar Mar 19 '23 12:03 Phyroks

Pterodactyl is a game server management panel, and while it's primarily designed for game servers, it can also be used to manage other types of applications. To run Uptime-Kuma-Web-API using Pterodactyl, you need to create a custom egg.

Follow these steps to create a custom egg for Uptime-Kuma-Web-API:

  1. Log in to your Pterodactyl panel and navigate to the "Nests" section.
  2. Create a new nest or use an existing one.
  3. In the nest, click the "Create Egg" button.
  4. Fill in the required fields for your custom egg:
    • Name: Give your egg a name, such as "Uptime-Kuma-Web-API".
    • Description: Provide a brief description of the application.
    • Docker Image: Use medaziz11/uptimekuma_restapi:latest as the Docker image.
    • Docker ENTRYPOINT: /app/entrypoint.sh
  5. In the "Configuration" tab, add the necessary environment variables for the Uptime-Kuma-Web-API
      - KUMA_SERVER=${KUMA_SERVER:-http://kuma:3001}
      - KUMA_USERNAME=${KUMA_USERNAME:-admin}
      - KUMA_PASSWORD=${KUMA_PASSWORD:-passwordSafe1*}
      - ADMIN_PASSWORD=${ADMIN_PASSWORD:-admin}
      - ACCESS_TOKEN_EXPIRATION=${ACCESS_TOKEN_EXPIRATION:-1}
  1. In the "Startup" tab, configure the process management settings:
    • Startup Command: Set this to /app/entrypoint.sh
    • Stop Command: Use ^C to send a SIGINT signal, which will gracefully stop the application.
    • Kill Command: Leave this as the default (SIGTERM).

After creating the custom egg, you can create a server using this egg and upload the (extra) Uptime-Kuma-Web-API files to the server. Modify the configuration to point to the uptime-kuma service URL instead of the localhost address.

Once the server is set up, you can start it, and Uptime-Kuma-Web-API will run on the Pterodactyl panel.

Keep in mind that Pterodactyl is not specifically designed for hosting non-game applications, so there might be some limitations or unexpected behavior.

nstankov-bg avatar Apr 12 '23 23:04 nstankov-bg