added foldingathome egg (#2226)

added foldingathome egg
2024-11-22 12:12:53 +08:00 · 2023-05-01 09:54:44 +02:00 · 2023-05-01 09:54:44 +02:00 · 4c137d7a0c
commit 4c137d7a0c
parent bf74ce2743
3 changed files with 141 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -346,6 +346,10 @@ If you are reading this it looks like you are looking to add an egg to your serv

 * [Elasticsearch](/software/elasticsearch)

+### Folding@Home
+
+* [Folding@Home](/software/foldingathome)
+
 ### Gitea

 * [Gitea](/software/gitea)
--- a/software/foldingathome/README.md
+++ b/software/foldingathome/README.md
@ -0,0 +1,35 @@
+# Folding@Home
+
+[Folding@Home](https://foldingathome.org/) is a distributed computing project aimed at simulating protein folding and other molecular dynamics.
+
+## User Account
+
+You can setup an User Account to track your PPD (Points per Day) and done WUs (Work Units). To get a Passkey visit the [Folding@home Passkey Site](https://apps.foldingathome.org/getpasskey)
+
+## Teams
+
+You can add your earned Points to a Team that you support. This is not nessesary as the points are just to track how much work was done (with some exeptions). Here is the [full List of the Teams](https://stats.foldingathome.org/team)
+
+## Remote Control
+
+You can connect via FAHControl to your instance. WebUI is not supported because it wouldn't be password protected.
+
+## CPU Usage Control
+
+There are three power modes:
+- light
+- medium
+- full
+
+Only light and medium are useful because full enables gpu which is not supported in this egg.
+Light uses half of the available **cpu cores of your system**. Full uses **all of your cpu cores.** You can still limit the cpu usage via the panel.
+
+## Supported Versions
+
+Versions < v8 are supported. v8 is still beta and wont work with this egg. Get the latest v7 version number here: [Folding@Home Downloadserver](https://download.foldingathome.org/releases/public/release/fahclient/debian-stable-64bit/)
+
+## Server Ports
+
+| Port | default |
+| ---- | ------- |
+| FAHControl  | 36330    |
--- a/software/foldingathome/egg-folding--home.json
+++ b/software/foldingathome/egg-folding--home.json
@ -0,0 +1,102 @@
+{
+    "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO",
+    "meta": {
+        "version": "PTDL_v2",
+        "update_url": null
+    },
+    "exported_at": "2023-04-30T12:31:28+02:00",
+    "name": "Folding@Home",
+    "author": "fuggschen@krk-gaming.de",
+    "description": "Folding@home is a distributed computing project aimed to help scientists develop new therapeutics for a variety of diseases by the means of simulating protein dynamics. This includes the process of protein folding and the movements of proteins, and is reliant on simulations run on volunteers' personal computers",
+    "features": null,
+    "docker_images": {
+        "ghcr.io\/parkervcp\/yolks:debian": "ghcr.io\/parkervcp\/yolks:debian"
+    },
+    "file_denylist": [],
+    "startup": ".\/FAHClient --user={{FAH_USERNAME}} --team={{FAH_TEAM}} --passkey={{FAH_PASSKEY}} $(if {{FAH_ANON}}; then echo \"--fold-anon=true\"; fi) --command-port={{SERVER_PORT}} --password={{FAH_PASSWORD}} --power={{FAH_POWER}}",
+    "config": {
+        "files": "{}",
+        "startup": "{\r\n    \"done\": \"Started FahCore\"\r\n}",
+        "logs": "{}",
+        "stop": "^^C"
+    },
+    "scripts": {
+        "installation": {
+            "script": "#!\/bin\/bash\r\n#\r\n# Folding@Home install script\r\n#\r\n# Created by Fuggschen\r\n\r\nexport DEBIAN_FRONTEND=noninteractive\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] && echo \"64bit\" || echo \"arm64\")\r\ncd \/tmp\r\n\r\necho \"Removing previous Version\"\r\nmv \/mnt\/server\/config.xml \/tmp\/config.xml\r\nrm -rf \/mnt\/server\/*\r\n\r\necho \"Installing dependencies\"\r\napt update && apt upgrade -y && apt install curl bzip2 -y\r\n\r\necho \"Downloading FAHClient\"\r\ncurl -sSL -o fahclient.tar.bz2 https:\/\/download.foldingathome.org\/releases\/public\/release\/fahclient\/debian-stable-${ARCH}\/${FAH_VERSION}\/latest.tar.bz2\r\n\r\necho \"Installing FAHClient\"\r\ntar -xjf fahclient.tar.bz2 -C \/mnt\/server --strip-components=1\r\n\r\necho \"Cleaning up..\"\r\nrm -f fahclient.tar.bz2\r\nrm -f \/mnt\/server\/sample-config.xml\r\nmv \/tmp\/config.xml \/mnt\/server\/config.xml\r\n\r\nFILE=\/mnt\/server\/config.xml\r\nif [[ ! -f  $FILE ]]\r\nthen\r\necho \"Setting up config.xml\"\r\ncat > $FILE << EOF\r\n<config>\r\n  <!-- Folding Slots -->\r\n  <slot id='0' type='CPU'\/>\r\n  <!-- Maximum CPU Cores to use. Can't be more than 64 -->\r\n  <cpus v='64'\/>\r\n<\/config>\r\nEOF\r\nfi\r\n\r\necho \"Done!\"",
+            "container": "debian",
+            "entrypoint": "bash"
+        }
+    },
+    "variables": [
+        {
+            "name": "FaH Username",
+            "description": "Your Folding@Home Username",
+            "env_variable": "FAH_USERNAME",
+            "default_value": "Anonymous",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string",
+            "field_type": "text"
+        },
+        {
+            "name": "FaH Team",
+            "description": "Your Folding@Home Team that you are folding for. For reference look here: https:\/\/stats.foldingathome.org\/team",
+            "env_variable": "FAH_TEAM",
+            "default_value": "0",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|int",
+            "field_type": "text"
+        },
+        {
+            "name": "FaH Passkey",
+            "description": "Your Folding@Home Passkey for your Username, if not Anonymous. Get your Passkey here: https:\/\/apps.foldingathome.org\/getpasskey",
+            "env_variable": "FAH_PASSKEY",
+            "default_value": "",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "nullable|string|max:32",
+            "field_type": "text"
+        },
+        {
+            "name": "FaH Anonymous Mode",
+            "description": "Set to true if you are folding Anonymously",
+            "env_variable": "FAH_ANON",
+            "default_value": "true",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|in:true,false",
+            "field_type": "text"
+        },
+        {
+            "name": "FaH Version",
+            "description": "Set to wanted major Folding@Home Version. Check here: https:\/\/download.foldingathome.org\/releases\/public\/release\/fahclient\/debian-stable-64bit\/",
+            "env_variable": "FAH_VERSION",
+            "default_value": "v7.6",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|max:20",
+            "field_type": "text"
+        },
+        {
+            "name": "FaHControl Password",
+            "description": "Set a WebUI Password",
+            "env_variable": "FAH_PASSWORD",
+            "default_value": "SetPasswordHere",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|max:64",
+            "field_type": "text"
+        },
+        {
+            "name": "FaH Power",
+            "description": "The Powerlevel it should use:\r\n- light (only half the cpu power is used)\r\n- medium (full cpu power)\r\n- full (full cpu and gpu power but gpu is not supported)",
+            "env_variable": "FAH_POWER",
+            "default_value": "medium",
+            "user_viewable": true,
+            "user_editable": true,
+            "rules": "required|string|in:light,medium,full",
+            "field_type": "text"
+        }
+    ]
+}