From 057433db56fe61e238ec6655ff4f5d78a31397be Mon Sep 17 00:00:00 2001 From: zoomiti Date: Mon, 17 Oct 2022 22:25:45 -0400 Subject: [PATCH 01/10] Added Yarr egg --- software/yarr/README.md | 17 ++++++++++++ software/yarr/egg-yarr.json | 52 +++++++++++++++++++++++++++++++++++++ 2 files changed, 69 insertions(+) create mode 100644 software/yarr/README.md create mode 100644 software/yarr/egg-yarr.json diff --git a/software/yarr/README.md b/software/yarr/README.md new file mode 100644 index 00000000..c1745b14 --- /dev/null +++ b/software/yarr/README.md @@ -0,0 +1,17 @@ +# Yar + +## From their [Github](https://github.com/nkanaev/yarr) + +Host your own web based RSS feed aggregator `yarr`. + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| App | 7070 | + +### Notes + +7070 is the default port, but any port can be used. diff --git a/software/yarr/egg-yarr.json b/software/yarr/egg-yarr.json new file mode 100644 index 00000000..700b30a7 --- /dev/null +++ b/software/yarr/egg-yarr.json @@ -0,0 +1,52 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2022-10-17T22:24:46-04:00", + "name": "Yarr", + "author": "sotoluis90@gmail.com", + "description": "Yarr is a selfhosted feed aggregator", + "features": null, + "docker_images": { + "ghcr.io\/parkervcp\/yolks:debian": "ghcr.io\/parkervcp\/yolks:debian" + }, + "file_denylist": [], + "startup": "echo \"{{USERNAME}}:{{PASSWORD}} > .\/auth.conf && .\/yarr -addr 0.0.0.0:{{SERVER_PORT}} -auth-file=.\/auth.conf -db=.\/feed.sql", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"starting server\",\r\n \"userInteraction\": []\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "apt update\r\napt install -y git make gcc curl tar\r\n\r\ncd\r\n\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] && echo \"amd64\" || echo \"arm64\")\r\n\r\necho ${ARCH}\r\n\r\ncurl -O https:\/\/dl.google.com\/go\/go1.19.2.linux-${ARCH}.tar.gz\r\nls\r\ntar xvf go1.19.2.linux-${ARCH}.tar.gz\r\n\r\nchown -R root:root .\/go\r\nmv go \/usr\/local\r\n\r\nexport GOPATH=$HOME\/work\r\nexport PATH=$PATH:\/usr\/local\/go\/bin:$GOPATH\/bin\r\n\r\ncd \/mnt\/server\r\n\r\nmkdir yarr_source\r\ngit clone https:\/\/github.com\/nkanaev\/yarr.git yarr_source\r\n\r\ncd yarr_source\r\n\r\nexport CGO_ENABLED=1\r\nsed -i -r \"s\/amd64\/$ARCH\/g\" makefile\r\n\r\nmake build_linux # -> _output\/linux\/yarr\r\n\r\ncp _output\/linux\/yarr ..\/yarr\r\ncd ..\/\r\n\r\nrm -rf yarr_source\r\n\r\ntouch auth.conf\r\n\r\nchmod +x yarr\r\n\r\necho \"Install complete\"", + "container": "debian:buster-slim", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Username", + "description": "The username used to log in to yarr", + "env_variable": "USERNAME", + "default_value": "username", + "user_viewable": false, + "user_editable": true, + "rules": "required|string|max:20|alpha_dash", + "field_type": "text" + }, + { + "name": "Password", + "description": "The password needed to log in to yarr", + "env_variable": "PASSWORD", + "default_value": "password", + "user_viewable": false, + "user_editable": true, + "rules": "required|string|max:20|alpha_dash", + "field_type": "text" + } + ] +} \ No newline at end of file From 64866aaa87072f349b0af5efb17714638d489bde Mon Sep 17 00:00:00 2001 From: zoomiti Date: Mon, 17 Oct 2022 22:32:49 -0400 Subject: [PATCH 02/10] Added Yarr to the main `README.md` --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 66aaf868..fbd8f9ca 100644 --- a/README.md +++ b/README.md @@ -341,6 +341,10 @@ If you are reading this it looks like you are looking to add an egg to your serv * [Reposilite](/software/reposilite) +### Yarr + +* [yarr](/software/yarr) + ### 5e Tools * [5e Tools](/software/5e-tools) From 79d1d30ea73072f756e85ed738b72388520af1d0 Mon Sep 17 00:00:00 2001 From: zoomiti Date: Mon, 17 Oct 2022 23:39:49 -0400 Subject: [PATCH 03/10] Fixes Yarr egg startup command --- software/yarr/egg-yarr.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/software/yarr/egg-yarr.json b/software/yarr/egg-yarr.json index 700b30a7..2a3d7083 100644 --- a/software/yarr/egg-yarr.json +++ b/software/yarr/egg-yarr.json @@ -13,7 +13,7 @@ "ghcr.io\/parkervcp\/yolks:debian": "ghcr.io\/parkervcp\/yolks:debian" }, "file_denylist": [], - "startup": "echo \"{{USERNAME}}:{{PASSWORD}} > .\/auth.conf && .\/yarr -addr 0.0.0.0:{{SERVER_PORT}} -auth-file=.\/auth.conf -db=.\/feed.sql", + "startup": "echo \"{{USERNAME}}:{{PASSWORD}}\" > .\/auth.conf && .\/yarr -addr 0.0.0.0:{{SERVER_PORT}} -auth-file=.\/auth.conf -db=.\/feed.sql", "config": { "files": "{}", "startup": "{\r\n \"done\": \"starting server\",\r\n \"userInteraction\": []\r\n}", @@ -49,4 +49,4 @@ "field_type": "text" } ] -} \ No newline at end of file +} From 959c9af068456468b71f47e2cd84e5910c34fc64 Mon Sep 17 00:00:00 2001 From: zoomiti Date: Mon, 17 Oct 2022 23:57:37 -0400 Subject: [PATCH 04/10] Removes unnecessary restrictions on username and password for Yarr egg --- software/yarr/egg-yarr.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/software/yarr/egg-yarr.json b/software/yarr/egg-yarr.json index 2a3d7083..39141576 100644 --- a/software/yarr/egg-yarr.json +++ b/software/yarr/egg-yarr.json @@ -35,7 +35,7 @@ "default_value": "username", "user_viewable": false, "user_editable": true, - "rules": "required|string|max:20|alpha_dash", + "rules": "required|string|alpha_dash", "field_type": "text" }, { @@ -45,7 +45,7 @@ "default_value": "password", "user_viewable": false, "user_editable": true, - "rules": "required|string|max:20|alpha_dash", + "rules": "required|string|alpha_dash", "field_type": "text" } ] From 1b3c72d26ec04b5deeb0fe30b31719472b66f45d Mon Sep 17 00:00:00 2001 From: zoomiti Date: Tue, 18 Oct 2022 00:38:04 -0400 Subject: [PATCH 05/10] Improves auth variables for Yarr --- software/yarr/egg-yarr.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/software/yarr/egg-yarr.json b/software/yarr/egg-yarr.json index 39141576..4add6370 100644 --- a/software/yarr/egg-yarr.json +++ b/software/yarr/egg-yarr.json @@ -13,7 +13,7 @@ "ghcr.io\/parkervcp\/yolks:debian": "ghcr.io\/parkervcp\/yolks:debian" }, "file_denylist": [], - "startup": "echo \"{{USERNAME}}:{{PASSWORD}}\" > .\/auth.conf && .\/yarr -addr 0.0.0.0:{{SERVER_PORT}} -auth-file=.\/auth.conf -db=.\/feed.sql", + "startup": ".\/yarr -addr 0.0.0.0:{{SERVER_PORT}} -auth=\"{{USERNAME}}:{{PASSWORD}}\" -db=.\/feed.sql", "config": { "files": "{}", "startup": "{\r\n \"done\": \"starting server\",\r\n \"userInteraction\": []\r\n}", From b910035224eeb9a79191ad90a7baaca12913d063 Mon Sep 17 00:00:00 2001 From: zoomiti Date: Wed, 19 Oct 2022 14:08:31 -0400 Subject: [PATCH 06/10] Removes default password in Yarr egg --- software/yarr/egg-yarr.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/software/yarr/egg-yarr.json b/software/yarr/egg-yarr.json index 4add6370..65a478b6 100644 --- a/software/yarr/egg-yarr.json +++ b/software/yarr/egg-yarr.json @@ -42,7 +42,7 @@ "name": "Password", "description": "The password needed to log in to yarr", "env_variable": "PASSWORD", - "default_value": "password", + "default_value": "", "user_viewable": false, "user_editable": true, "rules": "required|string|alpha_dash", From dbab8eb8041f1b43219b2378737f8183c9d7d8cb Mon Sep 17 00:00:00 2001 From: zoomiti Date: Wed, 19 Oct 2022 14:39:33 -0400 Subject: [PATCH 07/10] Improves install script for Yarr egg Uses a docker container with go preinstalled Also uses build_default in the makefile to compile the correct version. --- software/yarr/egg-yarr.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/software/yarr/egg-yarr.json b/software/yarr/egg-yarr.json index 65a478b6..9ad62431 100644 --- a/software/yarr/egg-yarr.json +++ b/software/yarr/egg-yarr.json @@ -22,8 +22,8 @@ }, "scripts": { "installation": { - "script": "apt update\r\napt install -y git make gcc curl tar\r\n\r\ncd\r\n\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] && echo \"amd64\" || echo \"arm64\")\r\n\r\necho ${ARCH}\r\n\r\ncurl -O https:\/\/dl.google.com\/go\/go1.19.2.linux-${ARCH}.tar.gz\r\nls\r\ntar xvf go1.19.2.linux-${ARCH}.tar.gz\r\n\r\nchown -R root:root .\/go\r\nmv go \/usr\/local\r\n\r\nexport GOPATH=$HOME\/work\r\nexport PATH=$PATH:\/usr\/local\/go\/bin:$GOPATH\/bin\r\n\r\ncd \/mnt\/server\r\n\r\nmkdir yarr_source\r\ngit clone https:\/\/github.com\/nkanaev\/yarr.git yarr_source\r\n\r\ncd yarr_source\r\n\r\nexport CGO_ENABLED=1\r\nsed -i -r \"s\/amd64\/$ARCH\/g\" makefile\r\n\r\nmake build_linux # -> _output\/linux\/yarr\r\n\r\ncp _output\/linux\/yarr ..\/yarr\r\ncd ..\/\r\n\r\nrm -rf yarr_source\r\n\r\ntouch auth.conf\r\n\r\nchmod +x yarr\r\n\r\necho \"Install complete\"", - "container": "debian:buster-slim", + "script": "cd \/mnt\/server\r\n\r\nmkdir yarr_source\r\ngit clone https:\/\/github.com\/nkanaev\/yarr yarr_source\r\n\r\ncd yarr_source\r\n\r\nmake build_default # -> _output\/yarr\r\n\r\ncp _output\/yarr ..\/yarr\r\ncd ..\/\r\n\r\nrm -rf yarr_source\r\n\r\nchmod +x yarr\r\n\r\necho \"Install complete\"", + "container": "golang:1.19.2-bullseye", "entrypoint": "bash" } }, From e7c6bf06b2f87fe0e358ce6fe69fbed4cd8a13a1 Mon Sep 17 00:00:00 2001 From: zoomiti Date: Wed, 19 Oct 2022 14:59:07 -0400 Subject: [PATCH 08/10] Fixes User viewability of login variables for Yarr egg --- software/yarr/egg-yarr.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/software/yarr/egg-yarr.json b/software/yarr/egg-yarr.json index 9ad62431..fdb5836b 100644 --- a/software/yarr/egg-yarr.json +++ b/software/yarr/egg-yarr.json @@ -33,7 +33,7 @@ "description": "The username used to log in to yarr", "env_variable": "USERNAME", "default_value": "username", - "user_viewable": false, + "user_viewable": true, "user_editable": true, "rules": "required|string|alpha_dash", "field_type": "text" @@ -43,7 +43,7 @@ "description": "The password needed to log in to yarr", "env_variable": "PASSWORD", "default_value": "", - "user_viewable": false, + "user_viewable": true, "user_editable": true, "rules": "required|string|alpha_dash", "field_type": "text" From 88cb986e33a86fd52f2dae620b170f4d66e2d427 Mon Sep 17 00:00:00 2001 From: zoomiti Date: Mon, 24 Oct 2022 14:34:12 -0400 Subject: [PATCH 09/10] Adds #!/bin/bash to Yarr egg install script --- software/yarr/egg-yarr.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/software/yarr/egg-yarr.json b/software/yarr/egg-yarr.json index fdb5836b..db155f9c 100644 --- a/software/yarr/egg-yarr.json +++ b/software/yarr/egg-yarr.json @@ -22,7 +22,7 @@ }, "scripts": { "installation": { - "script": "cd \/mnt\/server\r\n\r\nmkdir yarr_source\r\ngit clone https:\/\/github.com\/nkanaev\/yarr yarr_source\r\n\r\ncd yarr_source\r\n\r\nmake build_default # -> _output\/yarr\r\n\r\ncp _output\/yarr ..\/yarr\r\ncd ..\/\r\n\r\nrm -rf yarr_source\r\n\r\nchmod +x yarr\r\n\r\necho \"Install complete\"", + "script": "#!\/bin\/bash\r\n\r\ncd \/mnt\/server\r\n\r\nmkdir yarr_source\r\ngit clone https:\/\/github.com\/nkanaev\/yarr yarr_source\r\n\r\ncd yarr_source\r\n\r\nmake build_default # -> _output\/yarr\r\n\r\ncp _output\/yarr ..\/yarr\r\ncd ..\/\r\n\r\nrm -rf yarr_source\r\n\r\nchmod +x yarr\r\n\r\necho \"Install complete\"", "container": "golang:1.19.2-bullseye", "entrypoint": "bash" } From 94561fd95ec67cf08d6fc20954bb584a186d92e0 Mon Sep 17 00:00:00 2001 From: zoomiti Date: Mon, 24 Oct 2022 16:49:04 -0400 Subject: [PATCH 10/10] Removes userInteraction in Yarr egg --- software/yarr/egg-yarr.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/software/yarr/egg-yarr.json b/software/yarr/egg-yarr.json index db155f9c..4130fd9e 100644 --- a/software/yarr/egg-yarr.json +++ b/software/yarr/egg-yarr.json @@ -16,7 +16,7 @@ "startup": ".\/yarr -addr 0.0.0.0:{{SERVER_PORT}} -auth=\"{{USERNAME}}:{{PASSWORD}}\" -db=.\/feed.sql", "config": { "files": "{}", - "startup": "{\r\n \"done\": \"starting server\",\r\n \"userInteraction\": []\r\n}", + "startup": "{\r\n \"done\": \"starting server\"\r\n}", "logs": "{}", "stop": "^C" },