From 5a10c7a0262626ebf079a358542137474dc1c295 Mon Sep 17 00:00:00 2001 From: BaileyCodes Date: Fri, 3 Apr 2026 00:00:40 -0500 Subject: [PATCH] uploaded app --- ptero_eggs/application/5e-tools/README.md | 4 + .../application/5e-tools/egg-5e-tools.json | 42 + ptero_eggs/application/bots/discord/README.md | 64 + .../application/bots/discord/aoede/README.md | 28 + .../bots/discord/aoede/egg-aoede.json | 92 + .../bots/discord/bastion/README.md | 26 + .../bots/discord/bastion/egg-bastion.json | 122 + .../bots/discord/corpbot/README.md | 11 + .../bots/discord/corpbot/egg-corp-bot.json | 52 + .../bots/discord/corpbot/settings_dict.json | 4 + .../bots/discord/dynamica/README.md | 8 + .../bots/discord/dynamica/egg-dynamica.json | 102 + .../bots/discord/fragbot/README.md | 11 + .../bots/discord/fragbot/egg-fragbot.json | 42 + .../discord/game-server-watcher/README.md | 22 + .../egg-game-server-watcher.json | 122 + .../bots/discord/jmusicbot/README.md | 94 + .../bots/discord/jmusicbot/config.txt | 183 ++ .../discord/jmusicbot/egg-j-music-bot.json | 142 + .../discord/jmusicbot/example_playlist.txt | 21 + .../application/bots/discord/muse/README.md | 43 + .../bots/discord/muse/egg-muse.json | 92 + .../bots/discord/parkertron/README.md | 11 + .../discord/parkertron/egg-parkertron.json | 31 + .../bots/discord/pixelbot/README.md | 13 + .../bots/discord/pixelbot/egg-pixel-bot.json | 82 + .../application/bots/discord/redbot/README.md | 20 + .../bots/discord/redbot/config.json | 9 + .../bots/discord/redbot/egg-red.json | 62 + .../application/bots/discord/ree6/README.md | 73 + .../application/bots/discord/ree6/config.yml | 128 + .../bots/discord/ree6/egg-ree6.json | 422 +++ .../bots/discord/sinusbot/README.md | 24 + .../bots/discord/sinusbot/egg-sinusbot.json | 42 + .../bots/other/bigbrotherbot/README.md | 11 + .../bigbrotherbot/egg-big-brother-bot.json | 31 + .../application/bots/teamspeak3/README.md | 8 + .../jts3servermod/egg-j-t-s3-server-mod.json | 42 + ptero_eggs/application/bots/twitch/README.md | 15 + .../bots/twitch/phantombot/README.md | 13 + .../twitch/phantombot/egg-phantom-bot.json | 113 + .../application/bots/twitch/sogebot/README.md | 17 + .../bots/twitch/sogebot/egg-soge-bot.json | 42 + ptero_eggs/application/code-server/README.md | 13 + .../code-server/egg-code--server.json | 56 + .../database/nosql/mongodb/README.md | 34 + .../nosql/mongodb/egg-mongo-d-b7.json | 52 + .../nosql/mongodb/egg-mongo-d-b8.json | 52 + .../database/nosql/rethinkdb/README.md | 21 + .../nosql/rethinkdb/egg-rethinkdb.json | 62 + .../database/redis/redis-5/README.md | 19 + .../database/redis/redis-5/egg-redis-5.json | 42 + .../database/redis/redis-6/README.md | 23 + .../database/redis/redis-6/egg-redis-6.json | 42 + .../database/redis/redis-6/redis.conf | 1835 +++++++++++++ .../database/redis/redis-7/README.md | 23 + .../database/redis/redis-7/egg-redis-7.json | 42 + .../database/redis/redis-7/redis.conf | 2276 +++++++++++++++++ .../database/sql/mariadb/README.md | 20 + .../database/sql/mariadb/egg-maria-d-b.json | 35 + .../database/sql/postgres/README.md | 19 + .../database/sql/postgres/egg-postgres13.json | 52 + .../database/sql/postgres/egg-postgres14.json | 52 + .../database/sql/postgres/egg-postgres15.json | 52 + .../database/sql/postgres/egg-postgres16.json | 52 + .../database/sql/postgres/egg-postgres17.json | 52 + .../application/elasticsearch/README.md | 17 + .../elasticsearch/egg-elasticsearch.json | 52 + .../application/foldingathome/README.md | 35 + .../foldingathome/egg-folding--home.json | 102 + ptero_eggs/application/forgejo/README.md | 18 + .../application/forgejo/egg-forgejo.json | 64 + ptero_eggs/application/gitea/README.md | 19 + ptero_eggs/application/gitea/egg-gitea.json | 62 + ptero_eggs/application/grafana/README.md | 27 + .../application/grafana/egg-grafana.json | 52 + ptero_eggs/application/haste-server/README.md | 13 + .../haste-server/egg-haste-server.json | 31 + ptero_eggs/application/languagetool/README.md | 9 + .../languagetool/egg-language-tool.json | 42 + ptero_eggs/application/lavalink/README.md | 15 + .../application/lavalink/egg-lavalink.json | 62 + ptero_eggs/application/meilisearch/README.md | 7 + .../meilisearch/egg-meilisearch.json | 112 + ptero_eggs/application/minio/README.md | 25 + .../application/minio/egg-minio-s3.json | 42 + ptero_eggs/application/minio/minio.sh | 70 + ptero_eggs/application/monitoring/README.md | 7 + .../application/monitoring/loki/README.md | 25 + .../application/monitoring/loki/egg-loki.json | 42 + .../monitoring/prometheus/README.md | 19 + .../monitoring/prometheus/egg-prometheus.json | 52 + ptero_eggs/application/nats/README.md | 18 + ptero_eggs/application/nats/egg-n-a-t-s.json | 82 + ptero_eggs/application/owncast/README.md | 51 + .../owncast/egg-owncast-online.json | 102 + ptero_eggs/application/rabbitmq/README.md | 46 + .../application/rabbitmq/egg-rabbit-m-q.json | 46 + ptero_eggs/application/rabbitmq/rabbitmq.conf | 1060 ++++++++ ptero_eggs/application/rathole/README.md | 7 + .../application/rathole/egg-rathole.json | 52 + ptero_eggs/application/reposilite/README.md | 7 + .../reposilite/egg-reposilite.json | 46 + .../application/sftp_storage_share/README.md | 19 + .../egg-s-f-t-p-storage-share.json | 31 + ptero_eggs/application/uptime-kuma/README.md | 43 + .../uptime-kuma/egg-uptime-kuma.json | 62 + ptero_eggs/application/voice/README.md | 5 + .../voice/teamspeak6_server/README.md | 35 + .../egg-arm64-teamspeak6-server.json | 212 ++ .../egg-teamspeak6-server.json | 212 ++ .../voice/teamspeak_ARM64/README.md | 17 + .../egg-teamspeak3-server-a-r-m64.json | 72 + .../application/voice/ts3_manager/README.md | 17 + .../voice/ts3_manager/egg-t-s3-manager.json | 62 + ptero_eggs/application/yarr/README.md | 17 + ptero_eggs/application/yarr/egg-yarr.json | 52 + ptero_eggs/{ => game_server}/hytale/README.md | 0 .../{ => game_server}/hytale/egg-hytale.json | 0 .../minecraft/bedrock/LeviLamina/README.md | 0 .../bedrock/LeviLamina/egg-levi-lamina.json | 0 .../bedrock/LiteLoader-bedrock/README.md | 0 .../egg-LiteLoader-bedrock.json | 0 .../minecraft/bedrock/PowerNukkitX/README.md | 0 .../PowerNukkitX/egg-powernukkitx.json | 0 .../minecraft/bedrock/PowerNukkitX/nukkit.yml | 0 .../bedrock/PowerNukkitX/server.properties | 0 .../minecraft/bedrock/README.md | 0 .../minecraft/bedrock/bedrock/README.md | 0 .../bedrock/egg-vanilla-bedrock-ARM64.json | 0 .../bedrock/bedrock/egg-vanilla-bedrock.json | 0 .../minecraft/bedrock/gomint/README.md | 0 .../minecraft/bedrock/gomint/egg-go-mint.json | 0 .../minecraft/bedrock/gomint/server.yml | 0 .../minecraft/bedrock/nukkit/README.md | 0 .../minecraft/bedrock/nukkit/egg-nukkit.json | 0 .../minecraft/bedrock/nukkit/nukkit.yml | 0 .../bedrock/nukkit/server.properties | 0 .../minecraft/bedrock/pocketmine_mp/README.md | 0 .../pocketmine_mp/egg-pocketmine-m-p.json | 0 .../bedrock/pocketmine_mp/server.properties | 0 .../purpur-geysermc-floodgate/README.md | 0 .../egg-purpur-geyser-floodgate.json | 0 .../minecraft/java/README.md | 0 .../minecraft/java/arclight/README.md | 0 .../minecraft/java/arclight/egg-arclight.json | 0 .../minecraft/java/canvas-mc/README.md | 0 .../java/canvas-mc/egg-canvas-mc.json | 0 .../minecraft/java/cuberite/README.md | 0 .../minecraft/java/cuberite/egg-cuberite.json | 0 .../minecraft/java/cuberite/settings.ini | 0 .../minecraft/java/cuberite/webadmin.ini | 0 .../minecraft/java/curseforge/README.md | 0 .../curseforge/egg-curse-forge-generic.json | 0 .../minecraft/java/fabric/README.md | 0 .../minecraft/java/fabric/egg-fabric.json | 0 .../minecraft/java/folia/README.md | 0 .../minecraft/java/folia/egg-folia.json | 0 .../minecraft/java/forge/forge/README.md | 0 .../java/forge/forge/egg-forge-enhanced.json | 0 .../minecraft/java/ftb/README.md | 0 .../minecraft/java/ftb/egg-ftb-installer.json | 0 .../minecraft/java/glowstone/README.md | 0 .../java/glowstone/egg-glowstone.json | 0 .../minecraft/java/krypton/README.md | 0 .../minecraft/java/krypton/config.conf | 0 .../minecraft/java/krypton/egg-krypton.json | 0 .../minecraft/java/limbo/README.md | 0 .../minecraft/java/limbo/egg-limbo.json | 0 .../minecraft/java/magma/README.md | 0 .../minecraft/java/magma/egg-magma.json | 0 .../minecraft/java/modrinth/README.md | 0 .../java/modrinth/egg-modrinth-generic.json | 0 .../minecraft/java/mohist/README.md | 0 .../minecraft/java/mohist/egg-mohist.json | 0 .../minecraft/java/nanolimbo/README.md | 0 .../java/nanolimbo/egg-nano-limbo.json | 0 .../minecraft/java/nanolimbo/settings.yml | 0 .../minecraft/java/neoforge/README.md | 0 .../minecraft/java/neoforge/egg-neoforge.json | 0 .../minecraft/java/paper/README.md | 0 .../minecraft/java/paper/egg-paper.json | 0 .../minecraft/java/purpur/README.md | 0 .../minecraft/java/purpur/egg-purpur.json | 0 .../minecraft/java/quilt/README.md | 0 .../minecraft/java/quilt/egg-quilt.json | 0 .../minecraft/java/server.properties | 0 .../minecraft/java/spigot/README.md | 0 .../minecraft/java/spigot/egg-spigot.json | 0 .../minecraft/java/spongeforge/README.md | 0 .../java/spongeforge/egg-sponge-forge.json | 0 .../minecraft/java/spongevanilla/README.md | 0 .../spongevanilla/egg-sponge-vanilla.json | 0 .../minecraft/java/technic/README.md | 0 .../minecraft/java/technic/Tekkit-2/README.md | 0 .../java/technic/Tekkit-2/egg-tekkit2.json | 0 .../minecraft/java/technic/Tekkit/README.md | 0 .../java/technic/Tekkit/egg-tekkit.json | 0 .../technic/attack-of-the-bteam/README.md | 0 .../egg-attack-of-the-b--team.json | 0 .../java/technic/blightfall/README.md | 0 .../technic/blightfall/egg-blightfall.json | 0 .../minecraft/java/technic/hexxit/README.md | 0 .../java/technic/hexxit/egg-hexxit.json | 0 .../java/technic/tekkit-classic/README.md | 0 .../tekkit-classic/egg-tekkit-classic.json | 0 .../java/technic/tekkit-legends/README.md | 0 .../tekkit-legends/egg-tekkit-legends.json | 0 .../java/technic/tekkit-smp/README.md | 0 .../technic/tekkit-smp/egg-tekkit-smp.json | 0 .../java/technic/the-1-12-2-pack/README.md | 0 .../the-1-12-2-pack/egg-the1-12-2-pack.json | 0 .../java/technic/the-1-7-10-pack/README.md | 0 .../the-1-7-10-pack/egg-the1-7-10-pack.json | 0 .../minecraft/java/vanillacord/README.md | 0 .../java/vanillacord/egg-vanilla-cord.json | 0 .../minecraft/proxy/README.md | 0 .../minecraft/proxy/bedrock/README.md | 0 .../proxy/bedrock/waterdog_pe/README.md | 0 .../proxy/bedrock/waterdog_pe/config.yml | 0 .../bedrock/waterdog_pe/egg-waterdog-p-e.json | 0 .../bedrock/waterdog_pe/egg-waterdog-pe.json | 0 .../minecraft/proxy/java/README.md | 0 .../minecraft/proxy/java/travertine/README.md | 0 .../proxy/java/travertine/egg-travertine.json | 0 .../minecraft/proxy/java/velocity/README.md | 0 .../proxy/java/velocity/egg-velocity.json | 0 .../proxy/java/velocity/velocity.toml | 0 .../minecraft/proxy/java/viaaas/README.md | 0 .../proxy/java/viaaas/egg-v-i-aaa-s.json | 0 .../minecraft/proxy/java/waterfall/README.md | 0 .../minecraft/proxy/java/waterfall/config.yml | 0 .../proxy/java/waterfall/egg-waterfall.json | 0 233 files changed, 10856 insertions(+) create mode 100644 ptero_eggs/application/5e-tools/README.md create mode 100644 ptero_eggs/application/5e-tools/egg-5e-tools.json create mode 100644 ptero_eggs/application/bots/discord/README.md create mode 100644 ptero_eggs/application/bots/discord/aoede/README.md create mode 100644 ptero_eggs/application/bots/discord/aoede/egg-aoede.json create mode 100644 ptero_eggs/application/bots/discord/bastion/README.md create mode 100644 ptero_eggs/application/bots/discord/bastion/egg-bastion.json create mode 100644 ptero_eggs/application/bots/discord/corpbot/README.md create mode 100644 ptero_eggs/application/bots/discord/corpbot/egg-corp-bot.json create mode 100644 ptero_eggs/application/bots/discord/corpbot/settings_dict.json create mode 100644 ptero_eggs/application/bots/discord/dynamica/README.md create mode 100644 ptero_eggs/application/bots/discord/dynamica/egg-dynamica.json create mode 100644 ptero_eggs/application/bots/discord/fragbot/README.md create mode 100644 ptero_eggs/application/bots/discord/fragbot/egg-fragbot.json create mode 100644 ptero_eggs/application/bots/discord/game-server-watcher/README.md create mode 100644 ptero_eggs/application/bots/discord/game-server-watcher/egg-game-server-watcher.json create mode 100644 ptero_eggs/application/bots/discord/jmusicbot/README.md create mode 100644 ptero_eggs/application/bots/discord/jmusicbot/config.txt create mode 100644 ptero_eggs/application/bots/discord/jmusicbot/egg-j-music-bot.json create mode 100644 ptero_eggs/application/bots/discord/jmusicbot/example_playlist.txt create mode 100644 ptero_eggs/application/bots/discord/muse/README.md create mode 100644 ptero_eggs/application/bots/discord/muse/egg-muse.json create mode 100644 ptero_eggs/application/bots/discord/parkertron/README.md create mode 100644 ptero_eggs/application/bots/discord/parkertron/egg-parkertron.json create mode 100644 ptero_eggs/application/bots/discord/pixelbot/README.md create mode 100644 ptero_eggs/application/bots/discord/pixelbot/egg-pixel-bot.json create mode 100644 ptero_eggs/application/bots/discord/redbot/README.md create mode 100644 ptero_eggs/application/bots/discord/redbot/config.json create mode 100644 ptero_eggs/application/bots/discord/redbot/egg-red.json create mode 100644 ptero_eggs/application/bots/discord/ree6/README.md create mode 100644 ptero_eggs/application/bots/discord/ree6/config.yml create mode 100644 ptero_eggs/application/bots/discord/ree6/egg-ree6.json create mode 100644 ptero_eggs/application/bots/discord/sinusbot/README.md create mode 100644 ptero_eggs/application/bots/discord/sinusbot/egg-sinusbot.json create mode 100644 ptero_eggs/application/bots/other/bigbrotherbot/README.md create mode 100644 ptero_eggs/application/bots/other/bigbrotherbot/egg-big-brother-bot.json create mode 100644 ptero_eggs/application/bots/teamspeak3/README.md create mode 100644 ptero_eggs/application/bots/teamspeak3/jts3servermod/egg-j-t-s3-server-mod.json create mode 100644 ptero_eggs/application/bots/twitch/README.md create mode 100644 ptero_eggs/application/bots/twitch/phantombot/README.md create mode 100644 ptero_eggs/application/bots/twitch/phantombot/egg-phantom-bot.json create mode 100644 ptero_eggs/application/bots/twitch/sogebot/README.md create mode 100644 ptero_eggs/application/bots/twitch/sogebot/egg-soge-bot.json create mode 100644 ptero_eggs/application/code-server/README.md create mode 100644 ptero_eggs/application/code-server/egg-code--server.json create mode 100644 ptero_eggs/application/database/nosql/mongodb/README.md create mode 100644 ptero_eggs/application/database/nosql/mongodb/egg-mongo-d-b7.json create mode 100644 ptero_eggs/application/database/nosql/mongodb/egg-mongo-d-b8.json create mode 100644 ptero_eggs/application/database/nosql/rethinkdb/README.md create mode 100644 ptero_eggs/application/database/nosql/rethinkdb/egg-rethinkdb.json create mode 100644 ptero_eggs/application/database/redis/redis-5/README.md create mode 100644 ptero_eggs/application/database/redis/redis-5/egg-redis-5.json create mode 100644 ptero_eggs/application/database/redis/redis-6/README.md create mode 100644 ptero_eggs/application/database/redis/redis-6/egg-redis-6.json create mode 100644 ptero_eggs/application/database/redis/redis-6/redis.conf create mode 100644 ptero_eggs/application/database/redis/redis-7/README.md create mode 100644 ptero_eggs/application/database/redis/redis-7/egg-redis-7.json create mode 100644 ptero_eggs/application/database/redis/redis-7/redis.conf create mode 100644 ptero_eggs/application/database/sql/mariadb/README.md create mode 100644 ptero_eggs/application/database/sql/mariadb/egg-maria-d-b.json create mode 100644 ptero_eggs/application/database/sql/postgres/README.md create mode 100644 ptero_eggs/application/database/sql/postgres/egg-postgres13.json create mode 100644 ptero_eggs/application/database/sql/postgres/egg-postgres14.json create mode 100644 ptero_eggs/application/database/sql/postgres/egg-postgres15.json create mode 100644 ptero_eggs/application/database/sql/postgres/egg-postgres16.json create mode 100644 ptero_eggs/application/database/sql/postgres/egg-postgres17.json create mode 100644 ptero_eggs/application/elasticsearch/README.md create mode 100644 ptero_eggs/application/elasticsearch/egg-elasticsearch.json create mode 100644 ptero_eggs/application/foldingathome/README.md create mode 100644 ptero_eggs/application/foldingathome/egg-folding--home.json create mode 100644 ptero_eggs/application/forgejo/README.md create mode 100644 ptero_eggs/application/forgejo/egg-forgejo.json create mode 100644 ptero_eggs/application/gitea/README.md create mode 100644 ptero_eggs/application/gitea/egg-gitea.json create mode 100644 ptero_eggs/application/grafana/README.md create mode 100644 ptero_eggs/application/grafana/egg-grafana.json create mode 100644 ptero_eggs/application/haste-server/README.md create mode 100644 ptero_eggs/application/haste-server/egg-haste-server.json create mode 100644 ptero_eggs/application/languagetool/README.md create mode 100644 ptero_eggs/application/languagetool/egg-language-tool.json create mode 100644 ptero_eggs/application/lavalink/README.md create mode 100644 ptero_eggs/application/lavalink/egg-lavalink.json create mode 100644 ptero_eggs/application/meilisearch/README.md create mode 100644 ptero_eggs/application/meilisearch/egg-meilisearch.json create mode 100644 ptero_eggs/application/minio/README.md create mode 100644 ptero_eggs/application/minio/egg-minio-s3.json create mode 100644 ptero_eggs/application/minio/minio.sh create mode 100644 ptero_eggs/application/monitoring/README.md create mode 100644 ptero_eggs/application/monitoring/loki/README.md create mode 100644 ptero_eggs/application/monitoring/loki/egg-loki.json create mode 100644 ptero_eggs/application/monitoring/prometheus/README.md create mode 100644 ptero_eggs/application/monitoring/prometheus/egg-prometheus.json create mode 100644 ptero_eggs/application/nats/README.md create mode 100644 ptero_eggs/application/nats/egg-n-a-t-s.json create mode 100644 ptero_eggs/application/owncast/README.md create mode 100644 ptero_eggs/application/owncast/egg-owncast-online.json create mode 100644 ptero_eggs/application/rabbitmq/README.md create mode 100644 ptero_eggs/application/rabbitmq/egg-rabbit-m-q.json create mode 100644 ptero_eggs/application/rabbitmq/rabbitmq.conf create mode 100644 ptero_eggs/application/rathole/README.md create mode 100644 ptero_eggs/application/rathole/egg-rathole.json create mode 100644 ptero_eggs/application/reposilite/README.md create mode 100644 ptero_eggs/application/reposilite/egg-reposilite.json create mode 100644 ptero_eggs/application/sftp_storage_share/README.md create mode 100644 ptero_eggs/application/sftp_storage_share/egg-s-f-t-p-storage-share.json create mode 100644 ptero_eggs/application/uptime-kuma/README.md create mode 100644 ptero_eggs/application/uptime-kuma/egg-uptime-kuma.json create mode 100644 ptero_eggs/application/voice/README.md create mode 100644 ptero_eggs/application/voice/teamspeak6_server/README.md create mode 100644 ptero_eggs/application/voice/teamspeak6_server/egg-arm64-teamspeak6-server.json create mode 100644 ptero_eggs/application/voice/teamspeak6_server/egg-teamspeak6-server.json create mode 100644 ptero_eggs/application/voice/teamspeak_ARM64/README.md create mode 100644 ptero_eggs/application/voice/teamspeak_ARM64/egg-teamspeak3-server-a-r-m64.json create mode 100644 ptero_eggs/application/voice/ts3_manager/README.md create mode 100644 ptero_eggs/application/voice/ts3_manager/egg-t-s3-manager.json create mode 100644 ptero_eggs/application/yarr/README.md create mode 100644 ptero_eggs/application/yarr/egg-yarr.json rename ptero_eggs/{ => game_server}/hytale/README.md (100%) rename ptero_eggs/{ => game_server}/hytale/egg-hytale.json (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/LeviLamina/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/LeviLamina/egg-levi-lamina.json (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/LiteLoader-bedrock/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/LiteLoader-bedrock/egg-LiteLoader-bedrock.json (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/PowerNukkitX/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/PowerNukkitX/egg-powernukkitx.json (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/PowerNukkitX/nukkit.yml (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/PowerNukkitX/server.properties (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/bedrock/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/bedrock/egg-vanilla-bedrock-ARM64.json (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/bedrock/egg-vanilla-bedrock.json (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/gomint/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/gomint/egg-go-mint.json (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/gomint/server.yml (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/nukkit/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/nukkit/egg-nukkit.json (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/nukkit/nukkit.yml (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/nukkit/server.properties (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/pocketmine_mp/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/pocketmine_mp/egg-pocketmine-m-p.json (100%) rename ptero_eggs/{ => game_server}/minecraft/bedrock/pocketmine_mp/server.properties (100%) rename ptero_eggs/{ => game_server}/minecraft/crossplay/purpur-geysermc-floodgate/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/crossplay/purpur-geysermc-floodgate/egg-purpur-geyser-floodgate.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/arclight/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/arclight/egg-arclight.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/canvas-mc/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/canvas-mc/egg-canvas-mc.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/cuberite/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/cuberite/egg-cuberite.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/cuberite/settings.ini (100%) rename ptero_eggs/{ => game_server}/minecraft/java/cuberite/webadmin.ini (100%) rename ptero_eggs/{ => game_server}/minecraft/java/curseforge/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/curseforge/egg-curse-forge-generic.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/fabric/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/fabric/egg-fabric.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/folia/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/folia/egg-folia.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/forge/forge/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/forge/forge/egg-forge-enhanced.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/ftb/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/ftb/egg-ftb-installer.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/glowstone/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/glowstone/egg-glowstone.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/krypton/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/krypton/config.conf (100%) rename ptero_eggs/{ => game_server}/minecraft/java/krypton/egg-krypton.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/limbo/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/limbo/egg-limbo.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/magma/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/magma/egg-magma.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/modrinth/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/modrinth/egg-modrinth-generic.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/mohist/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/mohist/egg-mohist.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/nanolimbo/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/nanolimbo/egg-nano-limbo.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/nanolimbo/settings.yml (100%) rename ptero_eggs/{ => game_server}/minecraft/java/neoforge/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/neoforge/egg-neoforge.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/paper/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/paper/egg-paper.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/purpur/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/purpur/egg-purpur.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/quilt/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/quilt/egg-quilt.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/server.properties (100%) rename ptero_eggs/{ => game_server}/minecraft/java/spigot/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/spigot/egg-spigot.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/spongeforge/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/spongeforge/egg-sponge-forge.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/spongevanilla/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/spongevanilla/egg-sponge-vanilla.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/Tekkit-2/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/Tekkit-2/egg-tekkit2.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/Tekkit/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/Tekkit/egg-tekkit.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/attack-of-the-bteam/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/attack-of-the-bteam/egg-attack-of-the-b--team.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/blightfall/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/blightfall/egg-blightfall.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/hexxit/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/hexxit/egg-hexxit.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/tekkit-classic/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/tekkit-classic/egg-tekkit-classic.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/tekkit-legends/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/tekkit-legends/egg-tekkit-legends.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/tekkit-smp/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/tekkit-smp/egg-tekkit-smp.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/the-1-12-2-pack/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/the-1-12-2-pack/egg-the1-12-2-pack.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/the-1-7-10-pack/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/technic/the-1-7-10-pack/egg-the1-7-10-pack.json (100%) rename ptero_eggs/{ => game_server}/minecraft/java/vanillacord/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/java/vanillacord/egg-vanilla-cord.json (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/bedrock/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/bedrock/waterdog_pe/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/bedrock/waterdog_pe/config.yml (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-p-e.json (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-pe.json (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/travertine/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/travertine/egg-travertine.json (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/velocity/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/velocity/egg-velocity.json (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/velocity/velocity.toml (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/viaaas/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/viaaas/egg-v-i-aaa-s.json (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/waterfall/README.md (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/waterfall/config.yml (100%) rename ptero_eggs/{ => game_server}/minecraft/proxy/java/waterfall/egg-waterfall.json (100%) diff --git a/ptero_eggs/application/5e-tools/README.md b/ptero_eggs/application/5e-tools/README.md new file mode 100644 index 0000000..b8ffb15 --- /dev/null +++ b/ptero_eggs/application/5e-tools/README.md @@ -0,0 +1,4 @@ +# 5e Tools +> A suite of tools for 5th Edition Dungeons & Dragons players and Dungeon Masters. + +This is a self-hosted mirror of https://5e.tools. It will clone a github repository mirror on install and update on container reboot. diff --git a/ptero_eggs/application/5e-tools/egg-5e-tools.json b/ptero_eggs/application/5e-tools/egg-5e-tools.json new file mode 100644 index 0000000..154c84c --- /dev/null +++ b/ptero_eggs/application/5e-tools/egg-5e-tools.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:56+00:00", + "name": "5e Tools", + "author": "pterodactyl@demi.cloud", + "description": "A suite of tools for 5th Edition Dungeons \u0026 Dragons players and Dungeon Masters.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:debian": "ghcr.io/ptero-eggs/yolks:debian" + }, + "file_denylist": [], + "startup": "cd ~/5e-tools \u0026\u0026 git pull \u0026\u0026 cd \u0026\u0026 ./caddy run --config ~/caddy.json", + "config": { + "files": "{\r\n \"caddy.json\": {\r\n \"parser\": \"json\",\r\n \"find\": {\r\n \"apps.http.servers.srv0.listen.0\": \":{{server.build.default.port}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"serving initial configuration\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n# 5e Tools install script\r\n#\r\n# Server Files: /mnt/server\r\ndeclare -r DIR=\"/mnt/server\"\r\ndeclare -r CADDY_INSTALL_URL=\"https://caddyserver.com/api/download?os=linux\u0026arch=amd64\u0026idempotency=41554620449867\"\r\ndeclare -r LOCAL_REPO=\"${DIR}/5e-tools\"\r\n\r\ndie() {\r\n local message=\"$1\"\r\n printf \"\\n%s\\n\" \"${message}\"\r\n exit 2\r\n}\r\ncd_error() {\r\n die \"ERROR: installation encountered an error while trying to change directory\"\r\n}\r\n\r\nmain() {\r\n local git_origin\r\n apt update\r\n apt install -y wget\r\n cd \"${DIR}\" || cd_error\r\n printf \"\\nInstalling Caddy...\\n\"\r\n wget \"${CADDY_INSTALL_URL}\" -O ./caddy\r\n chmod +x ./caddy\r\n printf \"\\nGenerating Caddy configuration...\\n\"\r\n # this is a default config\r\n # key variables, such as the port, will get overwritten with the pterodactyl\r\n # configuration parser\r\n cat \u003c\u003cEOF \u003e\"${DIR}/caddy.json\"\r\n{\r\n \"apps\": {\r\n \"http\": {\r\n \"servers\": {\r\n \"srv0\": {\r\n \"listen\": [\r\n \":8080\"\r\n ],\r\n \"routes\": [\r\n {\r\n \"handle\": [\r\n {\r\n \"handler\": \"vars\",\r\n \"root\": \"/home/container/5e-tools\"\r\n },\r\n {\r\n \"encodings\": {\r\n \"gzip\": {},\r\n \"zstd\": {}\r\n },\r\n \"handler\": \"encode\",\r\n \"prefer\": [\r\n \"zstd\",\r\n \"gzip\"\r\n ]\r\n },\r\n {\r\n \"handler\": \"file_server\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n }\r\n }\r\n }\r\n}\r\nEOF\r\n git config --global pull.ff only\r\n if [[ ! -d \"${LOCAL_REPO}\" ]]; then\r\n printf \"\\nCloning latest version (this may take a while)...\\n\"\r\n # $REPOSITORY is passed via environment variable from pterodactyl\r\n git clone \"${REPOSITORY}\" \"${LOCAL_REPO}\"\r\n else\r\n cd \"${LOCAL_REPO}\" || cd_error\r\n git_origin=\"$(git config --get remote.origin.url)\"\r\n cd \"${DIR}\" || cd_error\r\n printf \"\\n\\ngit origin is %s\\n\\n\" \"${git_origin}\"\r\n # if the user hasn't change the repository variable\r\n if [[ \"${git_origin}\" == \"${REPOSITORY}\" ]]; then\r\n cd \"${LOCAL_REPO}\" || cd_error\r\n printf \"\\nRepository already installed - updating...\\n\"\r\n git fetch --all\r\n git reset --hard origin/master\r\n git pull\r\n cd \"${DIR}\" || cd_error\r\n else\r\n printf \"\\nRepository variable changed since last update\\n...\\n\"\r\n rm -rf \"${LOCAL_REPO}\"\r\n git clone \"${REPOSITORY}\" \"${LOCAL_REPO}\"\r\n fi\r\n fi\r\n printf \"\\nInstallation Complete\\n\"\r\n}\r\nmain \"@\"" + } + }, + "variables": [ + { + "name": "5e Tools Repository", + "description": "Git Repository to use for cloning 5e Tools", + "env_variable": "REPOSITORY", + "default_value": "https://github.com/5etools-mirror-1/5etools-mirror-1.github.io", + "user_viewable": false, + "user_editable": false, + "rules": "required|url", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/README.md b/ptero_eggs/application/bots/discord/README.md new file mode 100644 index 0000000..f99d48d --- /dev/null +++ b/ptero_eggs/application/bots/discord/README.md @@ -0,0 +1,64 @@ +# Discord Bots + +## Some of these bots support other services but are primarily Discord bots + +### [Aoede](aoede) + +[codetheweb/aoede](https://github.com/codetheweb/aoede) +🎧 a self-hosted Spotify → Discord music bot + +### [Bastion](bastion) + +[TheBastionBot/Bastion](https://github.com/TheBastionBot/Bastion) +Give awesome perks to your Discord server! + +### [Corpbot](corpbot) + +[corpnewt/CorpBot.py](https://github.com/corpnewt/CorpBot.py) +A very clumsy python bot for discord + +### [FragBot](fragbot) + +[fragforce/fragbot](https://github.com/fragforce/fragbot) +The bot that runs as the fragforce `@Fragbot` offering looking-for-group services for now + +### [Game Server Watcher](game-server-watcher) + +[a-sync/game-server-watcher](https://github.com/a-sync/game-server-watcher) +A simple discord/telegram/slack bot that can be hosted on a free service to monitor your game servers and players in style. 😎 + +### [JMusicBot](jmusicbot) + +[jagrosh/MusicBot](https://github.com/jagrosh/MusicBot) +A Discord music bot that's easy to set up and run yourself! + +### [Muse](muse) + +[codetheweb/muse](https://github.com/codetheweb/muse) +🎧 a self-hosted midwestern Discord music bot that doesn't suck + +### [parkertron](parkertron) + +[parkervcp/parkertron](https://github.com/parkervcp/parkertron) +The bot that runs as the pterodactyl `@Support Bot` + +### [PixelBot](pixelbot) + +[possatti/pixelbot](https://github.com/possatti/pixelbot) +No longer actively developed. +Was used to test python services. + +### [RedBot](redbot) + +[Cog-Creators/Red-DiscordBot](https://github.com/Cog-Creators/Red-DiscordBot) +A multifunction Discord bot + +### [Ree6](ree6) + +[Ree6-Applications](https://github.com/Ree6-Applications/Ree6) +All-in-one, open source and 100% free Discord Bot! + +### [SinusBot](sinusbot) + +[SinusBot](https://www.sinusbot.com/) +Please Check their site for an in depth on the bot. diff --git a/ptero_eggs/application/bots/discord/aoede/README.md b/ptero_eggs/application/bots/discord/aoede/README.md new file mode 100644 index 0000000..9d3bdbb --- /dev/null +++ b/ptero_eggs/application/bots/discord/aoede/README.md @@ -0,0 +1,28 @@ +# Aoede + +### Authors / Contributors + + + + + + +
+ +
cleme29 + +
+ 💻 + 🔨 +
+ + +Special thanks to Red-Thirten for providing most of the installation script and to TubaApollo & QuintenQVD0 for the Muse egg that helped build most of this one ! + +## Their [Github](https://github.com/codetheweb/aoede) + +Aoede is a Discord music bot that directly streams from Spotify to Discord. The only interface is Spotify itself. + +## Server Ports + +There are no ports required for the Aoede bot diff --git a/ptero_eggs/application/bots/discord/aoede/egg-aoede.json b/ptero_eggs/application/bots/discord/aoede/egg-aoede.json new file mode 100644 index 0000000..bb3993c --- /dev/null +++ b/ptero_eggs/application/bots/discord/aoede/egg-aoede.json @@ -0,0 +1,92 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:07+00:00", + "name": "Aoede", + "author": "contact@bldy.ovh", + "description": "Aoede is a Discord music bot that directly streams from Spotify to Discord. The only interface is Spotify itself.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:ubuntu": "ghcr.io/ptero-eggs/yolks:ubuntu" + }, + "file_denylist": [], + "startup": "./aoede", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Invite me with\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "rust:1.74-slim", + "entrypoint": "bash", + "script": "## Credits: Red-Thirten (https://github.com/lilkingjr1) for providing most of the installation script\r\n## Credits to TubaApollo \u0026 QuintenQVD0 for the Muse egg that helped build most of this one\r\napt-get update\r\napt-get install git curl jq cmake -y -qq\r\n\r\nGITHUB_PACKAGE=\"codetheweb/aoede\"\r\n\r\n# Find GitHub download URL for Muse for specified version\r\nLATEST_JSON=$(curl --silent \"https://api.github.com/repos/${GITHUB_PACKAGE}/releases/latest\")\r\nRELEASES=$(curl --silent \"https://api.github.com/repos/${GITHUB_PACKAGE}/releases\")\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq -r '.tarball_url')\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tarball_url')\r\n else\r\n echo -e \"Could not find version \\\"${VERSION}\\\" of Muse. Defaulting to latest release...\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq -r '.tarball_url')\r\n fi\r\nfi\r\n\r\n# Download Aoede from GitHub \u0026 Extract\r\ncd /mnt/server\r\necho -e \"Downloading Aoede from GitHub...\"\r\ncurl -L ${DOWNLOAD_URL} -o aoede.tar.gz\r\necho -e \"Extracting Aoede from tarball...\"\r\ntar -xvzf aoede.tar.gz --strip-components=1\r\nrm aoede.tar.gz\r\n\r\n# Verify and clean up Aoede installation\r\nif [ ! -f Cargo.toml ]; then\r\n echo -e \"\\nFailed to download release: ${DOWNLOAD_URL}\\n\"\r\n exit 1\r\nfi\r\nrm -rf .dockerignore Dockerfile .gitignore .github/\r\ncargo build --release\r\nmv target/release/aoede .\r\ncargo clean\r\n\r\n\r\necho -e \"\\nAoede Successfully Installed!\"" + } + }, + "variables": [ + { + "name": "Token", + "description": "Discord Bot Token", + "env_variable": "DISCORD_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Username", + "description": "Spotify Username", + "env_variable": "SPOTIFY_USERNAME", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Password", + "description": "Spotify Password", + "env_variable": "SPOTIFY_PASSWORD", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Discord User ID", + "description": "Discord user ID of the user you want Aoede to follow", + "env_variable": "DISCORD_USER_ID", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Autoplay", + "description": "Autoplay similar songs when your music ends \r\nValue : true/false", + "env_variable": "SPOTIFY_BOT_AUTOPLAY", + "default_value": "false", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false", + "field_type": "text" + }, + { + "name": "Version", + "description": "Specify a version, for example: \"v0.7.0\"\r\nFor the latest version, type \"latest\"", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/bastion/README.md b/ptero_eggs/application/bots/discord/bastion/README.md new file mode 100644 index 0000000..963bf47 --- /dev/null +++ b/ptero_eggs/application/bots/discord/bastion/README.md @@ -0,0 +1,26 @@ +# Bastion + +## From their [Github](https://github.com/TheBastionBot/Bastion) + +Bastion is a multi-purpose Discord Bot that can help you automate most tasks in your server, from administration and moderation to keeping the members active through various incentives, games and other fun activities. + + +## Running the bot + +You need to enable both `Privileged Gateway Intents` for the bot to run. + +Invite link: `https://discord.com/oauth2/authorize?client_id=INSERT_APP_ID_HERE&scope=bot&permissions=8` + +## Server Ports + + +| Port | default | +|-----------------------|---------| +| Bastion API Port | 8377 | + +## Mongodb + +Mongodb is automaticly running in the background. Leave Mongo URL to the default to use it. If you want to use a external mongodb server a connection string should look like: `mongodb+srv://:@/?retryWrites=true&w=majority` + +## Startup cmd +By default this should be `npm start` but if you want to register your slash commands set it to `npm run commands` it will activate the slash commands on discord's side. Then the server will crash, change it back to `npm run` to start the bot back up and have slash commands enabled. \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/bastion/egg-bastion.json b/ptero_eggs/application/bots/discord/bastion/egg-bastion.json new file mode 100644 index 0000000..45a2a1e --- /dev/null +++ b/ptero_eggs/application/bots/discord/bastion/egg-bastion.json @@ -0,0 +1,122 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:09+00:00", + "name": "Bastion", + "author": "parker@parkervcp.com", + "description": "Bastion is a multi-purpose Discord Bot that can help you automate most tasks in your server, from administration and moderation to keeping the members active through various incentives, games and other fun activities", + "features": null, + "docker_images": { + "Bastion": "ghcr.io/ptero-eggs/yolks:bot_bastion" + }, + "file_denylist": [], + "startup": "{{STARTUP_CMD}}", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Ready\"\r\n}", + "stop": "^^C" + }, + "scripts": { + "installation": { + "container": "node:20-bookworm", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n# Bastion Bot Installation Script\r\n#\r\n# Server Files: /mnt/server\r\n## Move to install folder\r\napt update\r\napt install -y build-essential libtool python3 git tar\r\n\r\n\r\nmkdir -p /mnt/server/\r\ncd /mnt/server/\r\n\r\nif [ -d \"/mnt/server/mongodb\" ]\r\nthen\r\n cd /mnt/server/\r\n echo \"backing up mongodb\"\r\n REINSTALL=true\r\n tar -czf mongodb_backup.tar.gz mongodb/\r\n mv mongodb_backup.tar.gz /tmp\r\nfi\r\n\r\ncd /mnt/server\r\nrm -rf * .git/ .github/ .env.example .eslintrc.yml .gitattributes .gitignore .npm/\r\n\r\n\r\n## Clone repo\r\necho \"cloning Bastion bot\"\r\ngit clone -q --depth 1 https://github.com/TheBastionBot/Bastion.git ./\r\n\r\necho \"updating npm\"\r\nnpm install -g npm@latest\r\necho \"npm install --no-package-lock\"\r\nnpm install --no-package-lock\r\necho \"npm run build\"\r\nnpm run build\r\n\r\n## Move config files.\r\nmv settings.example.yaml settings.yaml\r\nrm -rf bastion.cmd .env.example bastion.sh scrips/\r\n\r\n\r\nmkdir -p mongodb/\r\nif [ \"$REINSTALL\" == \"true\" ]\r\nthen\r\n cd /mnt/server\r\n echo \"reinstall\"\r\n mv /tmp/mongodb_backup.tar.gz /mnt/server\r\n tar xf mongodb_backup.tar.gz\r\n rm mongodb_backup.tar.gz\r\nelse\r\n echo \"fresh install\"\r\nfi\r\n\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [ + { + "name": "Bot Token", + "description": "The Bot Token you get from https://discordapp.com/developers/applications/", + "env_variable": "BOT_TOKEN", + "default_value": "GETABOTTOKEN", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:80", + "field_type": "text" + }, + { + "name": "Bot Client ID", + "description": "The Bot ID you get from https://discordapp.com/developers/applications/", + "env_variable": "BOT_ID", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:32", + "field_type": "text" + }, + { + "name": "Mongo URL", + "description": "use `mongodb://127.0.0.1:27017/bastion` for using the build in mongodb server", + "env_variable": "MONGO_URI", + "default_value": "mongodb://127.0.0.1:27017/bastion", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:128", + "field_type": "text" + }, + { + "name": "Music Activity", + "description": "When enabled, Bastion updates the activity to the currently playing track", + "env_variable": "BASTION_MUSIC_ACTIVITY", + "default_value": "true", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false", + "field_type": "text" + }, + { + "name": "Relay Direct Messages", + "description": "When enabled, Bastion will relay any direct messages it receives to the owner of the bot application / team.", + "env_variable": "BASTION_RELAY_DMS", + "default_value": "false", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false", + "field_type": "text" + }, + { + "name": "Safe Mode", + "description": "When enabled, this disables usage of unsafe commands like `exec` and `eval`.", + "env_variable": "UNSAFE_MODE", + "default_value": "false", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false", + "field_type": "text" + }, + { + "name": "Bastion API Port", + "description": "Port used for Bastion API Server", + "env_variable": "BASTION_API_PORT", + "default_value": "8377", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:10", + "field_type": "text" + }, + { + "name": "Bastion API Auth", + "description": "Auth for accessing the Bastion API Server.", + "env_variable": "BASTION_API_AUTH", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Startup cmd", + "description": "set to `npm start` if you just want to start the bot.\r\nset to `npm run commands` to activate the slash commands", + "env_variable": "STARTUP_CMD", + "default_value": "npm start", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:npm start,npm run commands", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/corpbot/README.md b/ptero_eggs/application/bots/discord/corpbot/README.md new file mode 100644 index 0000000..20d8c2b --- /dev/null +++ b/ptero_eggs/application/bots/discord/corpbot/README.md @@ -0,0 +1,11 @@ +# CorpBot.py + +## From their [Github](https://github.com/corpnewt/CorpBot.py) + +A very clumsy python bot for discord + +## Server Ports + +No ports are required to run CorpBot. You can assign a random port to the bot. + +### Mods/Plugins may require ports to be added to the server diff --git a/ptero_eggs/application/bots/discord/corpbot/egg-corp-bot.json b/ptero_eggs/application/bots/discord/corpbot/egg-corp-bot.json new file mode 100644 index 0000000..3aa67fa --- /dev/null +++ b/ptero_eggs/application/bots/discord/corpbot/egg-corp-bot.json @@ -0,0 +1,52 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:10+00:00", + "name": "CorpBot", + "author": "parker@parkervcp.com", + "description": "A very clumsy python bot for discord \r\n\r\nhttps://github.com/corpnewt/CorpBot.py", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:python_3.8": "ghcr.io/ptero-eggs/yolks:python_3.8" + }, + "file_denylist": [], + "startup": "/usr/local/bin/python Main.py", + "config": { + "files": "{\r\n \"settings_dict.json\": {\r\n \"parser\": \"json\",\r\n \"find\": {\r\n \"token\": \"{{server.build.env.TOKEN}}\",\r\n \"prefix\": \"{{server.build.env.PREFIX}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Logged in as\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "python:3.8-slim-bookworm", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n# CoprBot Install Script\r\n#\r\n## create dir is it doesn't exist\r\nif [ ! -d /mnt/server/ ]; then\r\n mkdir /mnt/server/\r\nfi\r\n\r\n## move to directory\r\ncd /mnt/server/\r\n\r\n## install deps\r\napt update\r\napt install -y git gcc curl\r\n\r\n## git clone \r\ngit clone https://github.com/corpnewt/CorpBot.py.git .\r\n\r\n## Modify Install.py to work properly in egg format\r\nmv Install.py Install.py.orig\r\nsed -n '/press enter to exit/q;p' Install.py.orig \u003e Install.py\r\nsed -i 's/\"-U\"/\"-U\", \"--target\", \"\\/mnt\\/server\\/\"/g' Install.py\r\n\r\n## run Install.py script\r\npython Install.py\r\n\r\n## get config during install\r\nif [ ! -f /mnt/server/settings_dict.json ]; then\r\n curl https://raw.githubusercontent.com/ptero-eggs/application-eggs/main/bots/discord/corpbot/settings_dict.json -o settings_dict.json\r\nfi\r\n\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [ + { + "name": "Discord Bot Token", + "description": "Get your own token here - https://discordapp.com/developers/applications/", + "env_variable": "TOKEN", + "default_value": "GET_YOUR_OWN", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Command Prefix", + "description": "The prefix for commands from the bot.", + "env_variable": "PREFIX", + "default_value": ".", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/corpbot/settings_dict.json b/ptero_eggs/application/bots/discord/corpbot/settings_dict.json new file mode 100644 index 0000000..b876cab --- /dev/null +++ b/ptero_eggs/application/bots/discord/corpbot/settings_dict.json @@ -0,0 +1,4 @@ +{ + "token": "your_token_here", + "prefix": "your_custom_prefix_here" +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/dynamica/README.md b/ptero_eggs/application/bots/discord/dynamica/README.md new file mode 100644 index 0000000..377918a --- /dev/null +++ b/ptero_eggs/application/bots/discord/dynamica/README.md @@ -0,0 +1,8 @@ +# Dynamica + +## Their [Github](https://github.com/dynamicabot/dynamica-v2) + +An easy-to-use dynamic voice channel bot. + +## Port +You will manual have to change the web port in the src/main.ts on line 24. \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/dynamica/egg-dynamica.json b/ptero_eggs/application/bots/discord/dynamica/egg-dynamica.json new file mode 100644 index 0000000..e17d48b --- /dev/null +++ b/ptero_eggs/application/bots/discord/dynamica/egg-dynamica.json @@ -0,0 +1,102 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:12+00:00", + "name": "Dynamica", + "author": "sebastian.pietschner@gmail.com", + "description": "An easy-to-use dynamic voice channel bot.", + "features": null, + "docker_images": { + "Nodejs 18": "ghcr.io/ptero-eggs/yolks:nodejs_18" + }, + "file_denylist": [], + "startup": "npx prisma migrate deploy \u0026\u0026 yarn start", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Bot logged in as \"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "node:18-bookworm-slim", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n\r\napt update\r\napt -y install tar curl jq git\r\n\r\nmkdir -p /mnt/server\r\ncd /mnt/server\r\n\r\nGITHUB_PACKAGE=\"DynamicaBot/Dynamica-V2\"\r\n\r\n# Find GitHub download URL for Muse for specified version\r\nLATEST_JSON=$(curl --silent \"https://api.github.com/repos/${GITHUB_PACKAGE}/releases/latest\")\r\nRELEASES=$(curl --silent \"https://api.github.com/repos/${GITHUB_PACKAGE}/releases\")\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq -r '.tarball_url')\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tarball_url')\r\n else\r\n echo -e \"Could not find version \\\"${VERSION}\\\" of Muse. Defaulting to latest release...\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq -r '.tarball_url')\r\n fi\r\nfi\r\n\r\ncurl -sSL -o dynamica.tar.gz ${DOWNLOAD_URL}\r\ntar xvf dynamica.tar.gz --strip-components=1\r\nrm dynamica.tar.gz\r\n\r\n#curl -sSL -o tsconfig.json https://pteropaste.com/xqhjja443pbm\r\n\r\nyarn add tsup --dev\r\nyarn install --frozen-lockfile\r\n\r\nyarn generate\r\nyarn build\r\n\r\nrm -rf .github/ .vscode/ Dockerfile partial.Dockerfile entrypoint.sh dynamica-egg.json\r\n\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [ + { + "name": "Database Path", + "description": "The path in which to create the sqlite database.", + "env_variable": "DATABASE_URL", + "default_value": "file:/home/container/dynamica/db.sqlite", + "user_viewable": true, + "user_editable": false, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Token", + "description": "The token for the discord bot.", + "env_variable": "TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Guild ID", + "description": "Add only if using the bot in a single guild.", + "env_variable": "GUILD_ID", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable", + "field_type": "text" + }, + { + "name": "Sentry DSN", + "description": "The DSN for Sentry.", + "env_variable": "SENTRY_DSN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable", + "field_type": "text" + }, + { + "name": "MQTT URL", + "description": "The URL for the MQTT broker.", + "env_variable": "MQTT_URL", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable", + "field_type": "text" + }, + { + "name": "MQTT Username", + "description": "The username for the MQTT broker.", + "env_variable": "MQTT_USER", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable", + "field_type": "text" + }, + { + "name": "MQTT Password", + "description": "The password for the MQTT broker.", + "env_variable": "MQTT_PASS", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "string|nullable", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/fragbot/README.md b/ptero_eggs/application/bots/discord/fragbot/README.md new file mode 100644 index 0000000..2ffdb8d --- /dev/null +++ b/ptero_eggs/application/bots/discord/fragbot/README.md @@ -0,0 +1,11 @@ +# fragbot + +## Their [Github](https://github.com/fragforce/fragbot) + +The golang based discord bot for fragforce. + +Runs the fragforce `@fragbot` + +## Server Ports + +There are no ports required for fragbot diff --git a/ptero_eggs/application/bots/discord/fragbot/egg-fragbot.json b/ptero_eggs/application/bots/discord/fragbot/egg-fragbot.json new file mode 100644 index 0000000..11c94bb --- /dev/null +++ b/ptero_eggs/application/bots/discord/fragbot/egg-fragbot.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:14+00:00", + "name": "fragbot", + "author": "parker@parkervcp.com", + "description": "The fragforce discord bot.\r\n\r\nlocated at https://github.com/fragforce/fragbot", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:alpine": "ghcr.io/ptero-eggs/yolks:alpine" + }, + "file_denylist": [], + "startup": "./fragbot", + "config": { + "files": "{\r\n \"config.json\": {\r\n \"parser\": \"json\",\r\n \"find\": {\r\n \"token\": \"{{server.build.env.DISCORD_TOKEN}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Bot is now running\"\r\n}", + "stop": "shutdown" + }, + "scripts": { + "installation": { + "container": "golang:1.12-alpine", + "entrypoint": "ash", + "script": "#!/bin/ash\r\n# fragbot Installation Script\r\n#\r\n# Server Files: /mnt/server\r\nexport GOPATH=$HOME/go\r\nexport PATH=$GOROOT/bin:$GOPATH/bin:$PATH\r\n\r\ncd\r\n\r\napk add --no-cache --update git\r\n\r\necho \"pulling the fragbot repo\"\r\n\r\ngit clone https://github.com/fragforce/fragbot.git\r\n\r\ncd fragbot/\r\n\r\ngo mod download\r\n\r\necho \"building fragbot\"\r\n\r\ngo build \r\n\r\necho \"build complete copying parkertron and example configs over\"\r\n\r\ncp fragbot /mnt/server/\r\n\r\nif [ -f /mnt/server/config.json ]; then\r\n echo \"config file exists already\"\r\nelse\r\n cp -r /root/fragbot/config.example.json /mnt/server/config.json\r\nfi\r\n\r\necho \"Install complete. If you watched this. Congrats.\"" + } + }, + "variables": [ + { + "name": "Discord Bot Token", + "description": "The token that is to be used for the bot.", + "env_variable": "DISCORD_TOKEN", + "default_value": "ThisNeedsToBeChanged", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:128", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/game-server-watcher/README.md b/ptero_eggs/application/bots/discord/game-server-watcher/README.md new file mode 100644 index 0000000..5134102 --- /dev/null +++ b/ptero_eggs/application/bots/discord/game-server-watcher/README.md @@ -0,0 +1,22 @@ +# Game Server Watcher + +## From [Github](https://github.com/a-sync/game-server-watcher#readme) +A simple discord/telegram/slack bot that can be hosted on a free service to monitor your game servers and players in style. 😎 + +## Screenshots + + +## Running the bot +Refer to the wiki on how to acquire tokens for: + * [steam](https://github.com/a-sync/game-server-watcher/wiki/Steam-Web-API-key) + * [discord](https://github.com/a-sync/game-server-watcher/wiki/Discord-bot-token) + * [telegram](https://github.com/a-sync/game-server-watcher/wiki/Telegram-bot-token) + * [slack](https://github.com/a-sync/game-server-watcher/wiki/Slack-bot-token) + +## Server Ports +GSW Control Panel requires one port for http traffic. +(It can be any port.) + +| Port | default | +|---------|---------| +| Web | 8081 | diff --git a/ptero_eggs/application/bots/discord/game-server-watcher/egg-game-server-watcher.json b/ptero_eggs/application/bots/discord/game-server-watcher/egg-game-server-watcher.json new file mode 100644 index 0000000..ed377e1 --- /dev/null +++ b/ptero_eggs/application/bots/discord/game-server-watcher/egg-game-server-watcher.json @@ -0,0 +1,122 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:15+00:00", + "name": "Game Server Watcher", + "author": "a-sync@devs.space", + "description": "A simple discord/telegram/slack bot that can be hosted on a free service to monitor your game servers and players in style. 😎", + "features": null, + "docker_images": { + "Node.js 20": "ghcr.io/ptero-eggs/yolks:nodejs_20" + }, + "file_denylist": [], + "startup": "env PORT={{SERVER_PORT}} /usr/local/bin/node /home/container/dist/server.js", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"starting loop...\"\r\n}", + "stop": "^^C" + }, + "scripts": { + "installation": { + "container": "node:20-bookworm-slim", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n\r\napt-get update \u0026\u0026 apt-get install ca-certificates git -yq --no-install-suggests --no-install-recommends --allow-downgrades --allow-remove-essential --allow-change-held-packages\r\n\r\n\r\ncd /mnt/server\r\n\r\ngit config --global --add safe.directory /mnt/server\r\ngit clone https://github.com/a-sync/game-server-watcher.git . || git pull\r\n\r\n\r\nnpm install --no-save \u0026\u0026 npm update gamedig \u0026\u0026 npm run build\r\nnpm prune --omit=dev\r\n\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [ + { + "name": "SECRET", + "description": "Admin secret", + "env_variable": "SECRET", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|min:8|max:255", + "field_type": "text" + }, + { + "name": "DATA_PATH", + "description": "Writable folder for data storage", + "env_variable": "DATA_PATH", + "default_value": "./data/", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|min:1|max:255", + "field_type": "text" + }, + { + "name": "REFRESH_TIME_MINUTES", + "description": "Game server info refresh interval in minutes", + "env_variable": "REFRESH_TIME_MINUTES", + "default_value": "2", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|min:1", + "field_type": "text" + }, + { + "name": "DISCORD_BOT_TOKEN", + "description": "Discord bot token", + "env_variable": "DISCORD_BOT_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string", + "field_type": "text" + }, + { + "name": "TELEGRAM_BOT_TOKEN", + "description": "Telegram bot token", + "env_variable": "TELEGRAM_BOT_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string", + "field_type": "text" + }, + { + "name": "STEAM_WEB_API_KEY", + "description": "Steam web API key", + "env_variable": "STEAM_WEB_API_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string", + "field_type": "text" + }, + { + "name": "Debug Mode", + "description": "Enable or disable debug mode.", + "env_variable": "DBG", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|in:0,1", + "field_type": "text" + }, + { + "name": "SLACK_BOT_TOKEN", + "description": "Slack bot token", + "env_variable": "SLACK_BOT_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string", + "field_type": "text" + }, + { + "name": "SLACK_APP_TOKEN", + "description": "Slack app token", + "env_variable": "SLACK_APP_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/jmusicbot/README.md b/ptero_eggs/application/bots/discord/jmusicbot/README.md new file mode 100644 index 0000000..67c1252 --- /dev/null +++ b/ptero_eggs/application/bots/discord/jmusicbot/README.md @@ -0,0 +1,94 @@ +# JMusicBot + +___ + +## Authors / Contributors + + + + + + + + + + + +
+ +
John Grosh + +
+ 💻 + 🤖 + 		+ +
parkervcp + +
+ 💻 + 🥚 + 		+ +
Software-Noob + +
+ 💻 + 💡 + 		+ +
Proxymiity + +
+ 💻 + 💡 + 		+ +
Red-Thirten + +
+ 💻 + 💡 +
+ + + +___ + +## Bot Description & Features + +From the developer's [Github](https://github.com/jagrosh/MusicBot): +> A Discord music bot that's easy to set up and run yourself! + +- Easy to run +- Fast loading of songs +- No external keys needed (besides a Discord Bot token) +- Smooth playback +- Server-specific setup for the "DJ" role that can moderate the music +- Clean and beautiful menus +- Supports many sites, including YouTube, Soundcloud, and more +- Supports many online radio/streams +- Supports local files +- Playlist support (both web/youtube, and local) + +___ + +## Configuration + +- If you can, edit the Startup Variables before starting the bot, because otherwise it will fail to start. +- Most settings found in `config.txt` can be edited via the Startup Variables. Advanced settings not listed can still be edited manually via the File Manager. Available Startup Variables will take precedent over manual edits. + +___ + +## Server Ports + +There are no ports required for JMusicBot. +___ + +## Updating + +Re-Installing the server via the panel will do the following: + +1. Update the bot to the latest version. +2. Update the `config.txt` file to the latest version, and place the old one at `config.txt-old`. +3. Any local songs will remain and not be touched. diff --git a/ptero_eggs/application/bots/discord/jmusicbot/config.txt b/ptero_eggs/application/bots/discord/jmusicbot/config.txt new file mode 100644 index 0000000..7ef90ec --- /dev/null +++ b/ptero_eggs/application/bots/discord/jmusicbot/config.txt @@ -0,0 +1,183 @@ +///////////////////////////////////////////////////////// +// Config for the JMusicBot // +///////////////////////////////////////////////////////// +// Any line starting with // is ignored // +// You MUST set the token and owner // +// All other items have defaults if you don't set them // +// Open in Notepad++ for best results // +///////////////////////////////////////////////////////// + + +// This sets the token for the bot to log in with +// This MUST be a bot token (user tokens will not work) +// If you don't know how to get a bot token, please see the guide here: +// https://github.com/jagrosh/MusicBot/wiki/Getting-a-Bot-Token + +token = BOT_TOKEN_HERE + + +// This sets the owner of the bot +// This needs to be the owner's ID (a 17-18 digit number) +// https://github.com/jagrosh/MusicBot/wiki/Finding-Your-User-ID + +owner = 0 + + +// This sets the prefix for the bot +// The prefix is used to control the commands +// If you use !!, the play command will be !!play +// If you do not set this, the prefix will be a mention of the bot (@Botname play) + +prefix = "@mention" + + +// If you set this, it modifies the default game of the bot +// Set this to NONE to have no game +// Set this to DEFAULT to use the default game +// You can make the game "Playing X", "Listening to X", or "Watching X" +// where X is the title. If you don't include an action, it will use the +// default of "Playing" + +game = "DEFAULT" + + +// If you set this, it will modify the default status of bot +// Valid values: ONLINE IDLE DND INVISIBLE + +status = ONLINE + + +// If you set this to true, the bot will list the title of the song it is currently playing in its +// "Playing" status. Note that this will ONLY work if the bot is playing music on ONE guild; +// if the bot is playing on multiple guilds, this will not work. + +songinstatus = false + + +// If you set this, the bot will also use this prefix in addition to +// the one provided above + +altprefix = "NONE" + + +// If you set these, it will change the various emojis + +success = "🎶" +warning = "💡" +error = "🚫" +loading = "⌚" +searching = "🔎" + + +// If you set this, you change the word used to view the help. +// For example, if you set the prefix to !! and the help to cmds, you would type +// !!cmds to see the help text + +help = help + + +// If you set this, the "nowplaying" command will show youtube thumbnails +// Note: If you set this to true, the nowplaying boxes will NOT refresh +// This is because refreshing the boxes causes the image to be reloaded +// every time it refreshes. + +npimages = false + + +// If you set this, the bot will not leave a voice channel after it finishes a queue. +// Keep in mind that being connected to a voice channel uses additional bandwith, +// so this option is not recommended if bandwidth is a concern. + +stayinchannel = false + + +// This sets the maximum amount of seconds any track loaded can be. If not set or set +// to any number less than or equal to zero, there is no maximum time length. This time +// restriction applies to songs loaded from any source. + +maxtime = 0 + +// This sets the amount of seconds the bot will stay alone on a voice channel until it +// automatically leaves the voice channel and clears the queue. If not set or set +// to any number less than or equal to zero, the bot won't leave when alone. + +alonetimeuntilstop = 0 + +// This sets an alternative folder to be used as the Playlists folder +// This can be a relative or absolute path + +playlistsfolder = "Playlists" + + +// By default, the bot will DM the owner if the bot is running and a new version of the bot +// becomes available. Set this to false to disable this feature. + +updatealerts = true + + +// Changing this changes the lyrics provider +// Currently available providers: "A-Z Lyrics", "Genius", "MusicMatch", "LyricsFreak" +// At the time of writing, I would recommend sticking with A-Z Lyrics or MusicMatch, +// as Genius tends to have a lot of non-song results and you might get something +// completely unrelated to what you want. +// If you are interested in contributing a provider, please see +// https://github.com/jagrosh/JLyrics + +lyrics.default = "A-Z Lyrics" + + +// These settings allow you to configure custom aliases for all commands. +// Multiple aliases may be given, separated by commas. +// +// Example 1: Giving command "play" the alias "p": +// play = [ p ] +// +// Example 2: Giving command "search" the aliases "yts" and "find": +// search = [ yts, find ] + +aliases { + // General commands + settings = [ status ] + + // Music commands + lyrics = [] + nowplaying = [ np, current ] + play = [] + playlists = [ pls ] + queue = [ list ] + remove = [ delete ] + scsearch = [] + search = [ ytsearch ] + shuffle = [] + skip = [ voteskip ] + + // Admin commands + prefix = [ setprefix ] + setdj = [] + settc = [] + setvc = [] + + // DJ Commands + forceremove = [ forcedelete, modremove, moddelete ] + forceskip = [ modskip ] + movetrack = [ move ] + pause = [] + playnext = [] + repeat = [] + skipto = [ jumpto ] + stop = [] + volume = [ vol ] +} + +// If you set this to true, it will enable the eval command for the bot owner. This command +// allows the bot owner to run arbitrary code from the bot's account. +// +// WARNING: +// This command can be extremely dangerous. If you don't know what you're doing, you could +// cause horrific problems on your Discord server or on whatever computer this bot is running +// on. Never run this command unless you are completely positive what you are running. +// +// DO NOT ENABLE THIS IF YOU DON'T KNOW WHAT THIS DOES OR HOW TO USE IT +// IF SOMEONE ASKS YOU TO ENABLE THIS, THERE IS AN 11/10 CHANCE THEY ARE TRYING TO SCAM YOU + +eval=false \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/jmusicbot/egg-j-music-bot.json b/ptero_eggs/application/bots/discord/jmusicbot/egg-j-music-bot.json new file mode 100644 index 0000000..b71605c --- /dev/null +++ b/ptero_eggs/application/bots/discord/jmusicbot/egg-j-music-bot.json @@ -0,0 +1,142 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:14+00:00", + "name": "JMusicBot", + "author": "parker@parkervcp.com", + "description": "A Discord music bot that's easy to set up and run yourself!", + "features": null, + "docker_images": { + "ghcr.io/pterodactyl/yolks:java_17": "ghcr.io/pterodactyl/yolks:java_17" + }, + "file_denylist": [], + "startup": "java -Dnogui=true -jar JMusicBot.jar", + "config": { + "files": "{\r\n \"config.txt\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"token =\": \"token = \\\"{{server.build.env.BOT_TOKEN}}\\\"\",\r\n \"owner =\": \"owner = {{server.build.env.BOT_OWNER}}\",\r\n \"prefix =\": \"prefix = \\\"{{server.build.env.BOT_PREFIX}}\\\"\",\r\n \"game =\": \"game = \\\"{{server.build.env.BOT_GAME}}\\\"\",\r\n \"status =\": \"status = {{server.build.env.BOT_STATUS}}\",\r\n \"songinstatus =\": \"songinstatus = {{server.build.env.BOT_SONG_STATUS}}\",\r\n \"altprefix =\": \"altprefix = \\\"{{server.build.env.BOT_ALT_PREFIX}}\\\"\",\r\n \"npimages =\": \"npimages = {{server.build.env.BOT_NPIMAGES}}\",\r\n \"stayinchannel =\": \"stayinchannel = {{server.build.env.BOT_STAY_IN_CHANNEL}}\",\r\n \"maxtime =\": \"maxtime = {{server.build.env.BOT_MAXTIME}}\",\r\n \"alonetimeuntilstop =\": \"alonetimeuntilstop = {{server.build.env.BOT_ALONE_TIME}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Finished Loading\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "/bin/bash", + "script": "#!/bin/bash\r\n\r\napt update\r\napt install -y jq curl\r\n\r\nCONFIG_LINK=\"https://raw.githubusercontent.com/ptero-eggs/application-eggs/main/bots/discord/jmusicbot/config.txt\"\r\nPLAYLIST_LINK=\"https://raw.githubusercontent.com/ptero-eggs/application-eggs/main/bots/discord/jmusicbot/example_playlist.txt\"\r\n\r\n\r\nif [ -z \"${GITHUB_USER}\" ] \u0026\u0026 [ -z \"${GITHUB_OAUTH_TOKEN}\" ] ; then\r\n echo -e \"using anon api call\"\r\nelse\r\n echo -e \"user and oauth token set\"\r\n alias curl='curl -u ${GITHUB_USER}:${GITHUB_OAUTH_TOKEN} '\r\nfi\r\n\r\n## get release info and download links\r\nLATEST_JSON=$(curl --silent \"https://api.github.com/repos/jagrosh/MusicBot/releases/latest\")\r\nRELEASES=$(curl --silent \"https://api.github.com/repos/jagrosh/MusicBot/releases\")\r\nMATCH=JMusicBot\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i ${MATCH})\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i ${MATCH})\r\n else\r\n echo -e \"defaulting to latest release\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url)\r\n fi\r\nfi\r\n\r\n## JMusicBot Setup\r\n[ ! -d /mnt/server ] \u0026\u0026 mkdir /mnt/server\r\ncd /mnt/server\r\necho -e \"\\nInstalling/Updating JMusicBot...\\n\"\r\n\r\nif [ -f JMusicBot.jar ]; then\r\n echo -e \"Updating JMusicBot.jar to latest version...\"\r\n echo -e '\\t(Old version can be found at \"JMusicBot.jar-old\")'\r\n mv -f JMusicBot.jar JMusicBot.jar-old\r\nfi\r\n\r\necho -e \"Running: curl -sSLo JMusicBot.jar ${DOWNLOAD_URL}\\n\"\r\ncurl -sSLo JMusicBot.jar ${DOWNLOAD_URL}\r\n\r\nif [ -f config.txt ]; then\r\n echo -e \"Updating config.txt to latest version...\"\r\n echo -e '\\t(Old version can be found at \"config.txt-old\")'\r\n mv -f config.txt config.txt-old\r\nfi\r\necho -e \"Running: curl -sSLo config.txt ${CONFIG_LINK}\\n\"\r\ncurl -sSLo config.txt ${CONFIG_LINK}\r\n\r\n[ ! -d Playlists ] \u0026\u0026 mkdir Playlists\r\ncd Playlists\r\nif [ -f example_playlist.txt ]; then\r\n echo -e \"example_playlist.txt already exists. Skipping default download.\"\r\nelse\r\n echo -e \"example_playlist.txt not found. Downloading default example_playlist...\"\r\n echo -e \"Running: curl -sSLo example_playlist.txt ${PLAYLIST_LINK}\"\r\n curl -sSLo example_playlist.txt ${PLAYLIST_LINK}\r\nfi\r\n\r\necho -e \"\\nJMusicBot Successfully Installed!\"" + } + }, + "variables": [ + { + "name": "[REQUIRED] Discord Bot Token", + "description": "The token for your Discord bot. Learn how to obtain a token and configure your bot application properly here: https://jmusicbot.com/getting-a-bot-token/", + "env_variable": "BOT_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "[REQUIRED] Bot Owner ID", + "description": "This is the Discord User ID of the bot owner. Learn how to obtain this ID here: https://jmusicbot.com/finding-your-user-id/", + "env_variable": "BOT_OWNER", + "default_value": "Change This To Your Discord User ID", + "user_viewable": true, + "user_editable": true, + "rules": "required|digits_between:17,18", + "field_type": "text" + }, + { + "name": "Bot Prefix", + "description": "This sets the prefix for the bot. The prefix is used to control the commands. If you use !, the play command will be !play. If you do not set this, the prefix will be a mention of the bot (@Botname play).", + "env_variable": "BOT_PREFIX", + "default_value": "@mention", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:20", + "field_type": "text" + }, + { + "name": "Bot Alternate Prefix", + "description": "If you set this, the bot will also use this prefix in addition to \"Bot Prefix\". Set to NONE to not have an alternate prefix.", + "env_variable": "BOT_ALT_PREFIX", + "default_value": "NONE", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Bot Default Game", + "description": "If you change this, it modifies the default game of the bot. Set this to NONE to have no game. Set this to DEFAULT to use the default game. You can make the game \"Playing X\", \"Listening to X\", or \"Watching X\" where X is the title. If you don't include an action, it will use the default of \"Playing\".", + "env_variable": "BOT_GAME", + "default_value": "DEFAULT", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:20", + "field_type": "text" + }, + { + "name": "Bot Default Status", + "description": "[ Accepted Values: ONLINE IDLE DND INVISIBLE ] Will modify the default status of bot.", + "env_variable": "BOT_STATUS", + "default_value": "ONLINE", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:ONLINE,IDLE,DND,INVISIBLE", + "field_type": "text" + }, + { + "name": "Bot Show Song in Status", + "description": "If you set this to true, the bot will list the title of the song it is currently playing in its \"Playing\" status. NOTE: This will ONLY work if the bot is playing music on ONE Discord server; if the bot is playing in multiple servers, this will not work!", + "env_variable": "BOT_SONG_STATUS", + "default_value": "false", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false", + "field_type": "text" + }, + { + "name": "Bot Show Images for \"Now Playing\"", + "description": "If set to true, the \"nowplaying\" command will show YouTube thumbnails. NOTE: If you set this to true, the nowplaying boxes will NOT refresh. This is because refreshing the boxes causes the image to be reloaded every time it refreshes.", + "env_variable": "BOT_NPIMAGES", + "default_value": "false", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false", + "field_type": "text" + }, + { + "name": "Bot Stay In Channel", + "description": "If set to true, the bot will not leave a voice channel after it finishes a queue. Keep in mind that being connected to a voice channel uses additional bandwidth, so this option is not recommended if bandwidth is a concern.", + "env_variable": "BOT_STAY_IN_CHANNEL", + "default_value": "false", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:true,false", + "field_type": "text" + }, + { + "name": "Bot Alone Time Until Disconnect", + "description": "This sets the amount of seconds the bot will stay alone on a voice channel until it automatically leaves the voice channel and clears the queue. If not set or set to any number less than or equal to zero, the bot won't leave when alone.", + "env_variable": "BOT_ALONE_TIME", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer", + "field_type": "text" + }, + { + "name": "Bot Max Song Length", + "description": "This sets the maximum amount of seconds any track loaded can be. If not set or set to any number less than or equal to zero, there is no maximum time length. This time restriction applies to songs loaded from any source.", + "env_variable": "BOT_MAXTIME", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/jmusicbot/example_playlist.txt b/ptero_eggs/application/bots/discord/jmusicbot/example_playlist.txt new file mode 100644 index 0000000..226bb71 --- /dev/null +++ b/ptero_eggs/application/bots/discord/jmusicbot/example_playlist.txt @@ -0,0 +1,21 @@ +# This is an example playlist +# More information about playlists can be found here: https://jmusicbot.com/playlists/ +# Command to play this playlist: @Botname play playlist example_playlist +# A new playlist can be made by making a new file in this directory called: my_playlist_name.txt + +# The following line currently makes the playlist shuffle +# Remove this line entirely if you don't want shuffling +#shuffle + +# Search Examples: +ytsearch:gorillaz dare audio +scsearch:lights metrognome + +# Direct Link Example: +https://www.youtube.com/watch?v=dQw4w9WgXcQ + +# YouTube Playlist ID Example: +PLUib4KwT0DMJaPgg_nr1ia8FY5JcXksvb + +# Local File Example: +# /home/container/music/mysong.mp3 \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/muse/README.md b/ptero_eggs/application/bots/discord/muse/README.md new file mode 100644 index 0000000..0ffa88e --- /dev/null +++ b/ptero_eggs/application/bots/discord/muse/README.md @@ -0,0 +1,43 @@ +# Muse + +### Authors / Contributors + + + + + + + + +
+ +
TubaApollo + +
+ 💻 + 🔨 + 		+ +
Red-Thirten + +
+ 💻 + 💡 + 		+ +
QuintenQVD0 + +
+ 💻 + 💡 +
+ + + +## Their [Github](https://github.com/codetheweb/muse) + +Muse is a highly-opinionated midwestern self-hosted Discord music bot that doesn't suck. + +## Server Ports + +There are no ports required for the Muse bot diff --git a/ptero_eggs/application/bots/discord/muse/egg-muse.json b/ptero_eggs/application/bots/discord/muse/egg-muse.json new file mode 100644 index 0000000..12f4904 --- /dev/null +++ b/ptero_eggs/application/bots/discord/muse/egg-muse.json @@ -0,0 +1,92 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2025-03-23T10:31:57+00:00", + "name": "Muse", + "author": "hello@apollo.moe", + "description": "\ud83c\udfa7 a self-hosted midwestern Discord music bot that doesn't suck", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:nodejs_20": "ghcr.io\/ptero-eggs\/yolks:nodejs_20" + }, + "file_denylist": [], + "startup": "npm start", + "config": { + "files": "{\r\n \".env\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"DISCORD_TOKEN\": \"DISCORD_TOKEN={{env.discord_token}}\",\r\n \"DATA_DIR\": \"DATA_DIR={{env.data_dir}}\",\r\n \"YOUTUBE_API_KEY\": \"YOUTUBE_API_KEY={{env.api_key}}\",\r\n \"SPOTIFY_CLIENT_ID\": \"SPOTIFY_CLIENT_ID={{env.client_id}}\",\r\n \"SPOTIFY_CLIENT_SECRET\": \"SPOTIFY_CLIENT_SECRET={{env.client_secret}}\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"Running version \"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "## Credits: Red-Thirten (https:\/\/github.com\/lilkingjr1) for providing most of the installation script\r\napt-get update\r\napt-get install git curl jq -y python3 python3-pip make build-essential -qq\r\n\r\nGITHUB_PACKAGE=\"museofficial\/muse\"\r\n\r\n# Find GitHub download URL for Muse for specified version\r\nLATEST_JSON=$(curl --silent \"https:\/\/api.github.com\/repos\/${GITHUB_PACKAGE}\/releases\/latest\")\r\nRELEASES=$(curl --silent \"https:\/\/api.github.com\/repos\/${GITHUB_PACKAGE}\/releases\")\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq -r '.tarball_url')\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tarball_url')\r\n else\r\n echo -e \"Could not find version \\\"${VERSION}\\\" of Muse. Defaulting to latest release...\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq -r '.tarball_url')\r\n fi\r\nfi\r\n\r\n# Download Muse from GitHub & Extract\r\ncd \/mnt\/server\r\necho -e \"Downloading Muse from GitHub...\"\r\ncurl -L ${DOWNLOAD_URL} -o muse.tar.gz\r\necho -e \"Extracting Muse from tarball...\"\r\ntar -xvzf muse.tar.gz --strip-components=1\r\nrm muse.tar.gz\r\n\r\n# Verify and clean up Muse installation\r\nif [ ! -f .env.example ]; then\r\n echo -e \"\\nFailed to download release: ${DOWNLOAD_URL}\\n\"\r\n exit 1\r\nfi\r\ncp .env.example .env\r\nrm -rf .dockerignore Dockerfile .gitignore .github\/\r\nyarn install --prod #--frozen-lockfile\r\n#sed -i 's\/of filterWrapper[)]\/of filterWrapper|| [])\/g' \/mnt\/server\/node_modules\/ytsr\/lib\/utils.js\r\n\r\necho -e \"\\nMuse Successfully Installed!\"", + "container": "node:lts-bookworm-slim", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "TOKEN", + "description": "Discord Bot Token", + "env_variable": "discord_token", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Data directory", + "description": "Default: .\/data", + "env_variable": "data_dir", + "default_value": ".\/data", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "YouTube API Key", + "description": "You can get it here: https:\/\/console.developers.google.com\/", + "env_variable": "api_key", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Spotify Client ID", + "description": "You can get it here: https:\/\/developer.spotify.com\/dashboard\/applications", + "env_variable": "client_id", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Spotify Client Secret", + "description": "You can get it here: https:\/\/developer.spotify.com\/dashboard\/applications", + "env_variable": "client_secret", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Version", + "description": "Specify a version, for example: \"v2.4.1\"\r\nFor the latest version, type \"latest\"", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/parkertron/README.md b/ptero_eggs/application/bots/discord/parkertron/README.md new file mode 100644 index 0000000..24975d0 --- /dev/null +++ b/ptero_eggs/application/bots/discord/parkertron/README.md @@ -0,0 +1,11 @@ +# parkertron + +## Their [Github](https://github.com/parkervcp/parkertron) + +Purely a chatbot. Not even a smart one. + +Runs the Pterodactyl `@support bot` + +## Server Ports + +There are no ports required for parkertron diff --git a/ptero_eggs/application/bots/discord/parkertron/egg-parkertron.json b/ptero_eggs/application/bots/discord/parkertron/egg-parkertron.json new file mode 100644 index 0000000..b85f49c --- /dev/null +++ b/ptero_eggs/application/bots/discord/parkertron/egg-parkertron.json @@ -0,0 +1,31 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:04+00:00", + "name": "parkertron", + "author": "parker@parkervcp.com", + "description": "The stupid chatbot parkertron by Parkervcp.\r\n\r\nhttps://github.com/parkervcp/parkertron", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:bot_parkertron": "ghcr.io/ptero-eggs/yolks:bot_parkertron" + }, + "file_denylist": [], + "startup": "./parkertron", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Bot is now running\"\r\n}", + "stop": "shutdown" + }, + "scripts": { + "installation": { + "container": "golang:1.19-bookworm", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n# parkertron Installation Script\r\n#\r\n# Server Files: /mnt/server\r\nexport GOPATH=$HOME/go\r\nexport PATH=$GOROOT/bin:$GOPATH/bin:$PATH\r\n\r\ncd\r\n\r\napt update\r\n\r\napt install -y tesseract-ocr tesseract-ocr-eng libtesseract-dev\r\n\r\necho \"pulling the parkertron git repo\"\r\n\r\ngit clone https://github.com/parkervcp/parkertron.git\r\n\r\ncd parkertron/\r\n\r\necho \"building parkertron\"\r\n\r\ngo build \r\n\r\necho \"build complete copying parkertron and example configs over\"\r\n\r\ncp parkertron /mnt/server/\r\n\r\nif [ -d /mnt/server/configs ]; then\r\n echo \"Files exist already\"\r\nelse\r\n cp -r /root/parkertron/configs/ /mnt/server/\r\nfi\r\n\r\necho \"Install complete. If you watched this. Congrats.\"" + } + }, + "variables": [] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/pixelbot/README.md b/ptero_eggs/application/bots/discord/pixelbot/README.md new file mode 100644 index 0000000..99c9206 --- /dev/null +++ b/ptero_eggs/application/bots/discord/pixelbot/README.md @@ -0,0 +1,13 @@ +# pixelbot + +## Their [Github](https://github.com/possatti/pixelbot) + +Bot for pixelcanvas.io + +## Server Ports + +There are no ports required for pixelbot + +## Side notes + +This was to make sure the parkervcp/images:python 3 image worked. diff --git a/ptero_eggs/application/bots/discord/pixelbot/egg-pixel-bot.json b/ptero_eggs/application/bots/discord/pixelbot/egg-pixel-bot.json new file mode 100644 index 0000000..ce4f1e4 --- /dev/null +++ b/ptero_eggs/application/bots/discord/pixelbot/egg-pixel-bot.json @@ -0,0 +1,82 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:06+00:00", + "name": "pixel-bot", + "author": "parker@parkervcp.com", + "description": "A Discord bot written in Python using discord.py\r\n\r\nhttps://github.com/Ispira/pixel-bot", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:python_3.7": "ghcr.io/ptero-eggs/yolks:python_3.7" + }, + "file_denylist": [], + "startup": "/usr/local/bin/python bot.py", + "config": { + "files": "{\r\n \"config/config.json\": {\r\n \"parser\": \"json\",\r\n \"find\": {\r\n \"owner\": \"{{server.build.env.OWNER_UID}}\",\r\n \"token\": \"{{server.build.env.BOT_TOKEN}}\",\r\n \"bot_name\": \"{{server.build.env.BOT_NAME}}\",\r\n \"log_file\": \"latest.log\"\r\n }\r\n },\r\n \"plugins/settings/imgur.json\": {\r\n \"parser\": \"json\",\r\n \"find\": {\r\n \"client_id\": \"{{server.build.env.IMGUR_KEY}}\",\r\n \"client_secret\": \"{{server.build.env.IMGUR_SECRET}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Logged in as\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "python:3.7-alpine", + "entrypoint": "ash", + "script": "#!/bin/ash\r\n# Pixel Bot Installation Script\r\n#\r\n# Server Files: /mnt/server\r\napk add --no-cache git gcc g++ libffi-dev make\r\n\r\ncd /mnt/server\r\n\r\necho \"Cloning pixel-bot repo\"\r\ngit clone https://github.com/Ispira/pixel-bot.git .\r\n\r\necho \"Installing python requirements into folder\"\r\npip install -U --target $(pwd) discord imgurpython xkcd pynacl\r\n\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [ + { + "name": "Owner Discord UID", + "description": "The Discord UID of the bot owner.", + "env_variable": "OWNER_UID", + "default_value": "copy from discord", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:32", + "field_type": "text" + }, + { + "name": "Discord Bot Token", + "description": "Get the app token from https://discordapp.com/developers/applications/me", + "env_variable": "BOT_TOKEN", + "default_value": "get from discord developers", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:128", + "field_type": "text" + }, + { + "name": "Bot Name", + "description": "The name that you want set for the bot", + "env_variable": "BOT_NAME", + "default_value": "Ispyra", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Imgur API ID", + "description": "Add your Imgur API client_id if you want. \r\n\r\nhttps://api.imgur.com/oauth2/addclient", + "env_variable": "IMGUR_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:64", + "field_type": "text" + }, + { + "name": "Imgur Secret", + "description": "Add your Imgur API client_secret if you want. \r\n\r\nhttps://api.imgur.com/oauth2/addclient", + "env_variable": "IMGUR_SECRET", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/redbot/README.md b/ptero_eggs/application/bots/discord/redbot/README.md new file mode 100644 index 0000000..64a78c1 --- /dev/null +++ b/ptero_eggs/application/bots/discord/redbot/README.md @@ -0,0 +1,20 @@ +# Red-DiscordBot + +## From their [Github](https://github.com/Cog-Creators/Red-DiscordBot) + +A multifunction Discord bot + +## Server Ports + +No port are required to run Red. + +if you want to use the internal Lavalink Server, you need to allocate port 2333 as primary + +## Additional Requirements + +When using the Audio Cog the bot will attempt to save files to /tmp resulting in a disk space error. You may also see this same error when attempting to install a cog, due to pip using /tmp to build the requirements. To resolve this error you must increase the size of `tmpfs` using custom container policy. + +For additional details see: + + +### Mods/Plugins may require ports to be added to the server diff --git a/ptero_eggs/application/bots/discord/redbot/config.json b/ptero_eggs/application/bots/discord/redbot/config.json new file mode 100644 index 0000000..86b5e0a --- /dev/null +++ b/ptero_eggs/application/bots/discord/redbot/config.json @@ -0,0 +1,9 @@ +{ + "pterodactyl": { + "DATA_PATH": "/home/container/.local/share/Red-DiscordBot/data/pterodactyl", + "COG_PATH_APPEND": "cogs", + "CORE_PATH_APPEND": "core", + "STORAGE_TYPE": "JSON", + "STORAGE_DETAILS": {} + } +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/redbot/egg-red.json b/ptero_eggs/application/bots/discord/redbot/egg-red.json new file mode 100644 index 0000000..da07b93 --- /dev/null +++ b/ptero_eggs/application/bots/discord/redbot/egg-red.json @@ -0,0 +1,62 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2025-09-14T09:33:41+00:00", + "name": "Red", + "author": "parker@parkervcp.com", + "description": "A multifunction Discord bot \r\n\r\nhttps:\/\/github.com\/Cog-Creators\/Red-DiscordBot", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:bot_red": "ghcr.io\/ptero-eggs\/yolks:bot_red" + }, + "file_denylist": [], + "startup": "PATH=$PATH:\/home\/container\/.local\/bin redbot pterodactyl --token {{TOKEN}} --prefix {{PREFIX}}", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Invite URL:\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "python:3.11-slim", + "entrypoint": "bash", + "script": "#!\/bin\/bash\r\n# red-discordbot install script\r\n\r\n## install deps\r\nmkdir -p \/usr\/share\/man\/man1\r\napt update\r\napt -y install git ca-certificates dnsutils iproute2 make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev libgdbm-dev uuid-dev git\r\n\r\n## config folder layouts\r\necho -e \"generating config folder layout\"\r\nmkdir -p \/mnt\/server\/.config\/{Red-DiscordBot,share}\/ \/mnt\/server\/.local\/share\/Red-DiscordBot\/data\/pterodactyl\/\r\ncd \/mnt\/server\/\r\nln -s .local\/share\/Red-DiscordBot\/data\/pterodactyl\/ .\/configs\r\n\r\n## install red\r\necho -e \"add container user to install\"\r\nln -s \/mnt\/server\/ \/home\/container\r\nuseradd -m -d \/home\/container container\r\nchown -R container \/mnt\/server\/\r\necho -e \"install red locally as user\"\r\npip install --upgrade pip\r\nsu - container -c 'pip install -U pip wheel --no-warn-script-location'\r\nsu - container -c 'pip install -U Red-DiscordBot --no-warn-script-location'\r\n\r\n## ensure the config is in place if it doesn't exist\r\nif [ ! -f \/mnt\/server\/.config\/Red-DiscordBot\/config.json ]; then\r\n curl https:\/\/raw.githubusercontent.com\/ptero-eggs\/application-eggs\/main\/bots\/discord\/redbot\/config.json -o \/mnt\/server\/.config\/Red-DiscordBot\/config.json\r\nfi\r\n\r\necho \"-------------------------------------------------------\"\r\necho \"Installation completed\"\r\necho \"-------------------------------------------------------\"" + } + }, + "variables": [ + { + "name": "Discord Bot Token", + "description": "Get your own token here - https:\/\/discordapp.com\/developers\/applications\/", + "env_variable": "TOKEN", + "default_value": "GET_YOUR_OWN", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Command Prefix", + "description": "The prefix for commands from the bot.", + "env_variable": "PREFIX", + "default_value": ".", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Owner", + "description": "Owner of the Bot to use special commands", + "env_variable": "OWNER", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:30", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/ree6/README.md b/ptero_eggs/application/bots/discord/ree6/README.md new file mode 100644 index 0000000..6b4a3a0 --- /dev/null +++ b/ptero_eggs/application/bots/discord/ree6/README.md @@ -0,0 +1,73 @@ +# Ree6 + +___ + +## Authors / Contributors + + + + + + + + + +
+ +
Presti + +
+ 💻 + 🤖 + 		+ +
parkervcp + +
+ 💻 + 🥚 + 		+ +
QuintenQVD0 + +
+ 💻 +
+ + + +___ + +## Bot Description & Features + +From the developer's [Github](https://github.com/Ree6-Applications/Ree6): +> Ree6 is an all-in-one Discord Bot maintained by Presti, which started as an alternative of Mee6 to provide a lot of features that are hidden behind a paywall or subscription. + +- Contains almost every feature Mee6 has. +- Has a open Source Webinterface. +- Provides advanced Audit-Logging. +- Has built in post notifications (Twitter, Instagram, YouTube, Reddit and Twitch). +- Built-in simple Ticket System. +- And more! +___ + +## Configuration + +- You will need to modify the config.yml to even start the bot. + +___ + +## Server Ports + +There are no ports required for Ree6. +___ + +## Updating + +Re-Installing the server via the panel will do the following: + +1. Update the bot to the latest version. + + +## API keys +This bot uses a lot of api keys. It will print some errors to the console if you don't have some filled in but the bot should still function as normal with the api keys you entered. \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/ree6/config.yml b/ptero_eggs/application/bots/discord/ree6/config.yml new file mode 100644 index 0000000..ba2240d --- /dev/null +++ b/ptero_eggs/application/bots/discord/ree6/config.yml @@ -0,0 +1,128 @@ +# ################################ +# # # +# # Ree6 Config File # +# # by Presti # +# # # +# ################################ +# + +# Do not change this! +config: + version: 3.0.0 + creation: 1686731674683 + +# HikariCP Configuration +hikari: + + # SQL Configuration + sql: + user: root + db: root + pw: yourpw + host: localhost + port: 3306 + + # Misc Configuration + misc: + storage: sqlite # Possible entries: sqlite, mariadb, postgresql, h2, h2-server + storageFile: storage/Ree6.db + createEmbeddedServer: false # Should an instance of an embedded Server be created? Only used for H2-Server. + poolSize: 10 + +# Discord Application and overall Bot Configuration, used for OAuth, Bot Authentication and customization. +bot: + tokens: + release: ReleaseTokenhere # Token used when set to release build. + beta: BetaTokenhere # Token used when set to beta build. + dev: DevTokenhere # Token used when set to dev build. + + # Configuration for the Bot itself. + misc: + status: ree6.de | %guilds% Servers. (%shard%) # The Status of the Bot. + feedbackChannelId: 0 # The Channel used for Feedback. + ownerId: # The ID of the Bot Owner. Change this to yours! + predefineInformation: | # Predefined Information for the AI. + You are Ree6 a Discord bot. + invite: https://invite.ree6.de # The Invite Link of the Bot. + support: https://support.ree6.de # The Support Server Link of the Bot. + github: https://github.ree6.de # The GitHub Link of the Bot. + website: https://ree6.de # The Website Link of the Bot. + webinterface: https://cp.ree6.de # The Webinterface Link of the Bot. + recording: https://cp.ree6.de/external/recording # The Recording Link of the Bot. + twitchAuth: https://cp.ree6.de/external/twitch # The Twitch Authentication Link of the Bot. + advertisement: powered by Tube-hosting # The Advertisement in Embed Footers and the rest. + name: Ree6 # The Name of the Bot. + shards: 1 # The shard amount of the Bot. Check out https://anidiots.guide/understanding/sharding/#sharding for more information. + + # Customize the active modules in Ree6. + modules: + moderation: true # Enable the moderation module. + music: true # Enable the music module. + fun: true # Enable the fun commands. + community: true # Enable the community commands. + economy: true # Enable the economy commands. + level: true # Enable the level module. + nsfw: true # Enable the nsfw module. + info: true # Enable the info commands. + hidden: true # Enable the hidden commands. + logging: true # Enable the logging module. + notifier: true # Enable the notifier module. + streamtools: true # Enable the Stream-tools module. + temporalvoice: true # Enable the Temporal-voice module. + tickets: true # Enable the Tickets module. + suggestions: true # Enable the suggestions module. + customcommands: true # Enable the custom Commands module. + customevents: true # Enable the custom Events module. + ai: true # Enable the AI module. + addons: false # Enable the Addons module. + news: true # Enable the news command/module. + games: true # Enable the Games module. + reactionroles: true # Enable the reaction-roles module. + slashcommands: true # Enable the slash-commands support. + messagecommands: true # Enable the message-commands support. + +# Heartbeat Configuration, for status reporting +heartbeat: + url: none # The URL to the Heartbeat-Server + interval: 60 + +dagpi: + apitoken: DAGPI.xyz API-Token # Your Dagpi.xyz API-Token, for tweet image generation! + +amari: + apitoken: Amari API-Token # Your Amari API-Token, for Amari Level imports! + +openai: + apiToken: OpenAI API-Token # Your OpenAI API-Token, for ChatGPT! + apiUrl: https://api.openai.com/v1/chat/completions # The URL to the OpenAI API. + model: gpt-3.5-turbo-0301 # The Model used for the OpenAI API. + +sentry: + dsn: yourSentryDSNHere # Your Sentry DSN, for error reporting! + +# Spotify Application Configuration, used to parse Spotify Tracks/Playlists to YouTube search queries. +spotify: + client: + id: yourspotifyclientid + secret: yourspotifyclientsecret + +# Twitch Application Configuration, used for the StreamTools and Twitch Notifications. +twitch: + client: + id: yourtwitchclientidhere + secret: yourtwitchclientsecrethere + +# Twitter Application Configuration, used for the Twitter Notifications. +twitter: + bearer: yourTwitterBearerToken + +# Reddit Application Configuration, used for the Reddit Notification. +reddit: + client: + id: yourredditclientid + secret: yourredditclientsecret + +# Instagram Application Configuration, used for the Instagram Notification. +instagram: + username: yourInstagramUsername + password: yourInstagramPassword diff --git a/ptero_eggs/application/bots/discord/ree6/egg-ree6.json b/ptero_eggs/application/bots/discord/ree6/egg-ree6.json new file mode 100644 index 0000000..06e406d --- /dev/null +++ b/ptero_eggs/application/bots/discord/ree6/egg-ree6.json @@ -0,0 +1,422 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:06+00:00", + "name": "Ree6", + "author": "presti@presti.me", + "description": "All-in-one, open source and 100% free Discord Bot!", + "features": null, + "docker_images": { + "Java_17": "ghcr.io/pterodactyl/yolks:java_17" + }, + "file_denylist": [], + "startup": "java -Dnogui=true -jar Ree6.jar", + "config": { + "files": "{\r\n \"config.yml\": {\r\n \"parser\": \"yaml\",\r\n \"find\": {\r\n \"hikari.sql.user\": \"{{server.build.env.DATABASE_USER}}\",\r\n \"hikari.sql.db\": \"{{server.build.env.DATABASE_DB}}\",\r\n \"hikari.sql.pw\": \"{{server.build.env.DATABASE_PW}}\",\r\n \"hikari.sql.host\": \"{{server.build.env.DATABASE_HOST}}\",\r\n \"hikari.sql.port\": \"{{server.build.env.DATABASE_PORT}}\",\r\n \"hikari.misc.storage\": \"{{server.build.env.DATABASE_TYP}}\",\r\n \"hikari.misc.storageFile\": \"{{server.build.env.DATABASE_FILE}}\",\r\n \"hikari.misc.poolSize\": \"{{server.build.env.DATABASE_POOL}}\",\r\n \"hikari.misc.createEmbeddedServer\": \"{{server.build.env.DATABASE_EMBEDDED}}\",\r\n \"heartbeat.url\": \"{{server.build.env.HEARTBEAT_URL}}\",\r\n \"heartbeat.interval\": \"{{server.build.env.HEARTBEAT_INTERVAL}}\",\r\n \"dagpi.apitoken\": \"{{server.build.env.DAGPI_TOKEN}}\",\r\n \"amari.apitoken\": \"{{server.build.env.AMARI_TOKEN}}\",\r\n \"sentry.dsn\": \"{{server.build.env.SENTRY_DSN}}\",\r\n \"spotify.client.id\": \"{{server.build.env.SPOTIFY_CLIENT_ID}}\",\r\n \"spotify.client.secret\": \"{{server.build.env.SPOTIFY_CLIENT_SECRET}}\",\r\n \"twitch.client.id\": \"{{server.build.env.TWITCH_CLIENT_ID}}\",\r\n \"twitch.client.secret\": \"{{server.build.env.TWITCH_CLIENT_SECRET}}\",\r\n \"twitter.consumer.key\": \"{{server.build.env.TWITTER_CONSUMER_ID}}\",\r\n \"twitter.consumer.secret\": \"{{server.build.env.TWITTER_CONSUMER_SECRET}}\",\r\n \"twitter.access.key\": \"{{server.build.env.TWITTER_ACCESS_ID}}\",\r\n \"twitter.access.secret\": \"{{server.build.env.TWITTER_ACCESS_SECRET}}\",\r\n \"reddit.client.id\": \"{{server.build.env.REDDIT_CLIENT_ID}}\",\r\n \"reddit.client.secret\": \"{{server.build.env.REDDIT_CLIENT_SECRET}}\",\r\n \"instagram.username\": \"{{server.build.env.INSTAGRAM_USERNAME}}\",\r\n \"instagram.password\": \"{{server.build.env.INSTAGRAM_PASSWORD}}\",\r\n \"bot.tokens.release\": \"{{server.build.env.BOT_TOKEN}}\",\r\n \"openai.apiToken\": \"{{server.build.env.AI_TOKEN}}\",\r\n \"openai.apiUrl\": \"{{server.build.env.AI_URL}}\",\r\n \"openai.model\": \"{{server.build.env.AI_MODEL}}\",\r\n \"bot.misc.status\": \"{{server.build.env.MISC_STATUS}}\",\r\n \"bot.misc.feedbackChannelId\": \"{{server.build.env.MISC_FEEDBACK}}\",\r\n \"bot.misc.ownerId\": \"{{server.build.env.MISC_OWNER}}\",\r\n \"bot.misc.predefineInformation\": \"{{server.build.env.MISC_PREDEF}}\",\r\n \"bot.misc.invite\": \"{{server.build.env.MISC_INVITE}}\",\r\n \"bot.misc.support\": \"{{server.build.env.MISC_SUPPORT}}\",\r\n \"bot.misc.website\": \"{{server.build.env.MISC_WEB}}\",\r\n \"bot.misc.webinterface\": \"{{server.build.env.MISC_INTERFACE}}\",\r\n \"bot.misc.recording\": \"{{server.build.env.MISC_RECORD}}\",\r\n \"bot.misc.twitchAuth\": \"{{server.build.env.MISC_TWITCH}}\",\r\n \"bot.misc.advertisement\": \"{{server.build.env.MISC_ADV}}\",\r\n \"bot.misc.name\": \"{{server.build.env.MISC_NAME}}\",\r\n \"bot.misc.shards\": \"{{server.build.env.MISC_SHARD}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Finished Loading\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n## this is a simple script to use the github API for release versions.\r\n## this requires the egg has a variable for GITHUB_PACKAGE and VERSION\r\n## this supports using oauth/personal access tokens via GITHUB_USER and GITHUB_OAUTH_TOKEN (both are required.)\r\n## if you are getting hit with GitHub API limit issues then you need to have the user and token set.\r\napt update\r\napt install -y jq curl\r\n\r\n\r\nCONFIG_LINK=\"https://raw.githubusercontent.com/ptero-eggs/application-eggs/main/bots/discord/ree6/config.yml\"\r\nLATEST_JSON=$(curl --silent \"https://api.github.com/repos/Ree6-Applications/Ree6/releases/latest\")\r\nRELEASES=$(curl --silent \"https://api.github.com/repos/Ree6-Applications/Ree6/releases\")\r\nMATCH=jar-with-dependencies.jar\r\n\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i \"${MATCH}\" | head -1 )\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i \"${MATCH}\" | head -1)\r\n else\r\n echo -e \"defaulting to latest release\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i *.jar)\r\n fi\r\nfi\r\n\r\n## Ree6 Setup\r\n[ ! -d /mnt/server ] \u0026\u0026 mkdir -p /mnt/server\r\n\r\nif [ ! -z \"${DOWNLOAD_URL}\" ]; then \r\n if curl --output /dev/null --silent --head --fail ${DOWNLOAD_URL}; then\r\n echo -e \"link is valid. setting download link to ${DOWNLOAD_URL}\"\r\n DOWNLOAD_LINK=${DOWNLOAD_URL}\r\n else \r\n echo -e \"link is invalid closing out\"\r\n exit 2\r\n fi\r\nfi\r\n\r\ncd /mnt/server\r\necho -e \"\\nInstalling/Updating Ree6...\\n\"\r\n\r\nif [ -f Ree6.jar ]; then\r\n echo -e \"Updating Ree6.jar to latest version...\"\r\n echo -e '\\t(Old version can be found at \"Ree6.jar-old\")'\r\n mv -f Ree6.jar Ree6.jar-old\r\nfi\r\n\r\necho -e \"Running: curl -sSL -o Ree6.jar ${DOWNLOAD_LINK}\\n\"\r\ncurl -sSL -o Ree6.jar ${DOWNLOAD_LINK}\r\n\r\nif [ -f config.yml ]; then\r\n echo -e \"Updating config.yml to latest version...\"\r\n echo -e '\\t(Old version can be found at \"config.yml-old\")'\r\n mv -f config.yml config.yml-old\r\nfi\r\n\r\necho -e \"Running: curl -sSL -o config.yml ${CONFIG_LINK}\\n\"\r\ncurl -sSL -o config.yml ${CONFIG_LINK}\r\n \r\n\r\necho -e \"\\nRee6 Successfully Installed!\"" + } + }, + "variables": [ + { + "name": "[REQUIRED] Discord Bot Token", + "description": "The token for your Discord bot. Learn how to obtain a token and configure your bot application properly here: https://jmusicbot.com/getting-a-bot-token/", + "env_variable": "BOT_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Dagpi token", + "description": "Your Dagpi.xyz API-Token, for tweet image generation!", + "env_variable": "DAGPI_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Sentry DSN", + "description": "Your Sentry DSN, for error reporting!", + "env_variable": "SENTRY_DSN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Spotify Client Id", + "description": "Spotify Application Configuration, used to parse Spotify Tracks/Playlists to YouTube search queries.", + "env_variable": "SPOTIFY_CLIENT_ID", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Spotify Client Secret", + "description": "Spotify Application Configuration, used to parse Spotify Tracks/Playlists to YouTube search queries.", + "env_variable": "SPOTIFY_CLIENT_SECRET", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Heartbeat Url", + "description": "The URL to the Heartbeat-Server", + "env_variable": "HEARTBEAT_URL", + "default_value": "none", + "user_viewable": true, + "user_editable": true, + "rules": "string", + "field_type": "text" + }, + { + "name": "Heartbeat Interval", + "description": "The interval between the heartbeats.", + "env_variable": "HEARTBEAT_INTERVAL", + "default_value": "60", + "user_viewable": true, + "user_editable": true, + "rules": "integer", + "field_type": "text" + }, + { + "name": "Amari Token", + "description": "Your Amari API-Token, for Amari Level imports!", + "env_variable": "AMARI_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Twitch Client Id", + "description": "Twitch Application Configuration, used for the StreamTools and Twitch Notifications.", + "env_variable": "TWITCH_CLIENT_ID", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Twitch Client Secret", + "description": "Twitch Application Configuration, used for the StreamTools and Twitch Notifications.", + "env_variable": "TWITCH_CLIENT_SECRET", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Twitter Bearer Key", + "description": "Twitter Application Configuration, used for the Twitter Notifications.", + "env_variable": "TWITTER_BEARER", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Reddit Client Id", + "description": "Reddit Application Configuration, used for the Reddit Notification.", + "env_variable": "REDDIT_CLIENT_ID", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Reddit Client Secret", + "description": "Reddit Application Configuration, used for the Reddit Notification.", + "env_variable": "REDDIT_CLIENT_SECRET", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Instagram Username", + "description": "Instagram Application Configuration, used for the Instagram Notification.", + "env_variable": "INSTAGRAM_USERNAME", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Instagram Password", + "description": "Instagram Application Configuration, used for the Instagram Notification.", + "env_variable": "INSTAGRAM_PASSWORD", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "SQL Username", + "description": "Username for the SQL connection.", + "env_variable": "DATABASE_USER", + "default_value": "root", + "user_viewable": true, + "user_editable": true, + "rules": "string|max:32", + "field_type": "text" + }, + { + "name": "SQL Database", + "description": "Database for the SQL Connection", + "env_variable": "DATABASE_DB", + "default_value": "root", + "user_viewable": true, + "user_editable": true, + "rules": "string|max:64", + "field_type": "text" + }, + { + "name": "SQL Password", + "description": "Password for the SQL connection.", + "env_variable": "DATABASE_PW", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "SQL Port", + "description": "Port for the SQL connection.", + "env_variable": "DATABASE_PORT", + "default_value": "3306", + "user_viewable": true, + "user_editable": true, + "rules": "integer", + "field_type": "text" + }, + { + "name": "Database Typ", + "description": "The Typ of the Database Ree6 should use!\r\nPossible typs:\r\n- mariadb\r\n- sqlite\r\n- h2\r\n- postgres", + "env_variable": "DATABASE_TYP", + "default_value": "sqlite", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:mariadb,sqlite,postgres,postregsql,h2", + "field_type": "text" + }, + { + "name": "Database Storagefile", + "description": "The location of the storagefile if sqlite is being used.", + "env_variable": "DATABASE_FILE", + "default_value": "storage/Ree6.db", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:32", + "field_type": "text" + }, + { + "name": "[DEVELOPER-STUFF] Database Poolsize", + "description": "The Database connection pool size!", + "env_variable": "DATABASE_POOL", + "default_value": "10", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer", + "field_type": "text" + }, + { + "name": "Database host", + "description": "The Host address of the Database connection.", + "env_variable": "DATABASE_HOST", + "default_value": "localhost", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "OpenAI Token", + "description": "Your Authentication token that should be used in the AI API calls.", + "env_variable": "AI_TOKEN", + "default_value": "OpenAI API-Token", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "OpenAI Url", + "description": "The URL that should receive the API calls.", + "env_variable": "AI_URL", + "default_value": "https://api.openai.com/v1/chat/completions", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "OpenAI Model", + "description": "The AI model that should be used in the API calls.", + "env_variable": "AI_MODEL", + "default_value": "gpt-3.5-turbo-0301", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:32", + "field_type": "text" + }, + { + "name": "Activity Status", + "description": "The Activity status of the Bot that will be shown.", + "env_variable": "MISC_STATUS", + "default_value": "ree6.de | %guilds% Servers. (%shard%)", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Feedback Channel", + "description": "The Channel Id of the Feedback channel.", + "env_variable": "MISC_FEEDBACK", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "integer", + "field_type": "text" + }, + { + "name": "[DEVELOPER-STUFF] Bot Owner Id", + "description": "The ID of the Bot Owner, this will be used internally on some checks.", + "env_variable": "MISC_OWNER", + "default_value": "321580743488831490", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer", + "field_type": "text" + }, + { + "name": "Invite Link", + "description": "The Invite link to invite the Bot.", + "env_variable": "MISC_INVITE", + "default_value": "https://invite.ree6.de", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Predefined Information for AI", + "description": "The Information for the AI.", + "env_variable": "MISC_PREDEF", + "default_value": "You are Ree6 a Discord bot.", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Support Link", + "description": "The Url link for users to receive support.", + "env_variable": "MISC_SUPPORT", + "default_value": "https://support.ree6.de", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Website", + "description": "The Url to the Website of the Bot.", + "env_variable": "MISC_WEB", + "default_value": "https://ree6.de", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Webinterface", + "description": "The Url to the Webinterface.", + "env_variable": "MISC_INTERFACE", + "default_value": "https://cp.ree6.de", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Record Url", + "description": "The Url that uses can access to get their recording.", + "env_variable": "MISC_RECORD", + "default_value": "https://cp.ree6.de/external/recording", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Twitch Url", + "description": "The Url used to connect a Twitch Account with the Ree6 System.", + "env_variable": "MISC_TWITCH", + "default_value": "https://cp.ree6.de/external/twitch", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Advertisment", + "description": "The Advertisement in Embed Footers and the rest.", + "env_variable": "MISC_ADV", + "default_value": "powered by Tube-hosting", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:128", + "field_type": "text" + }, + { + "name": "Name", + "description": "The Name of the Bot.", + "env_variable": "MISC_NAME", + "default_value": "Ree6", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Shards", + "description": "The amount of shards that should be created.", + "env_variable": "MISC_SHARD", + "default_value": "1", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/discord/sinusbot/README.md b/ptero_eggs/application/bots/discord/sinusbot/README.md new file mode 100644 index 0000000..532de01 --- /dev/null +++ b/ptero_eggs/application/bots/discord/sinusbot/README.md @@ -0,0 +1,24 @@ +# SinusBot + +## Their [Site](https://www.sinusbot.com/) + +Listen to your favorite music together with all of your friends + +Welcome the Simple, Elegant & great sounding TS3- and Discord-Bot! + +## First startup + +On first startup wait until this message in the console appears: `TSClient quit.` Then press restart. +Now the SinusBot will fully startup and you can login to the WebUI. + +## Server Ports + +1 port is required to run SinusBot. + +| Port | default | +|---------|---------| +| Game | 8087 | + +## Side notes + +This uses a custom image. diff --git a/ptero_eggs/application/bots/discord/sinusbot/egg-sinusbot.json b/ptero_eggs/application/bots/discord/sinusbot/egg-sinusbot.json new file mode 100644 index 0000000..f9f809c --- /dev/null +++ b/ptero_eggs/application/bots/discord/sinusbot/egg-sinusbot.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:07+00:00", + "name": "Sinusbot", + "author": "support@pterodactyl.io", + "description": "Musicbot for Discord and Teamspeak.", + "features": null, + "docker_images": { + "sinusbot": "ghcr.io/ptero-eggs/yolks:bot_sinusbot" + }, + "file_denylist": [], + "startup": "./sinusbot --override-password=\"${OVERRIDE_PASSWORD}\"", + "config": { + "files": "{\r\n \"config.ini\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"ListenPort\": \"ListenPort = {{server.build.default.port}}\",\r\n \"ListenHost\": \"ListenHost = \\\"0.0.0.0\\\"\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Initialization complete\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n# Sinusbot Installation Script\r\n#\r\n# Server Files: /mnt/server\r\napt -y update\r\napt -y --no-install-recommends install ca-certificates bzip2 wget tar curl jq\r\napt -q clean all\r\n\r\n#Create needed directories\r\nmkdir -p /mnt/server/TeamSpeak3-Client-linux_amd64/plugins\r\nmkdir /mnt/server/youtube-dlp\r\n\r\ncd /mnt/server\r\n\r\n#Download Sinusbot\r\nwget -qO - https://www.sinusbot.com/dl/sinusbot.current.tar.bz2 | tar xj\r\n\r\n\r\n#Download Latest TeamSpeak Client\r\n#TS_VERSION=$(curl https://teamspeak.com/versions/client.json | jq -r '.linux.x86_64.version')\r\n#TS_DL_LINK=$(curl https://teamspeak.com/versions/client.json | jq -r '.linux.x86_64.mirrors.\"teamspeak.com\"')\r\n\r\n# Sinusbot is not yet updated...\r\nTS_VERSION=3.5.6\r\nTS_DL_LINK=https://files.teamspeak-services.com/releases/client/3.5.6/TeamSpeak3-Client-linux_amd64-3.5.6.run\r\n\r\necho -e \"downloading teamspeak version ${TS_VERSION}\"\r\necho -e \"running 'wget ${TS_DL_LINK}'\"\r\n\r\nwget ${TS_DL_LINK}\r\n\r\n# Install TeamSpeak Client\r\nchmod 0755 TeamSpeak3-Client-linux_amd64*.run\r\n./TeamSpeak3-Client-linux_amd64*.run --tar xfv -C TeamSpeak3-Client-linux_amd64\r\n\r\n## Cleaning up \r\n\r\nrm TeamSpeak3-Client-linux_amd64*.run\r\n# Remove glx-integration lib\r\nrm TeamSpeak3-Client-linux_amd64/xcbglintegrations/libqxcb-glx-integration.so\r\n\r\n#Install Sinusbot\r\nchmod +x sinusbot\r\ncp config.ini.dist config.ini\r\nsed -i \"s|^TS3Path.*|TS3Path = \\\"/home/container/TeamSpeak3-Client-linux_amd64/ts3client_linux_amd64\\\"|g\" config.ini\r\necho 'YoutubeDLPath = \"/home/container/youtube-dlp/youtube-dlp\"' \u003e\u003e config.ini\r\n\r\n#Install Sinusbot plugin\r\ncp plugin/libsoundbot_plugin.so TeamSpeak3-Client-linux_amd64/plugins\r\n\r\n#Download youtube-dlp\r\ncd /mnt/server/youtube-dlp\r\nwget https://github.com/yt-dlp/yt-dlp/releases/latest/download/yt-dlp -O youtube-dlp\r\nchmod a+rx youtube-dlp\r\n\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [ + { + "name": "Password", + "description": "Password for admin account.", + "env_variable": "OVERRIDE_PASSWORD", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/other/bigbrotherbot/README.md b/ptero_eggs/application/bots/other/bigbrotherbot/README.md new file mode 100644 index 0000000..27580e6 --- /dev/null +++ b/ptero_eggs/application/bots/other/bigbrotherbot/README.md @@ -0,0 +1,11 @@ +# Big Brother Bot + +## From their [Github](https://github.com/BigBrotherBot/big-brother-bot) + +Big Brother Bot B3 is a complete and total server administration package for online games. B3 is designed primarily to keep your server free from the derelicts of online gaming, but offers more, much more + +## Server Ports + +No ports are required to run Big Brother Bot. You can assign a random port to the bot. + +### Mods/Plugins may require ports to be added to the server diff --git a/ptero_eggs/application/bots/other/bigbrotherbot/egg-big-brother-bot.json b/ptero_eggs/application/bots/other/bigbrotherbot/egg-big-brother-bot.json new file mode 100644 index 0000000..9dadfcf --- /dev/null +++ b/ptero_eggs/application/bots/other/bigbrotherbot/egg-big-brother-bot.json @@ -0,0 +1,31 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:11+00:00", + "name": "Big Brother Bot", + "author": "parker@parkervcp.com", + "description": "Big Brother Bot B3 is a complete and total server administration package for online games. B3 is designed primarily to keep your server free from the derelicts of online gaming, but offers more, much more.\r\n\r\nhttps://github.com/BigBrotherBot/big-brother-bot", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:python_2.7": "ghcr.io/ptero-eggs/yolks:python_2.7" + }, + "file_denylist": [], + "startup": "python b3_run.py", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"No idea what to put here\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "python:2.7-slim", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n# Pixel Bot Installation Script\r\n#\r\n# Server Files: /mnt/server\r\napt update\r\napt -y install git\r\n\r\ncd /mnt/server\r\n\r\necho \"Cloning pixel-bot repo\"\r\ngit clone https://github.com/BigBrotherBot/big-brother-bot.git .\r\n\r\necho \"Installing python requirements into folder\"\r\npip install -U --target /mnt/server -r requirements.txt\r\npip install -U --target /mnt/server paramiko\r\n\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/teamspeak3/README.md b/ptero_eggs/application/bots/teamspeak3/README.md new file mode 100644 index 0000000..f6362c2 --- /dev/null +++ b/ptero_eggs/application/bots/teamspeak3/README.md @@ -0,0 +1,8 @@ +# TeamSpeak3 Bots + +## Some of these bots support other services but are primarily TeamSpeak3 bots + +### [JTS3ServerMod](jts3servermod) + +[JTS3ServerMod](https://www.stefan1200.de/forum/index.php?topic=2.0) +Please Check their site for an in depth on the bot. diff --git a/ptero_eggs/application/bots/teamspeak3/jts3servermod/egg-j-t-s3-server-mod.json b/ptero_eggs/application/bots/teamspeak3/jts3servermod/egg-j-t-s3-server-mod.json new file mode 100644 index 0000000..ed2fabf --- /dev/null +++ b/ptero_eggs/application/bots/teamspeak3/jts3servermod/egg-j-t-s3-server-mod.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:16+00:00", + "name": "JTS3ServerMod", + "author": "teamwuffy@gmail.com", + "description": "Setup:\r\n- Install the latest version\r\n- Go into config/server1 and edit JTS3ServerMod_server.cfg\r\n- Save and start the server\r\n\r\nAuthor: https://www.stefan1200.de/forum/index.php?topic=2.0", + "features": null, + "docker_images": { + "ghcr.io/pterodactyl/yolks:java_8": "ghcr.io/pterodactyl/yolks:java_8" + }, + "file_denylist": [], + "startup": "java -Xms128M -Xmx{{SERVER_MEMORY}}M -jar JTS3ServerMod.jar", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Successful connected to \"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n# JTS3ServerMod\r\n#\r\n# Server Files: /mnt/server\r\n# All required packages are installed in the used install image ghcr.io/ptero-eggs/installers:debian\r\n\r\nexport HOME=/mnt/server\r\nmkdir -p /mnt/server\r\ncd /mnt/server\r\n\r\nif [ -z \"$SERVER_VERSION\" ] || [ \"$SERVER_VERSION\" == \"latest\" ]; then\r\n echo -e \"Downloading latest version with curl -L \"https://www.stefan1200.de/dlrequest.php?file=jts3servermod \u0026\r\n type=.zip\" -o JTS3ServerMod.zip\"\r\n curl -L \"https://www.stefan1200.de/dlrequest.php?file=jts3servermod\u0026type=.zip\" -o JTS3ServerMod.zip\r\nelse\r\n echo -e \"running curl -L \"https://www.stefan1200.de/downloads/JTS3ServerMod_$SERVER_VERSION.zip\" -o JTS3ServerMod.zip\"\r\n curl -L \"https://www.stefan1200.de/downloads/JTS3ServerMod_$SERVER_VERSION.zip\" -o JTS3ServerMod.zip\r\nfi\r\n\r\n# no need to continue if we don't have an archive\r\nif [ ! -f JTS3ServerMod.zip ]; then\r\n echo \"JTS3ServerMod.zip not found. Something went wrong. Exiting\"\r\n exit 2\r\nfi\r\n\r\nunzip JTS3ServerMod.zip\r\nrm JTS3ServerMod.zip JTS3ServerMod-Windows.exe JTS3ServerMod-Windows_NoWindow.exe jts3servermod_startscript.sh\r\necho -e \"Installation completed.\\nConfiguration of the server must be done in the config folder to proceed.\"" + } + }, + "variables": [ + { + "name": "Version", + "description": "Version to download. Use latest to install latest version", + "env_variable": "SERVER_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/twitch/README.md b/ptero_eggs/application/bots/twitch/README.md new file mode 100644 index 0000000..365ec89 --- /dev/null +++ b/ptero_eggs/application/bots/twitch/README.md @@ -0,0 +1,15 @@ +# Twitch Bots + +## Some of these bots support other services but are primarily Twitch bots + +### [PhantomBot](phantombot) + +[Website](https://phantombot.github.io/PhantomBot/) +[GitHub](https://github.com/phantombot/PhantomBot) +PhantomBot is an actively developed open source interactive Twitch bot with a vibrant community that provides entertainment and moderation for your channel, allowing you to focus on what matters the most to you - your game and your viewers. + +### [SogeBot](sogebot) + +[Website](https://sogebot.xyz) +[GitHub](https://github.com/sogebot/sogeBot) +Free Twitch Bot built on Node.js diff --git a/ptero_eggs/application/bots/twitch/phantombot/README.md b/ptero_eggs/application/bots/twitch/phantombot/README.md new file mode 100644 index 0000000..edec9bf --- /dev/null +++ b/ptero_eggs/application/bots/twitch/phantombot/README.md @@ -0,0 +1,13 @@ +# PhantomBot + +[Website](https://phantombot.dev/) +[GitHub](https://github.com/phantombot/PhantomBot) +PhantomBot is an actively developed open source interactive Twitch bot with a vibrant community that provides entertainment and moderation for your channel, allowing you to focus on what matters the most to you - your game and your viewers. + +## Server Ports + +1 port is required to run PhantomBot. + +| Port | default | +|---------------------|---------| +| Web UI (HTTP Server)| 25000 | diff --git a/ptero_eggs/application/bots/twitch/phantombot/egg-phantom-bot.json b/ptero_eggs/application/bots/twitch/phantombot/egg-phantom-bot.json new file mode 100644 index 0000000..9f56e06 --- /dev/null +++ b/ptero_eggs/application/bots/twitch/phantombot/egg-phantom-bot.json @@ -0,0 +1,113 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:04+00:00", + "name": "PhantomBot", + "author": "mail@wuffy.eu", + "description": "PhantomBot is an actively developed open source interactive Twitch bot with a vibrant community that provides entertainment and moderation for your channel, allowing you to focus on what matters the most to you - your game and your viewers.", + "features": null, + "docker_images": { + "Java 16 [DEPRECATED]": "ghcr.io/ptero-eggs/yolks:java_16", + "Java 19": "ghcr.io/ptero-eggs/yolks:java_19" + }, + "file_denylist": [], + "startup": "java --add-opens java.base/java.lang=ALL-UNNAMED -Djava.security.policy=config/security -Dinteractive -Xms1m -Dfile.encoding=UTF-8 -jar PhantomBot.jar", + "config": { + "files": "{\r\n \"config/botlogin.txt\": {\r\n \"parser\": \"properties\",\r\n \"find\": {\r\n \"baseport\": \"{{server.build.default.port}}\",\r\n \"channel\": \"{{server.build.env.CHANNEL_NAME}}\",\r\n \"owner\": \"{{server.build.env.CHANNEL_OWNER}}\",\r\n \"paneluser\": \"{{server.build.env.WEBPANEL_USERNAME}}\",\r\n \"panelpassword\": \"{{server.build.env.WEBPANEL_PASSWORD}}\",\r\n \"user\": \"{{server.build.env.BOT_TWITCH_USERNAME}}\",\r\n \"youtubekey\": \"{{server.build.env.YOUTUBE_API_KEY}}\",\r\n \"discord_token\": \"{{server.build.env.DISCORD_BOT_TOKEN}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Joined \"\r\n}", + "stop": "exit" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n# PhantomBot Installation Script\r\n#\r\n# Server Files: /mnt/server\r\napt update\r\napt -y --no-install-recommends install curl wget ca-certificates unzip\r\n\r\ncd /tmp\r\n\r\n# Fetching latest github release\r\nif [ -z \"${RELEASE_VERSION}\" ] || [ \"${RELEASE_VERSION}\" == \"master\" ]; then\r\n echo -e \"Using latest Github Master version\"\r\n DOWNLOAD_URL=https://raw.githubusercontent.com/PhantomBot/nightly-build/master/PhantomBot-nightly-lin.zip\r\nelse\r\n if [ -z \"${RELEASE_VERSION}\" ] || [ \"${RELEASE_VERSION}\" == \"latest\" ]; then\r\n echo -e \"Using latest release version\"\r\n RELEASE_VERSION=$(curl -s \"https://api.github.com/repos/PhantomBot/PhantomBot/releases/latest\" | grep -e '\"tag_name\"' | sed -E 's/.*\"([^\"]+)\".*/\\1/' | sed 's/^.//')\r\n fi\r\n DOWNLOAD_URL=https://github.com/PhantomBot/PhantomBot/releases/download/v${RELEASE_VERSION}/PhantomBot-${RELEASE_VERSION}-lin.zip\r\n echo -e \"${DOWNLOAD_URL}\"\r\nfi\r\n\r\n# Download files\r\ncd /mnt/server\r\nwget ${DOWNLOAD_URL} -O PhantomBot.zip\r\n\r\n# Unzip files and delete the archive\r\nunzip -o PhantomBot.zip\r\nrm PhantomBot.zip\r\n\r\n# Move unzipped files into the server folder and delete the folder \r\ncp -f -r ./PhantomBot-*/* /mnt/server/\r\nrm -rf PhantomBot-*/\r\n\r\n# Creating default config\r\nif [ ! -f /mnt/server/config/botlogin.txt ]; then\r\n echo -e \"Creating config/botlogin.txt\"\r\n cat \u003c\u003c EOF \u003e /mnt/server/config/botlogin.txt\r\n #PhantomBot Configuration File\r\n #\r\n # Here is a list wiht all config values:\r\n # https://community.phantom.bot/t/settings-for-botlogin-txt/78\r\n #\r\n apioauth=\r\n baseport=\r\n channel=\r\n oauth=\r\n owner=\r\n panelpassword=\r\n paneluser=\r\n user=\r\n youtubekey=\r\n discord_token=\r\nEOF\r\nfi\r\necho \"install finished\"" + } + }, + "variables": [ + { + "name": "Version", + "description": "latest = Latest Stable\r\nmaster = latest Github\r\n3.9.0.7 = Latest known working with Java 16", + "env_variable": "RELEASE_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:9", + "field_type": "text" + }, + { + "name": "Twitch Channel Name", + "description": "Enter the Twitch channel name where the bot will connect to", + "env_variable": "CHANNEL_NAME", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:26", + "field_type": "text" + }, + { + "name": "Channel Owner", + "description": "", + "env_variable": "CHANNEL_OWNER", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:26", + "field_type": "text" + }, + { + "name": "Bot Twitch Username", + "description": "Please enter the bot's Twitch username", + "env_variable": "BOT_TWITCH_USERNAME", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:26", + "field_type": "text" + }, + { + "name": "Webpanel Username", + "description": "Please enter a custom username for the web panel", + "env_variable": "WEBPANEL_USERNAME", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:64", + "field_type": "text" + }, + { + "name": "Webpanel Password", + "description": "Please enter a custom password for the web panel", + "env_variable": "WEBPANEL_PASSWORD", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:2000", + "field_type": "text" + }, + { + "name": "Youtube API Key", + "description": "https://phantombot.dev/guides/#guide=content/integrations/youtubesetup", + "env_variable": "YOUTUBE_API_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "max:128", + "field_type": "text" + }, + { + "name": "Discord Bot Token", + "description": "https://phantombot.dev/guides/#guide=content/integrations/discordintegrationsetup", + "env_variable": "DISCORD_BOT_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "max:128", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/bots/twitch/sogebot/README.md b/ptero_eggs/application/bots/twitch/sogebot/README.md new file mode 100644 index 0000000..02a1549 --- /dev/null +++ b/ptero_eggs/application/bots/twitch/sogebot/README.md @@ -0,0 +1,17 @@ +# SogeBot + +[Website](https://sogebot.xyz) +[GitHub](https://github.com/sogebot/sogeBot) +Free Twitch Bot built on Node.js + +## Server Ports + +1 port is required to run sogeBot. + +| Port | default | +|---------------------|---------| +| Game (HTTP Server) | 20000 | + +## NOTES + +The installation take a long time, because a lot of things must be compiled. It can take 5 or more minutes !!! diff --git a/ptero_eggs/application/bots/twitch/sogebot/egg-soge-bot.json b/ptero_eggs/application/bots/twitch/sogebot/egg-soge-bot.json new file mode 100644 index 0000000..a7e954c --- /dev/null +++ b/ptero_eggs/application/bots/twitch/sogebot/egg-soge-bot.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-01T19:44:08+00:00", + "name": "SogeBot", + "author": "eggs@goover.dev", + "description": "sogeBot - Free Twitch Bot built on Node.js https://sogebot.xyz/", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:nodejs_18": "ghcr.io/ptero-eggs/yolks:nodejs_18" + }, + "file_denylist": [], + "startup": "npm start", + "config": { + "files": "{\r\n \".env\": {\r\n \"parser\": \"properties\",\r\n \"find\": {\r\n \"PORT\": \"{{server.build.default.port}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"WebPanel is available at\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "node:18-bookworm-slim", + "entrypoint": "bash", + "script": "#/bin/bash\r\n# Installscript for sogeBot | Author: eggs@goover.dev\r\n\r\nexport DEBIAN_FRONTEND=noninteractive\r\n\r\napt -y update\r\napt install -y curl unzip jq python3 build-essential ca-certificates\r\n\r\nmkdir -p /mnt/server\r\ncd /mnt/server\r\nexport NODE_OPTIONS=--max-old-space-size=8192\r\nchown -R root:root /mnt\r\n\r\n#Backup database \u0026 config\r\nmkdir -p .backup\r\ncp -f .env /mnt/server/.backup\r\ncp -f sogebot.db /mnt/server/.backup\r\n\r\n#delete old dir's to prevent errors on update\r\nrm -fR dest\r\nrm -fR public\r\nrm -fR node-modules\r\nrm -fR tools\r\n\r\n## get release info and download links\r\nLATEST_JSON=$(curl --silent \"https://api.github.com/repos/sogebot/sogeBot/releases/latest\")\r\nRELEASES=$(curl --silent \"https://api.github.com/repos/sogebot/sogeBot/releases\")\r\nMATCH=sogeBot\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_LINK=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i ${MATCH})\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_LINK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i ${MATCH})\r\n else\r\n echo -e \"defaulting to latest release\"\r\n DOWNLOAD_LINK=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url)\r\n fi\r\nfi\r\n\r\necho -e \"Downloading from $DOWNLOAD_LINK\"\r\ncurl -sSL -o sogeBot.zip ${DOWNLOAD_LINK}\r\n\r\nunzip -o sogeBot.zip\r\nrm -rf sogeBot.zip\r\n\r\n\r\necho \"--------------------------------------------------------------------------\"\r\necho \"Installing dependencies, this will take some time so sit back and relax...\"\r\necho \"IGNORE WARNINGS. THESE ARE NOT ERRORS !!!\"\r\necho \"--------------------------------------------------------------------------\"\r\n\r\nnpm install -g npm@8\r\n\r\nnpm install --verbose --force\r\n\r\necho -e \"install completed\"\r\nexit 0" + } + }, + "variables": [ + { + "name": "Version", + "description": "Version to install. Latest will install the latest available version.", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/code-server/README.md b/ptero_eggs/application/code-server/README.md new file mode 100644 index 0000000..2665a78 --- /dev/null +++ b/ptero_eggs/application/code-server/README.md @@ -0,0 +1,13 @@ +# Code-Server + +## From the [Code-Server](https://github.com/cdr/code-server) GitHub + +Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser. + +### Server Ports + +Ports required to run the server in a table format. + +| Port | default | +| ---- | ------- | +| Game | 8080 | diff --git a/ptero_eggs/application/code-server/egg-code--server.json b/ptero_eggs/application/code-server/egg-code--server.json new file mode 100644 index 0000000..1dd830f --- /dev/null +++ b/ptero_eggs/application/code-server/egg-code--server.json @@ -0,0 +1,56 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:57+00:00", + "name": "Code-Server", + "author": "mario.franze@gmail.com", + "description": "Run VS Code on any machine anywhere and access it in the browser.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:nodejs_12": "ghcr.io/ptero-eggs/yolks:nodejs_12", + "ghcr.io/ptero-eggs/yolks:nodejs_14": "ghcr.io/ptero-eggs/yolks:nodejs_14", + "ghcr.io/ptero-eggs/yolks:nodejs_16": "ghcr.io/ptero-eggs/yolks:nodejs_16", + "ghcr.io/ptero-eggs/yolks:nodejs_17": "ghcr.io/ptero-eggs/yolks:nodejs_17", + "ghcr.io/ptero-eggs/yolks:nodejs_18": "ghcr.io/ptero-eggs/yolks:nodejs_18" + }, + "file_denylist": [], + "startup": "sh .local/lib/code-server-{{VERSION}}/bin/code-server", + "config": { + "files": "{\r\n \".config/code-server/config.yaml\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"password\": \"password: {{server.build.env.PASSWORD}}\",\r\n \"bind-addr\": \"bind-addr: 0.0.0.0:{{server.build.default.port}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"HTTP server listening on\"\r\n}", + "stop": "^^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "apt update\r\napt install -y curl jq\r\n\r\n\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] \u0026\u0026 echo \"amd64\" || echo \"arm64\")\r\nMATCH=linux-${ARCH}\r\n# Create initial directories\r\nmkdir -p /mnt/server\r\ncd /mnt/server\r\n\r\necho ${ARCH}\r\necho ${MATCH}\r\n# Create needed directories\r\nmkdir -p /mnt/server/.local/lib /mnt/server/.local/bin /mnt/server/.config/code-server /mnt/server/projects\r\n\r\n# Change permission of projects directory so it can be accessed by code-server\r\nchmod 777 /mnt/server/projects\r\ntouch \"/mnt/server/projects/PLACE YOUR PROJECTS HERE\"\r\n\r\n# Check for available versions. Defaults to latest if no valid version is found.\r\nLATEST_JSON=$(curl --silent \"https://api.github.com/repos/coder/code-server/releases/latest\")\r\nRELEASES=$(curl --silent \"https://api.github.com/repos/coder/code-server/releases\")\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i ${MATCH})\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"v${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"v${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"v${VERSION}\" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i ${MATCH})\r\n else\r\n echo -e \"defaulting to latest release\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url)\r\n fi\r\nfi\r\n\r\n# Download the given Version and extract it\r\necho \"Downloading $DOWNLOAD_URL\"\r\ncurl -fL $DOWNLOAD_URL | tar -C /mnt/server/.local/lib -xz\r\nmv /mnt/server/.local/lib/code-server-*linux-${ARCH} /mnt/server/.local/lib/code-server-${VERSION}\r\n\r\n\r\nPATH=\"/mnt/server/.local/bin:$PATH\"\r\necho \"password: changeme\r\nbind-addr: 0.0.0.0\r\nauth: password\r\ncert: false\" \u003e /mnt/server/.config/code-server/config.yaml\r\n\r\necho \"Install complete\"" + } + }, + "variables": [ + { + "name": "Password", + "description": "Password to login to your Code-Server instance", + "env_variable": "PASSWORD", + "default_value": "changeme", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:32", + "field_type": "text" + }, + { + "name": "Version", + "description": "Version for (re)installation such as 3.9.3. Defaults to latest version if no valid version is provided", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/nosql/mongodb/README.md b/ptero_eggs/application/database/nosql/mongodb/README.md new file mode 100644 index 0000000..3c734a5 --- /dev/null +++ b/ptero_eggs/application/database/nosql/mongodb/README.md @@ -0,0 +1,34 @@ +# MongoDB + +## From their [Website](https://www.mongodb.com/) + +MongoDB is a general purpose, document-based, distributed database built for modern application developers and for the cloud era. + +### MongoDB free monitoring. + +To disable the message about free monitoring you can run `db.disableFreeMonitoring()`. + +## Security + +**MongoDB 6+ eggs enable access control by default** in the `mongod.conf` file, meaning that even if people will be able to connect to your database as guests, [they will not be able to perform any operation, apart from nonhazardous commands](https://dba.stackexchange.com/a/292175) + +### Disabling authentication + +**If you know what you are doing** and want to explicitly disable access control, you can edit the following lines to your `mongod.conf` file: + +```yaml +security: + authorization: "disabled" +``` + +## Minimum RAM warning + +MongoDB requires approximately 1GB of RAM per 100,000 assets. If the system has to start swapping memory to disk, this will have a severely negative impact on performance, and should be avoided. + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Server | 27017 | diff --git a/ptero_eggs/application/database/nosql/mongodb/egg-mongo-d-b7.json b/ptero_eggs/application/database/nosql/mongodb/egg-mongo-d-b7.json new file mode 100644 index 0000000..a8f2310 --- /dev/null +++ b/ptero_eggs/application/database/nosql/mongodb/egg-mongo-d-b7.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": "2024-02-02T10:25:08+01:00", + "name": "MongoDB 7", + "author": "parker@parkervcp.com", + "description": "MongoDB Server is a general purpose, document-based, distributed database built for modern application developers and for the cloud era.", + "features": null, + "docker_images": { + "MongoDB_7": "ghcr.io\/ptero-eggs\/yolks:mongodb_7" + }, + "file_denylist": [], + "startup": "mongod --fork --dbpath \/home\/container\/mongodb\/ --port ${SERVER_PORT} --bind_ip 0.0.0.0 --logpath \/home\/container\/logs\/mongo.log -f \/home\/container\/mongod.conf; until nc -z -v -w5 127.0.0.1 ${SERVER_PORT}; do echo 'Waiting for mongodb connection...'; sleep 5; done; mongosh --username ${MONGO_USER} --password ${MONGO_USER_PASS} --host 127.0.0.1:${SERVER_PORT} && mongosh --eval \"db.getSiblingDB('admin').shutdownServer()\" 127.0.0.1:${SERVER_PORT}", + "config": { + "files": "{\r\n \"mongod.conf\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"#security:\": \"security: \\r\\n authorization: \\\"enabled\\\"\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"child process started successfully\"\r\n}", + "logs": "{}", + "stop": "exit" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash \r\nif [ ! -d \/mnt\/server\/ ]; then\r\n mkdir -p \/mnt\/server\/\r\nfi\r\n\r\ncd \/mnt\/server\/\r\n\r\ncp \/etc\/mongod.conf.orig \/mnt\/server\/mongod.conf\r\n\r\nmkdir mongodb logs\r\n\r\nmongod --port 27017 --dbpath \/mnt\/server\/mongodb\/ --logpath \/mnt\/server\/logs\/mongo.log --fork\r\n\r\nmongosh --eval \"db.getSiblingDB('admin').createUser({user: '${MONGO_USER}', pwd: '${MONGO_USER_PASS}', roles: ['root']})\"\r\n\r\nmongosh --eval \"db.getSiblingDB('admin').shutdownServer()\"\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"", + "container": "mongo:7-jammy", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Mongo Admin Username", + "description": "The MongoDB Admin user", + "env_variable": "MONGO_USER", + "default_value": "admin", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Mongo Admin Password", + "description": "", + "env_variable": "MONGO_USER_PASS", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/nosql/mongodb/egg-mongo-d-b8.json b/ptero_eggs/application/database/nosql/mongodb/egg-mongo-d-b8.json new file mode 100644 index 0000000..aa0caed --- /dev/null +++ b/ptero_eggs/application/database/nosql/mongodb/egg-mongo-d-b8.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": "2025-08-22T13:41:06+00:00", + "name": "MongoDB 8", + "author": "parker@parkervcp.com", + "description": "MongoDB Server is a general purpose, document-based, distributed database built for modern application developers and for the cloud era.", + "features": [], + "docker_images": { + "MongoDB_8": "ghcr.io\/ptero-eggs\/yolks:mongodb_8" + }, + "file_denylist": [], + "startup": "mongod --fork --dbpath \/home\/container\/mongodb\/ --port ${SERVER_PORT} --bind_ip 0.0.0.0 --logpath \/home\/container\/logs\/mongo.log -f \/home\/container\/mongod.conf; until nc -z -v -w5 127.0.0.1 ${SERVER_PORT}; do echo 'Waiting for mongodb connection...'; sleep 5; done; mongosh --username ${MONGO_USER} --password ${MONGO_USER_PASS} --host 127.0.0.1:${SERVER_PORT} && mongosh --username ${MONGO_USER} --password ${MONGO_USER_PASS} --host 127.0.0.1:${SERVER_PORT} --eval \"db.getSiblingDB('admin').shutdownServer()\"", + "config": { + "files": "{\r\n \"mongod.conf\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"#security:\": \"security: \\r\\n authorization: \\\"enabled\\\"\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"child process started successfully\"\r\n}", + "logs": "{}", + "stop": "exit" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash \r\nif [ ! -d \/mnt\/server\/ ]; then\r\n mkdir -p \/mnt\/server\/\r\nfi\r\n\r\ncd \/mnt\/server\/\r\n\r\ncp \/etc\/mongod.conf.orig \/mnt\/server\/mongod.conf\r\n\r\nmkdir mongodb logs\r\n\r\nmongod --port 27017 --dbpath \/mnt\/server\/mongodb\/ --logpath \/mnt\/server\/logs\/mongo.log --fork\r\n\r\nmongosh --eval \"db.getSiblingDB('admin').createUser({user: '${MONGO_USER}', pwd: '${MONGO_USER_PASS}', roles: ['root']})\"\r\n\r\nmongosh --eval \"db.getSiblingDB('admin').shutdownServer()\"\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"", + "container": "mongo:8-noble", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Mongo Admin Username", + "description": "The MongoDB Admin user", + "env_variable": "MONGO_USER", + "default_value": "admin", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Mongo Admin Password", + "description": "", + "env_variable": "MONGO_USER_PASS", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/nosql/rethinkdb/README.md b/ptero_eggs/application/database/nosql/rethinkdb/README.md new file mode 100644 index 0000000..601be96 --- /dev/null +++ b/ptero_eggs/application/database/nosql/rethinkdb/README.md @@ -0,0 +1,21 @@ +# Rethinkdb + +## [Website](https://rethinkdb.com/) + +The open-source database for the realtime web +## Notes + +- The web dashboard by default is disabled (remove the ` --no-http-admin` flag from startup to enable). +- It defaults bind to 0.0.0.0 what is all interfaces so it is public availble. +- On first start a admin pasword is randomly generated. + + +### Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| cluster | 25567 | +| driver | 25568 | +| http | 25569 | \ No newline at end of file diff --git a/ptero_eggs/application/database/nosql/rethinkdb/egg-rethinkdb.json b/ptero_eggs/application/database/nosql/rethinkdb/egg-rethinkdb.json new file mode 100644 index 0000000..f1f70e6 --- /dev/null +++ b/ptero_eggs/application/database/nosql/rethinkdb/egg-rethinkdb.json @@ -0,0 +1,62 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2024-04-02T14:35:12+02:00", + "name": "rethinkdb", + "author": "josdekurk@gmail.com", + "description": "The open-source database for the realtime web", + "features": null, + "docker_images": { + "Debian": "ghcr.io\/ptero-eggs\/yolks:debian" + }, + "file_denylist": [], + "startup": ".\/rethinkdb --bind 0.0.0.0 --cluster-port {{SERVER_PORT}} --driver-port {{DRIVER_PORT}} --http-port {{HTTP_PORT}} --initial-password auto --no-http-admin", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"Server ready\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash\r\n\r\napt update\r\napt install -y wget tar binutils xz-utils\r\n\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] && echo \"amd64\" || echo \"arm64\")\r\n\r\nmkdir -p \/mnt\/server\r\n\r\ncd \/tmp\r\nwget https:\/\/download.rethinkdb.com\/repository\/debian-bookworm\/pool\/r\/rethinkdb\/rethinkdb_${VERSION}~0bookworm_${ARCH}.deb -O rethinkdb.deb\r\n\r\nar xv rethinkdb.deb\r\n\r\ntar xvf data.tar.xz\r\n\r\nmv \/tmp\/usr\/bin\/rethinkdb \/mnt\/server\r\n\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"", + "container": "ghcr.io\/ptero-eggs\/installers:debian", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Version", + "description": "", + "env_variable": "VERSION", + "default_value": "2.4.4", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Driver port", + "description": "", + "env_variable": "DRIVER_PORT", + "default_value": "25568", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:10", + "field_type": "text" + }, + { + "name": "Http port", + "description": "", + "env_variable": "HTTP_PORT", + "default_value": "25569", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:10", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/redis/redis-5/README.md b/ptero_eggs/application/database/redis/redis-5/README.md new file mode 100644 index 0000000..3531c1d --- /dev/null +++ b/ptero_eggs/application/database/redis/redis-5/README.md @@ -0,0 +1,19 @@ +# Redis + +## From their [Website](https://redis.io/) + +Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. + +## Minimum RAM warning + +It's recommended to have 4gb of RAM for redis + +See here + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Server | 6379 | diff --git a/ptero_eggs/application/database/redis/redis-5/egg-redis-5.json b/ptero_eggs/application/database/redis/redis-5/egg-redis-5.json new file mode 100644 index 0000000..9e7fb97 --- /dev/null +++ b/ptero_eggs/application/database/redis/redis-5/egg-redis-5.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2025-10-03T14:09:22+02:00", + "name": "Redis-5", + "author": "parker@parkervcp.com", + "description": "Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes with radius queries and streams.", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:redis_5": "ghcr.io\/ptero-eggs\/yolks:redis_5" + }, + "file_denylist": [], + "startup": "redis-server --bind 0.0.0.0 --port {{SERVER_PORT}} --requirepass {{SERVER_PASSWORD}} --maxmemory {{SERVER_MEMORY}}mb --daemonize yes && redis-cli -p {{SERVER_PORT}} -a {{SERVER_PASSWORD}} && redis-cli -p {{SERVER_PORT}} -a {{SERVER_PASSWORD}} shutdown save", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"Configuration loaded\"\r\n}", + "logs": "{}", + "stop": "exit" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/ash\r\n# Redis Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\n\r\nsleep 5\r\necho -e \"Install complete. Made this to not have issues.\"", + "container": "ghcr.io\/ptero-eggs\/installers:alpine", + "entrypoint": "ash" + } + }, + "variables": [ + { + "name": "Redis Password", + "description": "The password redis should use to secure the server.", + "env_variable": "SERVER_PASSWORD", + "default_value": "P@55w0rd", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/redis/redis-6/README.md b/ptero_eggs/application/database/redis/redis-6/README.md new file mode 100644 index 0000000..d425ff6 --- /dev/null +++ b/ptero_eggs/application/database/redis/redis-6/README.md @@ -0,0 +1,23 @@ +# Redis + +## From their [Website](https://redis.io/) + +Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. + +## Server Startup + +You must first authenticate before trying to execute commands, to do this run `AUTH ` (without the `<>`). This should be the same as the password set in the `SERVER_PASSWORD` variable. + +## Minimum RAM warning + +It's recommended to have 4gb of RAM for redis + +See here + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Server | 6379 | diff --git a/ptero_eggs/application/database/redis/redis-6/egg-redis-6.json b/ptero_eggs/application/database/redis/redis-6/egg-redis-6.json new file mode 100644 index 0000000..7da3776 --- /dev/null +++ b/ptero_eggs/application/database/redis/redis-6/egg-redis-6.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2025-10-03T14:09:26+02:00", + "name": "Redis-6", + "author": "parker@parkervcp.com", + "description": "Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes with radius queries and streams.", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:redis_6": "ghcr.io\/ptero-eggs\/yolks:redis_6" + }, + "file_denylist": [], + "startup": "\/usr\/local\/bin\/redis-server \/home\/container\/redis.conf --save 60 1 --dir \/home\/container\/ --bind 0.0.0.0 --port {{SERVER_PORT}} --requirepass {{SERVER_PASSWORD}} --maxmemory {{SERVER_MEMORY}}mb --daemonize yes && redis-cli -p {{SERVER_PORT}}; redis-cli -p {{SERVER_PORT}} -a {{SERVER_PASSWORD}} shutdown save", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"Configuration loaded\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/ash\r\n# Redis Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\n\r\napk add --no-cache curl\r\n\r\nif [ ! -d \/mnt\/server ]; then\r\n mkdir \/mnt\/server\/\r\nfi\r\n\r\ncd \/mnt\/server\/\r\n\r\nif [ ! -d \/mnt\/server\/redis.conf ]; then\r\n curl https:\/\/raw.githubusercontent.com\/Ptero-Eggs\/application-eggs\/main\/database\/redis\/redis-6\/redis.conf -o redis.conf\r\nfi\r\n\r\nsleep 5\r\necho -e \"Install complete. Made this to not have issues.\"", + "container": "ghcr.io\/ptero-eggs\/installers:alpine", + "entrypoint": "ash" + } + }, + "variables": [ + { + "name": "Redis Password", + "description": "The password redis should use to secure the server.", + "env_variable": "SERVER_PASSWORD", + "default_value": "P@55w0rd", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/redis/redis-6/redis.conf b/ptero_eggs/application/database/redis/redis-6/redis.conf new file mode 100644 index 0000000..56394a4 --- /dev/null +++ b/ptero_eggs/application/database/redis/redis-6/redis.conf @@ -0,0 +1,1835 @@ +# Redis configuration file example. +# +# Note that in order to read the configuration file, Redis must be +# started with the file path as first argument: +# +# ./redis-server /path/to/redis.conf + +# Note on units: when memory size is needed, it is possible to specify +# it in the usual form of 1k 5GB 4M and so forth: +# +# 1k => 1000 bytes +# 1kb => 1024 bytes +# 1m => 1000000 bytes +# 1mb => 1024*1024 bytes +# 1g => 1000000000 bytes +# 1gb => 1024*1024*1024 bytes +# +# units are case insensitive so 1GB 1Gb 1gB are all the same. + +################################## INCLUDES ################################### + +# Include one or more other config files here. This is useful if you +# have a standard template that goes to all Redis servers but also need +# to customize a few per-server settings. Include files can include +# other files, so use this wisely. +# +# Notice option "include" won't be rewritten by command "CONFIG REWRITE" +# from admin or Redis Sentinel. Since Redis always uses the last processed +# line as value of a configuration directive, you'd better put includes +# at the beginning of this file to avoid overwriting config change at runtime. +# +# If instead you are interested in using includes to override configuration +# options, it is better to use include as the last line. +# +# include /path/to/local.conf +# include /path/to/other.conf + +################################## MODULES ##################################### + +# Load modules at startup. If the server is not able to load modules +# it will abort. It is possible to use multiple loadmodule directives. +# +# loadmodule /path/to/my_module.so +# loadmodule /path/to/other_module.so + +################################## NETWORK ##################################### + +# By default, if no "bind" configuration directive is specified, Redis listens +# for connections from all the network interfaces available on the server. +# It is possible to listen to just one or multiple selected interfaces using +# the "bind" configuration directive, followed by one or more IP addresses. +# +# Examples: +# +# bind 192.168.1.100 10.0.0.1 +# bind 127.0.0.1 ::1 +# +# ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the +# internet, binding to all the interfaces is dangerous and will expose the +# instance to everybody on the internet. So by default we uncomment the +# following bind directive, that will force Redis to listen only into +# the IPv4 loopback interface address (this means Redis will be able to +# accept connections only from clients running into the same computer it +# is running). +# +# IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES +# JUST COMMENT THE FOLLOWING LINE. +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +bind 127.0.0.1 + +# Protected mode is a layer of security protection, in order to avoid that +# Redis instances left open on the internet are accessed and exploited. +# +# When protected mode is on and if: +# +# 1) The server is not binding explicitly to a set of addresses using the +# "bind" directive. +# 2) No password is configured. +# +# The server only accepts connections from clients connecting from the +# IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain +# sockets. +# +# By default protected mode is enabled. You should disable it only if +# you are sure you want clients from other hosts to connect to Redis +# even if no authentication is configured, nor a specific set of interfaces +# are explicitly listed using the "bind" directive. +protected-mode yes + +# Accept connections on the specified port, default is 6379 (IANA #815344). +# If port 0 is specified Redis will not listen on a TCP socket. +port 6379 + +# TCP listen() backlog. +# +# In high requests-per-second environments you need an high backlog in order +# to avoid slow clients connections issues. Note that the Linux kernel +# will silently truncate it to the value of /proc/sys/net/core/somaxconn so +# make sure to raise both the value of somaxconn and tcp_max_syn_backlog +# in order to get the desired effect. +tcp-backlog 511 + +# Unix socket. +# +# Specify the path for the Unix socket that will be used to listen for +# incoming connections. There is no default, so Redis will not listen +# on a unix socket when not specified. +# +# unixsocket /tmp/redis.sock +# unixsocketperm 700 + +# Close the connection after a client is idle for N seconds (0 to disable) +timeout 0 + +# TCP keepalive. +# +# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence +# of communication. This is useful for two reasons: +# +# 1) Detect dead peers. +# 2) Take the connection alive from the point of view of network +# equipment in the middle. +# +# On Linux, the specified value (in seconds) is the period used to send ACKs. +# Note that to close the connection the double of the time is needed. +# On other kernels the period depends on the kernel configuration. +# +# A reasonable value for this option is 300 seconds, which is the new +# Redis default starting with Redis 3.2.1. +tcp-keepalive 300 + +################################# TLS/SSL ##################################### + +# By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration +# directive can be used to define TLS-listening ports. To enable TLS on the +# default port, use: +# +# port 0 +# tls-port 6379 + +# Configure a X.509 certificate and private key to use for authenticating the +# server to connected clients, masters or cluster peers. These files should be +# PEM formatted. +# +# tls-cert-file redis.crt +# tls-key-file redis.key + +# Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange: +# +# tls-dh-params-file redis.dh + +# Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL +# clients and peers. Redis requires an explicit configuration of at least one +# of these, and will not implicitly use the system wide configuration. +# +# tls-ca-cert-file ca.crt +# tls-ca-cert-dir /etc/ssl/certs + +# By default, clients (including replica servers) on a TLS port are required +# to authenticate using valid client side certificates. +# +# If "no" is specified, client certificates are not required and not accepted. +# If "optional" is specified, client certificates are accepted and must be +# valid if provided, but are not required. +# +# tls-auth-clients no +# tls-auth-clients optional + +# By default, a Redis replica does not attempt to establish a TLS connection +# with its master. +# +# Use the following directive to enable TLS on replication links. +# +# tls-replication yes + +# By default, the Redis Cluster bus uses a plain TCP connection. To enable +# TLS for the bus protocol, use the following directive: +# +# tls-cluster yes + +# Explicitly specify TLS versions to support. Allowed values are case insensitive +# and include "TLSv1", "TLSv1.1", "TLSv1.2", "TLSv1.3" (OpenSSL >= 1.1.1) or +# any combination. To enable only TLSv1.2 and TLSv1.3, use: +# +# tls-protocols "TLSv1.2 TLSv1.3" + +# Configure allowed ciphers. See the ciphers(1ssl) manpage for more information +# about the syntax of this string. +# +# Note: this configuration applies only to <= TLSv1.2. +# +# tls-ciphers DEFAULT:!MEDIUM + +# Configure allowed TLSv1.3 ciphersuites. See the ciphers(1ssl) manpage for more +# information about the syntax of this string, and specifically for TLSv1.3 +# ciphersuites. +# +# tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256 + +# When choosing a cipher, use the server's preference instead of the client +# preference. By default, the server follows the client's preference. +# +# tls-prefer-server-ciphers yes + +# By default, TLS session caching is enabled to allow faster and less expensive +# reconnections by clients that support it. Use the following directive to disable +# caching. +# +# tls-session-caching no + +# Change the default number of TLS sessions cached. A zero value sets the cache +# to unlimited size. The default size is 20480. +# +# tls-session-cache-size 5000 + +# Change the default timeout of cached TLS sessions. The default timeout is 300 +# seconds. +# +# tls-session-cache-timeout 60 + +################################# GENERAL ##################################### + +# By default Redis does not run as a daemon. Use 'yes' if you need it. +# Note that Redis will write a pid file in /var/run/redis.pid when daemonized. +daemonize no + +# If you run Redis from upstart or systemd, Redis can interact with your +# supervision tree. Options: +# supervised no - no supervision interaction +# supervised upstart - signal upstart by putting Redis into SIGSTOP mode +# supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET +# supervised auto - detect upstart or systemd method based on +# UPSTART_JOB or NOTIFY_SOCKET environment variables +# Note: these supervision methods only signal "process is ready." +# They do not enable continuous liveness pings back to your supervisor. +supervised no + +# If a pid file is specified, Redis writes it where specified at startup +# and removes it at exit. +# +# When the server runs non daemonized, no pid file is created if none is +# specified in the configuration. When the server is daemonized, the pid file +# is used even if not specified, defaulting to "/var/run/redis.pid". +# +# Creating a pid file is best effort: if Redis is not able to create it +# nothing bad happens, the server will start and run normally. +pidfile /var/run/redis_6379.pid + +# Specify the server verbosity level. +# This can be one of: +# debug (a lot of information, useful for development/testing) +# verbose (many rarely useful info, but not a mess like the debug level) +# notice (moderately verbose, what you want in production probably) +# warning (only very important / critical messages are logged) +loglevel notice + +# Specify the log file name. Also the empty string can be used to force +# Redis to log on the standard output. Note that if you use standard +# output for logging but daemonize, logs will be sent to /dev/null +logfile "" + +# To enable logging to the system logger, just set 'syslog-enabled' to yes, +# and optionally update the other syslog parameters to suit your needs. +# syslog-enabled no + +# Specify the syslog identity. +# syslog-ident redis + +# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. +# syslog-facility local0 + +# Set the number of databases. The default database is DB 0, you can select +# a different one on a per-connection basis using SELECT where +# dbid is a number between 0 and 'databases'-1 +databases 16 + +# By default Redis shows an ASCII art logo only when started to log to the +# standard output and if the standard output is a TTY. Basically this means +# that normally a logo is displayed only in interactive sessions. +# +# However it is possible to force the pre-4.0 behavior and always show a +# ASCII art logo in startup logs by setting the following option to yes. +always-show-logo yes + +################################ SNAPSHOTTING ################################ +# +# Save the DB on disk: +# +# save +# +# Will save the DB if both the given number of seconds and the given +# number of write operations against the DB occurred. +# +# In the example below the behaviour will be to save: +# after 900 sec (15 min) if at least 1 key changed +# after 300 sec (5 min) if at least 10 keys changed +# after 60 sec if at least 10000 keys changed +# +# Note: you can disable saving completely by commenting out all "save" lines. +# +# It is also possible to remove all the previously configured save +# points by adding a save directive with a single empty string argument +# like in the following example: +# +# save "" + +save 900 1 +save 300 10 +save 60 10000 + +# By default Redis will stop accepting writes if RDB snapshots are enabled +# (at least one save point) and the latest background save failed. +# This will make the user aware (in a hard way) that data is not persisting +# on disk properly, otherwise chances are that no one will notice and some +# disaster will happen. +# +# If the background saving process will start working again Redis will +# automatically allow writes again. +# +# However if you have setup your proper monitoring of the Redis server +# and persistence, you may want to disable this feature so that Redis will +# continue to work as usual even if there are problems with disk, +# permissions, and so forth. +stop-writes-on-bgsave-error yes + +# Compress string objects using LZF when dump .rdb databases? +# For default that's set to 'yes' as it's almost always a win. +# If you want to save some CPU in the saving child set it to 'no' but +# the dataset will likely be bigger if you have compressible values or keys. +rdbcompression yes + +# Since version 5 of RDB a CRC64 checksum is placed at the end of the file. +# This makes the format more resistant to corruption but there is a performance +# hit to pay (around 10%) when saving and loading RDB files, so you can disable it +# for maximum performances. +# +# RDB files created with checksum disabled have a checksum of zero that will +# tell the loading code to skip the check. +rdbchecksum yes + +# The filename where to dump the DB +dbfilename dump.rdb + +# Remove RDB files used by replication in instances without persistence +# enabled. By default this option is disabled, however there are environments +# where for regulations or other security concerns, RDB files persisted on +# disk by masters in order to feed replicas, or stored on disk by replicas +# in order to load them for the initial synchronization, should be deleted +# ASAP. Note that this option ONLY WORKS in instances that have both AOF +# and RDB persistence disabled, otherwise is completely ignored. +# +# An alternative (and sometimes better) way to obtain the same effect is +# to use diskless replication on both master and replicas instances. However +# in the case of replicas, diskless is not always an option. +rdb-del-sync-files no + +# The working directory. +# +# The DB will be written inside this directory, with the filename specified +# above using the 'dbfilename' configuration directive. +# +# The Append Only File will also be created inside this directory. +# +# Note that you must specify a directory here, not a file name. +dir ./ + +################################# REPLICATION ################################# + +# Master-Replica replication. Use replicaof to make a Redis instance a copy of +# another Redis server. A few things to understand ASAP about Redis replication. +# +# +------------------+ +---------------+ +# | Master | ---> | Replica | +# | (receive writes) | | (exact copy) | +# +------------------+ +---------------+ +# +# 1) Redis replication is asynchronous, but you can configure a master to +# stop accepting writes if it appears to be not connected with at least +# a given number of replicas. +# 2) Redis replicas are able to perform a partial resynchronization with the +# master if the replication link is lost for a relatively small amount of +# time. You may want to configure the replication backlog size (see the next +# sections of this file) with a sensible value depending on your needs. +# 3) Replication is automatic and does not need user intervention. After a +# network partition replicas automatically try to reconnect to masters +# and resynchronize with them. +# +# replicaof + +# If the master is password protected (using the "requirepass" configuration +# directive below) it is possible to tell the replica to authenticate before +# starting the replication synchronization process, otherwise the master will +# refuse the replica request. +# +# masterauth +# +# However this is not enough if you are using Redis ACLs (for Redis version +# 6 or greater), and the default user is not capable of running the PSYNC +# command and/or other commands needed for replication. In this case it's +# better to configure a special user to use with replication, and specify the +# masteruser configuration as such: +# +# masteruser +# +# When masteruser is specified, the replica will authenticate against its +# master using the new AUTH form: AUTH . + +# When a replica loses its connection with the master, or when the replication +# is still in progress, the replica can act in two different ways: +# +# 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will +# still reply to client requests, possibly with out of date data, or the +# data set may just be empty if this is the first synchronization. +# +# 2) if replica-serve-stale-data is set to 'no' the replica will reply with +# an error "SYNC with master in progress" to all the kind of commands +# but to INFO, replicaOF, AUTH, PING, SHUTDOWN, REPLCONF, ROLE, CONFIG, +# SUBSCRIBE, UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB, +# COMMAND, POST, HOST: and LATENCY. +# +replica-serve-stale-data yes + +# You can configure a replica instance to accept writes or not. Writing against +# a replica instance may be useful to store some ephemeral data (because data +# written on a replica will be easily deleted after resync with the master) but +# may also cause problems if clients are writing to it because of a +# misconfiguration. +# +# Since Redis 2.6 by default replicas are read-only. +# +# Note: read only replicas are not designed to be exposed to untrusted clients +# on the internet. It's just a protection layer against misuse of the instance. +# Still a read only replica exports by default all the administrative commands +# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve +# security of read only replicas using 'rename-command' to shadow all the +# administrative / dangerous commands. +replica-read-only yes + +# Replication SYNC strategy: disk or socket. +# +# New replicas and reconnecting replicas that are not able to continue the +# replication process just receiving differences, need to do what is called a +# "full synchronization". An RDB file is transmitted from the master to the +# replicas. +# +# The transmission can happen in two different ways: +# +# 1) Disk-backed: The Redis master creates a new process that writes the RDB +# file on disk. Later the file is transferred by the parent +# process to the replicas incrementally. +# 2) Diskless: The Redis master creates a new process that directly writes the +# RDB file to replica sockets, without touching the disk at all. +# +# With disk-backed replication, while the RDB file is generated, more replicas +# can be queued and served with the RDB file as soon as the current child +# producing the RDB file finishes its work. With diskless replication instead +# once the transfer starts, new replicas arriving will be queued and a new +# transfer will start when the current one terminates. +# +# When diskless replication is used, the master waits a configurable amount of +# time (in seconds) before starting the transfer in the hope that multiple +# replicas will arrive and the transfer can be parallelized. +# +# With slow disks and fast (large bandwidth) networks, diskless replication +# works better. +repl-diskless-sync no + +# When diskless replication is enabled, it is possible to configure the delay +# the server waits in order to spawn the child that transfers the RDB via socket +# to the replicas. +# +# This is important since once the transfer starts, it is not possible to serve +# new replicas arriving, that will be queued for the next RDB transfer, so the +# server waits a delay in order to let more replicas arrive. +# +# The delay is specified in seconds, and by default is 5 seconds. To disable +# it entirely just set it to 0 seconds and the transfer will start ASAP. +repl-diskless-sync-delay 5 + +# ----------------------------------------------------------------------------- +# WARNING: RDB diskless load is experimental. Since in this setup the replica +# does not immediately store an RDB on disk, it may cause data loss during +# failovers. RDB diskless load + Redis modules not handling I/O reads may also +# cause Redis to abort in case of I/O errors during the initial synchronization +# stage with the master. Use only if your do what you are doing. +# ----------------------------------------------------------------------------- +# +# Replica can load the RDB it reads from the replication link directly from the +# socket, or store the RDB to a file and read that file after it was completely +# recived from the master. +# +# In many cases the disk is slower than the network, and storing and loading +# the RDB file may increase replication time (and even increase the master's +# Copy on Write memory and salve buffers). +# However, parsing the RDB file directly from the socket may mean that we have +# to flush the contents of the current database before the full rdb was +# received. For this reason we have the following options: +# +# "disabled" - Don't use diskless load (store the rdb file to the disk first) +# "on-empty-db" - Use diskless load only when it is completely safe. +# "swapdb" - Keep a copy of the current db contents in RAM while parsing +# the data directly from the socket. note that this requires +# sufficient memory, if you don't have it, you risk an OOM kill. +repl-diskless-load disabled + +# Replicas send PINGs to server in a predefined interval. It's possible to +# change this interval with the repl_ping_replica_period option. The default +# value is 10 seconds. +# +# repl-ping-replica-period 10 + +# The following option sets the replication timeout for: +# +# 1) Bulk transfer I/O during SYNC, from the point of view of replica. +# 2) Master timeout from the point of view of replicas (data, pings). +# 3) Replica timeout from the point of view of masters (REPLCONF ACK pings). +# +# It is important to make sure that this value is greater than the value +# specified for repl-ping-replica-period otherwise a timeout will be detected +# every time there is low traffic between the master and the replica. +# +# repl-timeout 60 + +# Disable TCP_NODELAY on the replica socket after SYNC? +# +# If you select "yes" Redis will use a smaller number of TCP packets and +# less bandwidth to send data to replicas. But this can add a delay for +# the data to appear on the replica side, up to 40 milliseconds with +# Linux kernels using a default configuration. +# +# If you select "no" the delay for data to appear on the replica side will +# be reduced but more bandwidth will be used for replication. +# +# By default we optimize for low latency, but in very high traffic conditions +# or when the master and replicas are many hops away, turning this to "yes" may +# be a good idea. +repl-disable-tcp-nodelay no + +# Set the replication backlog size. The backlog is a buffer that accumulates +# replica data when replicas are disconnected for some time, so that when a +# replica wants to reconnect again, often a full resync is not needed, but a +# partial resync is enough, just passing the portion of data the replica +# missed while disconnected. +# +# The bigger the replication backlog, the longer the time the replica can be +# disconnected and later be able to perform a partial resynchronization. +# +# The backlog is only allocated once there is at least a replica connected. +# +# repl-backlog-size 1mb + +# After a master has no longer connected replicas for some time, the backlog +# will be freed. The following option configures the amount of seconds that +# need to elapse, starting from the time the last replica disconnected, for +# the backlog buffer to be freed. +# +# Note that replicas never free the backlog for timeout, since they may be +# promoted to masters later, and should be able to correctly "partially +# resynchronize" with the replicas: hence they should always accumulate backlog. +# +# A value of 0 means to never release the backlog. +# +# repl-backlog-ttl 3600 + +# The replica priority is an integer number published by Redis in the INFO +# output. It is used by Redis Sentinel in order to select a replica to promote +# into a master if the master is no longer working correctly. +# +# A replica with a low priority number is considered better for promotion, so +# for instance if there are three replicas with priority 10, 100, 25 Sentinel +# will pick the one with priority 10, that is the lowest. +# +# However a special priority of 0 marks the replica as not able to perform the +# role of master, so a replica with priority of 0 will never be selected by +# Redis Sentinel for promotion. +# +# By default the priority is 100. +replica-priority 100 + +# It is possible for a master to stop accepting writes if there are less than +# N replicas connected, having a lag less or equal than M seconds. +# +# The N replicas need to be in "online" state. +# +# The lag in seconds, that must be <= the specified value, is calculated from +# the last ping received from the replica, that is usually sent every second. +# +# This option does not GUARANTEE that N replicas will accept the write, but +# will limit the window of exposure for lost writes in case not enough replicas +# are available, to the specified number of seconds. +# +# For example to require at least 3 replicas with a lag <= 10 seconds use: +# +# min-replicas-to-write 3 +# min-replicas-max-lag 10 +# +# Setting one or the other to 0 disables the feature. +# +# By default min-replicas-to-write is set to 0 (feature disabled) and +# min-replicas-max-lag is set to 10. + +# A Redis master is able to list the address and port of the attached +# replicas in different ways. For example the "INFO replication" section +# offers this information, which is used, among other tools, by +# Redis Sentinel in order to discover replica instances. +# Another place where this info is available is in the output of the +# "ROLE" command of a master. +# +# The listed IP and address normally reported by a replica is obtained +# in the following way: +# +# IP: The address is auto detected by checking the peer address +# of the socket used by the replica to connect with the master. +# +# Port: The port is communicated by the replica during the replication +# handshake, and is normally the port that the replica is using to +# listen for connections. +# +# However when port forwarding or Network Address Translation (NAT) is +# used, the replica may be actually reachable via different IP and port +# pairs. The following two options can be used by a replica in order to +# report to its master a specific set of IP and port, so that both INFO +# and ROLE will report those values. +# +# There is no need to use both the options if you need to override just +# the port or the IP address. +# +# replica-announce-ip 5.5.5.5 +# replica-announce-port 1234 + +############################### KEYS TRACKING ################################# + +# Redis implements server assisted support for client side caching of values. +# This is implemented using an invalidation table that remembers, using +# 16 millions of slots, what clients may have certain subsets of keys. In turn +# this is used in order to send invalidation messages to clients. Please +# to understand more about the feature check this page: +# +# https://redis.io/topics/client-side-caching +# +# When tracking is enabled for a client, all the read only queries are assumed +# to be cached: this will force Redis to store information in the invalidation +# table. When keys are modified, such information is flushed away, and +# invalidation messages are sent to the clients. However if the workload is +# heavily dominated by reads, Redis could use more and more memory in order +# to track the keys fetched by many clients. +# +# For this reason it is possible to configure a maximum fill value for the +# invalidation table. By default it is set to 1M of keys, and once this limit +# is reached, Redis will start to evict keys in the invalidation table +# even if they were not modified, just to reclaim memory: this will in turn +# force the clients to invalidate the cached values. Basically the table +# maximum size is a trade off between the memory you want to spend server +# side to track information about who cached what, and the ability of clients +# to retain cached objects in memory. +# +# If you set the value to 0, it means there are no limits, and Redis will +# retain as many keys as needed in the invalidation table. +# In the "stats" INFO section, you can find information about the number of +# keys in the invalidation table at every given moment. +# +# Note: when key tracking is used in broadcasting mode, no memory is used +# in the server side so this setting is useless. +# +# tracking-table-max-keys 1000000 + +################################## SECURITY ################################### + +# Warning: since Redis is pretty fast an outside user can try up to +# 1 million passwords per second against a modern box. This means that you +# should use very strong passwords, otherwise they will be very easy to break. +# Note that because the password is really a shared secret between the client +# and the server, and should not be memorized by any human, the password +# can be easily a long string from /dev/urandom or whatever, so by using a +# long and unguessable password no brute force attack will be possible. + +# Redis ACL users are defined in the following format: +# +# user ... acl rules ... +# +# For example: +# +# user worker +@list +@connection ~jobs:* on >ffa9203c493aa99 +# +# The special username "default" is used for new connections. If this user +# has the "nopass" rule, then new connections will be immediately authenticated +# as the "default" user without the need of any password provided via the +# AUTH command. Otherwise if the "default" user is not flagged with "nopass" +# the connections will start in not authenticated state, and will require +# AUTH (or the HELLO command AUTH option) in order to be authenticated and +# start to work. +# +# The ACL rules that describe what an user can do are the following: +# +# on Enable the user: it is possible to authenticate as this user. +# off Disable the user: it's no longer possible to authenticate +# with this user, however the already authenticated connections +# will still work. +# + Allow the execution of that command +# - Disallow the execution of that command +# +@ Allow the execution of all the commands in such category +# with valid categories are like @admin, @set, @sortedset, ... +# and so forth, see the full list in the server.c file where +# the Redis command table is described and defined. +# The special category @all means all the commands, but currently +# present in the server, and that will be loaded in the future +# via modules. +# +|subcommand Allow a specific subcommand of an otherwise +# disabled command. Note that this form is not +# allowed as negative like -DEBUG|SEGFAULT, but +# only additive starting with "+". +# allcommands Alias for +@all. Note that it implies the ability to execute +# all the future commands loaded via the modules system. +# nocommands Alias for -@all. +# ~ Add a pattern of keys that can be mentioned as part of +# commands. For instance ~* allows all the keys. The pattern +# is a glob-style pattern like the one of KEYS. +# It is possible to specify multiple patterns. +# allkeys Alias for ~* +# resetkeys Flush the list of allowed keys patterns. +# > Add this passowrd to the list of valid password for the user. +# For example >mypass will add "mypass" to the list. +# This directive clears the "nopass" flag (see later). +# < Remove this password from the list of valid passwords. +# nopass All the set passwords of the user are removed, and the user +# is flagged as requiring no password: it means that every +# password will work against this user. If this directive is +# used for the default user, every new connection will be +# immediately authenticated with the default user without +# any explicit AUTH command required. Note that the "resetpass" +# directive will clear this condition. +# resetpass Flush the list of allowed passwords. Moreover removes the +# "nopass" status. After "resetpass" the user has no associated +# passwords and there is no way to authenticate without adding +# some password (or setting it as "nopass" later). +# reset Performs the following actions: resetpass, resetkeys, off, +# -@all. The user returns to the same state it has immediately +# after its creation. +# +# ACL rules can be specified in any order: for instance you can start with +# passwords, then flags, or key patterns. However note that the additive +# and subtractive rules will CHANGE MEANING depending on the ordering. +# For instance see the following example: +# +# user alice on +@all -DEBUG ~* >somepassword +# +# This will allow "alice" to use all the commands with the exception of the +# DEBUG command, since +@all added all the commands to the set of the commands +# alice can use, and later DEBUG was removed. However if we invert the order +# of two ACL rules the result will be different: +# +# user alice on -DEBUG +@all ~* >somepassword +# +# Now DEBUG was removed when alice had yet no commands in the set of allowed +# commands, later all the commands are added, so the user will be able to +# execute everything. +# +# Basically ACL rules are processed left-to-right. +# +# For more information about ACL configuration please refer to +# the Redis web site at https://redis.io/topics/acl + +# ACL LOG +# +# The ACL Log tracks failed commands and authentication events associated +# with ACLs. The ACL Log is useful to troubleshoot failed commands blocked +# by ACLs. The ACL Log is stored in memory. You can reclaim memory with +# ACL LOG RESET. Define the maximum entry length of the ACL Log below. +acllog-max-len 128 + +# Using an external ACL file +# +# Instead of configuring users here in this file, it is possible to use +# a stand-alone file just listing users. The two methods cannot be mixed: +# if you configure users here and at the same time you activate the exteranl +# ACL file, the server will refuse to start. +# +# The format of the external ACL user file is exactly the same as the +# format that is used inside redis.conf to describe users. +# +# aclfile /etc/redis/users.acl + +# IMPORTANT NOTE: starting with Redis 6 "requirepass" is just a compatiblity +# layer on top of the new ACL system. The option effect will be just setting +# the password for the default user. Clients will still authenticate using +# AUTH as usually, or more explicitly with AUTH default +# if they follow the new protocol: both will work. +# +# requirepass foobared + +# Command renaming (DEPRECATED). +# +# ------------------------------------------------------------------------ +# WARNING: avoid using this option if possible. Instead use ACLs to remove +# commands from the default user, and put them only in some admin user you +# create for administrative purposes. +# ------------------------------------------------------------------------ +# +# It is possible to change the name of dangerous commands in a shared +# environment. For instance the CONFIG command may be renamed into something +# hard to guess so that it will still be available for internal-use tools +# but not available for general clients. +# +# Example: +# +# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 +# +# It is also possible to completely kill a command by renaming it into +# an empty string: +# +# rename-command CONFIG "" +# +# Please note that changing the name of commands that are logged into the +# AOF file or transmitted to replicas may cause problems. + +################################### CLIENTS #################################### + +# Set the max number of connected clients at the same time. By default +# this limit is set to 10000 clients, however if the Redis server is not +# able to configure the process file limit to allow for the specified limit +# the max number of allowed clients is set to the current file limit +# minus 32 (as Redis reserves a few file descriptors for internal uses). +# +# Once the limit is reached Redis will close all the new connections sending +# an error 'max number of clients reached'. +# +# IMPORTANT: When Redis Cluster is used, the max number of connections is also +# shared with the cluster bus: every node in the cluster will use two +# connections, one incoming and another outgoing. It is important to size the +# limit accordingly in case of very large clusters. +# +# maxclients 10000 + +############################## MEMORY MANAGEMENT ################################ + +# Set a memory usage limit to the specified amount of bytes. +# When the memory limit is reached Redis will try to remove keys +# according to the eviction policy selected (see maxmemory-policy). +# +# If Redis can't remove keys according to the policy, or if the policy is +# set to 'noeviction', Redis will start to reply with errors to commands +# that would use more memory, like SET, LPUSH, and so on, and will continue +# to reply to read-only commands like GET. +# +# This option is usually useful when using Redis as an LRU or LFU cache, or to +# set a hard memory limit for an instance (using the 'noeviction' policy). +# +# WARNING: If you have replicas attached to an instance with maxmemory on, +# the size of the output buffers needed to feed the replicas are subtracted +# from the used memory count, so that network problems / resyncs will +# not trigger a loop where keys are evicted, and in turn the output +# buffer of replicas is full with DELs of keys evicted triggering the deletion +# of more keys, and so forth until the database is completely emptied. +# +# In short... if you have replicas attached it is suggested that you set a lower +# limit for maxmemory so that there is some free RAM on the system for replica +# output buffers (but this is not needed if the policy is 'noeviction'). +# +# maxmemory + +# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory +# is reached. You can select one from the following behaviors: +# +# volatile-lru -> Evict using approximated LRU, only keys with an expire set. +# allkeys-lru -> Evict any key using approximated LRU. +# volatile-lfu -> Evict using approximated LFU, only keys with an expire set. +# allkeys-lfu -> Evict any key using approximated LFU. +# volatile-random -> Remove a random key having an expire set. +# allkeys-random -> Remove a random key, any key. +# volatile-ttl -> Remove the key with the nearest expire time (minor TTL) +# noeviction -> Don't evict anything, just return an error on write operations. +# +# LRU means Least Recently Used +# LFU means Least Frequently Used +# +# Both LRU, LFU and volatile-ttl are implemented using approximated +# randomized algorithms. +# +# Note: with any of the above policies, Redis will return an error on write +# operations, when there are no suitable keys for eviction. +# +# At the date of writing these commands are: set setnx setex append +# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd +# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby +# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby +# getset mset msetnx exec sort +# +# The default is: +# +# maxmemory-policy noeviction + +# LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated +# algorithms (in order to save memory), so you can tune it for speed or +# accuracy. For default Redis will check five keys and pick the one that was +# used less recently, you can change the sample size using the following +# configuration directive. +# +# The default of 5 produces good enough results. 10 Approximates very closely +# true LRU but costs more CPU. 3 is faster but not very accurate. +# +# maxmemory-samples 5 + +# Starting from Redis 5, by default a replica will ignore its maxmemory setting +# (unless it is promoted to master after a failover or manually). It means +# that the eviction of keys will be just handled by the master, sending the +# DEL commands to the replica as keys evict in the master side. +# +# This behavior ensures that masters and replicas stay consistent, and is usually +# what you want, however if your replica is writable, or you want the replica +# to have a different memory setting, and you are sure all the writes performed +# to the replica are idempotent, then you may change this default (but be sure +# to understand what you are doing). +# +# Note that since the replica by default does not evict, it may end using more +# memory than the one set via maxmemory (there are certain buffers that may +# be larger on the replica, or data structures may sometimes take more memory +# and so forth). So make sure you monitor your replicas and make sure they +# have enough memory to never hit a real out-of-memory condition before the +# master hits the configured maxmemory setting. +# +# replica-ignore-maxmemory yes + +# Redis reclaims expired keys in two ways: upon access when those keys are +# found to be expired, and also in background, in what is called the +# "active expire key". The key space is slowly and interactively scanned +# looking for expired keys to reclaim, so that it is possible to free memory +# of keys that are expired and will never be accessed again in a short time. +# +# The default effort of the expire cycle will try to avoid having more than +# ten percent of expired keys still in memory, and will try to avoid consuming +# more than 25% of total memory and to add latency to the system. However +# it is possible to increase the expire "effort" that is normally set to +# "1", to a greater value, up to the value "10". At its maximum value the +# system will use more CPU, longer cycles (and technically may introduce +# more latency), and will tollerate less already expired keys still present +# in the system. It's a tradeoff betweeen memory, CPU and latecy. +# +# active-expire-effort 1 + +############################# LAZY FREEING #################################### + +# Redis has two primitives to delete keys. One is called DEL and is a blocking +# deletion of the object. It means that the server stops processing new commands +# in order to reclaim all the memory associated with an object in a synchronous +# way. If the key deleted is associated with a small object, the time needed +# in order to execute the DEL command is very small and comparable to most other +# O(1) or O(log_N) commands in Redis. However if the key is associated with an +# aggregated value containing millions of elements, the server can block for +# a long time (even seconds) in order to complete the operation. +# +# For the above reasons Redis also offers non blocking deletion primitives +# such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and +# FLUSHDB commands, in order to reclaim memory in background. Those commands +# are executed in constant time. Another thread will incrementally free the +# object in the background as fast as possible. +# +# DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled. +# It's up to the design of the application to understand when it is a good +# idea to use one or the other. However the Redis server sometimes has to +# delete keys or flush the whole database as a side effect of other operations. +# Specifically Redis deletes objects independently of a user call in the +# following scenarios: +# +# 1) On eviction, because of the maxmemory and maxmemory policy configurations, +# in order to make room for new data, without going over the specified +# memory limit. +# 2) Because of expire: when a key with an associated time to live (see the +# EXPIRE command) must be deleted from memory. +# 3) Because of a side effect of a command that stores data on a key that may +# already exist. For example the RENAME command may delete the old key +# content when it is replaced with another one. Similarly SUNIONSTORE +# or SORT with STORE option may delete existing keys. The SET command +# itself removes any old content of the specified key in order to replace +# it with the specified string. +# 4) During replication, when a replica performs a full resynchronization with +# its master, the content of the whole database is removed in order to +# load the RDB file just transferred. +# +# In all the above cases the default is to delete objects in a blocking way, +# like if DEL was called. However you can configure each case specifically +# in order to instead release memory in a non-blocking way like if UNLINK +# was called, using the following configuration directives. + +lazyfree-lazy-eviction no +lazyfree-lazy-expire no +lazyfree-lazy-server-del no +replica-lazy-flush no + +# It is also possible, for the case when to replace the user code DEL calls +# with UNLINK calls is not easy, to modify the default behavior of the DEL +# command to act exactly like UNLINK, using the following configuration +# directive: + +lazyfree-lazy-user-del no + +################################ THREADED I/O ################################# + +# Redis is mostly single threaded, however there are certain threaded +# operations such as UNLINK, slow I/O accesses and other things that are +# performed on side threads. +# +# Now it is also possible to handle Redis clients socket reads and writes +# in different I/O threads. Since especially writing is so slow, normally +# Redis users use pipelining in order to speedup the Redis performances per +# core, and spawn multiple instances in order to scale more. Using I/O +# threads it is possible to easily speedup two times Redis without resorting +# to pipelining nor sharding of the instance. +# +# By default threading is disabled, we suggest enabling it only in machines +# that have at least 4 or more cores, leaving at least one spare core. +# Using more than 8 threads is unlikely to help much. We also recommend using +# threaded I/O only if you actually have performance problems, with Redis +# instances being able to use a quite big percentage of CPU time, otherwise +# there is no point in using this feature. +# +# So for instance if you have a four cores boxes, try to use 2 or 3 I/O +# threads, if you have a 8 cores, try to use 6 threads. In order to +# enable I/O threads use the following configuration directive: +# +# io-threads 4 +# +# Setting io-threads to 1 will just use the main thread as usually. +# When I/O threads are enabled, we only use threads for writes, that is +# to thread the write(2) syscall and transfer the client buffers to the +# socket. However it is also possible to enable threading of reads and +# protocol parsing using the following configuration directive, by setting +# it to yes: +# +# io-threads-do-reads no +# +# Usually threading reads doesn't help much. +# +# NOTE 1: This configuration directive cannot be changed at runtime via +# CONFIG SET. Aso this feature currently does not work when SSL is +# enabled. +# +# NOTE 2: If you want to test the Redis speedup using redis-benchmark, make +# sure you also run the benchmark itself in threaded mode, using the +# --threads option to match the number of Redis theads, otherwise you'll not +# be able to notice the improvements. + +############################## APPEND ONLY MODE ############################### + +# By default Redis asynchronously dumps the dataset on disk. This mode is +# good enough in many applications, but an issue with the Redis process or +# a power outage may result into a few minutes of writes lost (depending on +# the configured save points). +# +# The Append Only File is an alternative persistence mode that provides +# much better durability. For instance using the default data fsync policy +# (see later in the config file) Redis can lose just one second of writes in a +# dramatic event like a server power outage, or a single write if something +# wrong with the Redis process itself happens, but the operating system is +# still running correctly. +# +# AOF and RDB persistence can be enabled at the same time without problems. +# If the AOF is enabled on startup Redis will load the AOF, that is the file +# with the better durability guarantees. +# +# Please check http://redis.io/topics/persistence for more information. + +appendonly no + +# The name of the append only file (default: "appendonly.aof") + +appendfilename "appendonly.aof" + +# The fsync() call tells the Operating System to actually write data on disk +# instead of waiting for more data in the output buffer. Some OS will really flush +# data on disk, some other OS will just try to do it ASAP. +# +# Redis supports three different modes: +# +# no: don't fsync, just let the OS flush the data when it wants. Faster. +# always: fsync after every write to the append only log. Slow, Safest. +# everysec: fsync only one time every second. Compromise. +# +# The default is "everysec", as that's usually the right compromise between +# speed and data safety. It's up to you to understand if you can relax this to +# "no" that will let the operating system flush the output buffer when +# it wants, for better performances (but if you can live with the idea of +# some data loss consider the default persistence mode that's snapshotting), +# or on the contrary, use "always" that's very slow but a bit safer than +# everysec. +# +# More details please check the following article: +# http://antirez.com/post/redis-persistence-demystified.html +# +# If unsure, use "everysec". + +# appendfsync always +appendfsync everysec +# appendfsync no + +# When the AOF fsync policy is set to always or everysec, and a background +# saving process (a background save or AOF log background rewriting) is +# performing a lot of I/O against the disk, in some Linux configurations +# Redis may block too long on the fsync() call. Note that there is no fix for +# this currently, as even performing fsync in a different thread will block +# our synchronous write(2) call. +# +# In order to mitigate this problem it's possible to use the following option +# that will prevent fsync() from being called in the main process while a +# BGSAVE or BGREWRITEAOF is in progress. +# +# This means that while another child is saving, the durability of Redis is +# the same as "appendfsync none". In practical terms, this means that it is +# possible to lose up to 30 seconds of log in the worst scenario (with the +# default Linux settings). +# +# If you have latency problems turn this to "yes". Otherwise leave it as +# "no" that is the safest pick from the point of view of durability. + +no-appendfsync-on-rewrite no + +# Automatic rewrite of the append only file. +# Redis is able to automatically rewrite the log file implicitly calling +# BGREWRITEAOF when the AOF log size grows by the specified percentage. +# +# This is how it works: Redis remembers the size of the AOF file after the +# latest rewrite (if no rewrite has happened since the restart, the size of +# the AOF at startup is used). +# +# This base size is compared to the current size. If the current size is +# bigger than the specified percentage, the rewrite is triggered. Also +# you need to specify a minimal size for the AOF file to be rewritten, this +# is useful to avoid rewriting the AOF file even if the percentage increase +# is reached but it is still pretty small. +# +# Specify a percentage of zero in order to disable the automatic AOF +# rewrite feature. + +auto-aof-rewrite-percentage 100 +auto-aof-rewrite-min-size 64mb + +# An AOF file may be found to be truncated at the end during the Redis +# startup process, when the AOF data gets loaded back into memory. +# This may happen when the system where Redis is running +# crashes, especially when an ext4 filesystem is mounted without the +# data=ordered option (however this can't happen when Redis itself +# crashes or aborts but the operating system still works correctly). +# +# Redis can either exit with an error when this happens, or load as much +# data as possible (the default now) and start if the AOF file is found +# to be truncated at the end. The following option controls this behavior. +# +# If aof-load-truncated is set to yes, a truncated AOF file is loaded and +# the Redis server starts emitting a log to inform the user of the event. +# Otherwise if the option is set to no, the server aborts with an error +# and refuses to start. When the option is set to no, the user requires +# to fix the AOF file using the "redis-check-aof" utility before to restart +# the server. +# +# Note that if the AOF file will be found to be corrupted in the middle +# the server will still exit with an error. This option only applies when +# Redis will try to read more data from the AOF file but not enough bytes +# will be found. +aof-load-truncated yes + +# When rewriting the AOF file, Redis is able to use an RDB preamble in the +# AOF file for faster rewrites and recoveries. When this option is turned +# on the rewritten AOF file is composed of two different stanzas: +# +# [RDB file][AOF tail] +# +# When loading Redis recognizes that the AOF file starts with the "REDIS" +# string and loads the prefixed RDB file, and continues loading the AOF +# tail. +aof-use-rdb-preamble yes + +################################ LUA SCRIPTING ############################### + +# Max execution time of a Lua script in milliseconds. +# +# If the maximum execution time is reached Redis will log that a script is +# still in execution after the maximum allowed time and will start to +# reply to queries with an error. +# +# When a long running script exceeds the maximum execution time only the +# SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be +# used to stop a script that did not yet called write commands. The second +# is the only way to shut down the server in the case a write command was +# already issued by the script but the user doesn't want to wait for the natural +# termination of the script. +# +# Set it to 0 or a negative value for unlimited execution without warnings. +lua-time-limit 5000 + +################################ REDIS CLUSTER ############################### + +# Normal Redis instances can't be part of a Redis Cluster; only nodes that are +# started as cluster nodes can. In order to start a Redis instance as a +# cluster node enable the cluster support uncommenting the following: +# +# cluster-enabled yes + +# Every cluster node has a cluster configuration file. This file is not +# intended to be edited by hand. It is created and updated by Redis nodes. +# Every Redis Cluster node requires a different cluster configuration file. +# Make sure that instances running in the same system do not have +# overlapping cluster configuration file names. +# +# cluster-config-file nodes-6379.conf + +# Cluster node timeout is the amount of milliseconds a node must be unreachable +# for it to be considered in failure state. +# Most other internal time limits are multiple of the node timeout. +# +# cluster-node-timeout 15000 + +# A replica of a failing master will avoid to start a failover if its data +# looks too old. +# +# There is no simple way for a replica to actually have an exact measure of +# its "data age", so the following two checks are performed: +# +# 1) If there are multiple replicas able to failover, they exchange messages +# in order to try to give an advantage to the replica with the best +# replication offset (more data from the master processed). +# Replicas will try to get their rank by offset, and apply to the start +# of the failover a delay proportional to their rank. +# +# 2) Every single replica computes the time of the last interaction with +# its master. This can be the last ping or command received (if the master +# is still in the "connected" state), or the time that elapsed since the +# disconnection with the master (if the replication link is currently down). +# If the last interaction is too old, the replica will not try to failover +# at all. +# +# The point "2" can be tuned by user. Specifically a replica will not perform +# the failover if, since the last interaction with the master, the time +# elapsed is greater than: +# +# (node-timeout * replica-validity-factor) + repl-ping-replica-period +# +# So for example if node-timeout is 30 seconds, and the replica-validity-factor +# is 10, and assuming a default repl-ping-replica-period of 10 seconds, the +# replica will not try to failover if it was not able to talk with the master +# for longer than 310 seconds. +# +# A large replica-validity-factor may allow replicas with too old data to failover +# a master, while a too small value may prevent the cluster from being able to +# elect a replica at all. +# +# For maximum availability, it is possible to set the replica-validity-factor +# to a value of 0, which means, that replicas will always try to failover the +# master regardless of the last time they interacted with the master. +# (However they'll always try to apply a delay proportional to their +# offset rank). +# +# Zero is the only value able to guarantee that when all the partitions heal +# the cluster will always be able to continue. +# +# cluster-replica-validity-factor 10 + +# Cluster replicas are able to migrate to orphaned masters, that are masters +# that are left without working replicas. This improves the cluster ability +# to resist to failures as otherwise an orphaned master can't be failed over +# in case of failure if it has no working replicas. +# +# Replicas migrate to orphaned masters only if there are still at least a +# given number of other working replicas for their old master. This number +# is the "migration barrier". A migration barrier of 1 means that a replica +# will migrate only if there is at least 1 other working replica for its master +# and so forth. It usually reflects the number of replicas you want for every +# master in your cluster. +# +# Default is 1 (replicas migrate only if their masters remain with at least +# one replica). To disable migration just set it to a very large value. +# A value of 0 can be set but is useful only for debugging and dangerous +# in production. +# +# cluster-migration-barrier 1 + +# By default Redis Cluster nodes stop accepting queries if they detect there +# is at least an hash slot uncovered (no available node is serving it). +# This way if the cluster is partially down (for example a range of hash slots +# are no longer covered) all the cluster becomes, eventually, unavailable. +# It automatically returns available as soon as all the slots are covered again. +# +# However sometimes you want the subset of the cluster which is working, +# to continue to accept queries for the part of the key space that is still +# covered. In order to do so, just set the cluster-require-full-coverage +# option to no. +# +# cluster-require-full-coverage yes + +# This option, when set to yes, prevents replicas from trying to failover its +# master during master failures. However the master can still perform a +# manual failover, if forced to do so. +# +# This is useful in different scenarios, especially in the case of multiple +# data center operations, where we want one side to never be promoted if not +# in the case of a total DC failure. +# +# cluster-replica-no-failover no + +# This option, when set to yes, allows nodes to serve read traffic while the +# the cluster is in a down state, as long as it believes it owns the slots. +# +# This is useful for two cases. The first case is for when an application +# doesn't require consistency of data during node failures or network partitions. +# One example of this is a cache, where as long as the node has the data it +# should be able to serve it. +# +# The second use case is for configurations that don't meet the recommended +# three shards but want to enable cluster mode and scale later. A +# master outage in a 1 or 2 shard configuration causes a read/write outage to the +# entire cluster without this option set, with it set there is only a write outage. +# Without a quorum of masters, slot ownership will not change automatically. +# +# cluster-allow-reads-when-down no + +# In order to setup your cluster make sure to read the documentation +# available at http://redis.io web site. + +########################## CLUSTER DOCKER/NAT support ######################## + +# In certain deployments, Redis Cluster nodes address discovery fails, because +# addresses are NAT-ted or because ports are forwarded (the typical case is +# Docker and other containers). +# +# In order to make Redis Cluster working in such environments, a static +# configuration where each node knows its public address is needed. The +# following two options are used for this scope, and are: +# +# * cluster-announce-ip +# * cluster-announce-port +# * cluster-announce-bus-port +# +# Each instruct the node about its address, client port, and cluster message +# bus port. The information is then published in the header of the bus packets +# so that other nodes will be able to correctly map the address of the node +# publishing the information. +# +# If the above options are not used, the normal Redis Cluster auto-detection +# will be used instead. +# +# Note that when remapped, the bus port may not be at the fixed offset of +# clients port + 10000, so you can specify any port and bus-port depending +# on how they get remapped. If the bus-port is not set, a fixed offset of +# 10000 will be used as usually. +# +# Example: +# +# cluster-announce-ip 10.1.1.5 +# cluster-announce-port 6379 +# cluster-announce-bus-port 6380 + +################################## SLOW LOG ################################### + +# The Redis Slow Log is a system to log queries that exceeded a specified +# execution time. The execution time does not include the I/O operations +# like talking with the client, sending the reply and so forth, +# but just the time needed to actually execute the command (this is the only +# stage of command execution where the thread is blocked and can not serve +# other requests in the meantime). +# +# You can configure the slow log with two parameters: one tells Redis +# what is the execution time, in microseconds, to exceed in order for the +# command to get logged, and the other parameter is the length of the +# slow log. When a new command is logged the oldest one is removed from the +# queue of logged commands. + +# The following time is expressed in microseconds, so 1000000 is equivalent +# to one second. Note that a negative number disables the slow log, while +# a value of zero forces the logging of every command. +slowlog-log-slower-than 10000 + +# There is no limit to this length. Just be aware that it will consume memory. +# You can reclaim memory used by the slow log with SLOWLOG RESET. +slowlog-max-len 128 + +################################ LATENCY MONITOR ############################## + +# The Redis latency monitoring subsystem samples different operations +# at runtime in order to collect data related to possible sources of +# latency of a Redis instance. +# +# Via the LATENCY command this information is available to the user that can +# print graphs and obtain reports. +# +# The system only logs operations that were performed in a time equal or +# greater than the amount of milliseconds specified via the +# latency-monitor-threshold configuration directive. When its value is set +# to zero, the latency monitor is turned off. +# +# By default latency monitoring is disabled since it is mostly not needed +# if you don't have latency issues, and collecting data has a performance +# impact, that while very small, can be measured under big load. Latency +# monitoring can easily be enabled at runtime using the command +# "CONFIG SET latency-monitor-threshold " if needed. +latency-monitor-threshold 0 + +############################# EVENT NOTIFICATION ############################## + +# Redis can notify Pub/Sub clients about events happening in the key space. +# This feature is documented at http://redis.io/topics/notifications +# +# For instance if keyspace events notification is enabled, and a client +# performs a DEL operation on key "foo" stored in the Database 0, two +# messages will be published via Pub/Sub: +# +# PUBLISH __keyspace@0__:foo del +# PUBLISH __keyevent@0__:del foo +# +# It is possible to select the events that Redis will notify among a set +# of classes. Every class is identified by a single character: +# +# K Keyspace events, published with __keyspace@__ prefix. +# E Keyevent events, published with __keyevent@__ prefix. +# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... +# $ String commands +# l List commands +# s Set commands +# h Hash commands +# z Sorted set commands +# x Expired events (events generated every time a key expires) +# e Evicted events (events generated when a key is evicted for maxmemory) +# t Stream commands +# m Key-miss events (Note: It is not included in the 'A' class) +# A Alias for g$lshzxet, so that the "AKE" string means all the events +# (Except key-miss events which are excluded from 'A' due to their +# unique nature). +# +# The "notify-keyspace-events" takes as argument a string that is composed +# of zero or multiple characters. The empty string means that notifications +# are disabled. +# +# Example: to enable list and generic events, from the point of view of the +# event name, use: +# +# notify-keyspace-events Elg +# +# Example 2: to get the stream of the expired keys subscribing to channel +# name __keyevent@0__:expired use: +# +# notify-keyspace-events Ex +# +# By default all notifications are disabled because most users don't need +# this feature and the feature has some overhead. Note that if you don't +# specify at least one of K or E, no events will be delivered. +notify-keyspace-events "" + +############################### GOPHER SERVER ################################# + +# Redis contains an implementation of the Gopher protocol, as specified in +# the RFC 1436 (https://www.ietf.org/rfc/rfc1436.txt). +# +# The Gopher protocol was very popular in the late '90s. It is an alternative +# to the web, and the implementation both server and client side is so simple +# that the Redis server has just 100 lines of code in order to implement this +# support. +# +# What do you do with Gopher nowadays? Well Gopher never *really* died, and +# lately there is a movement in order for the Gopher more hierarchical content +# composed of just plain text documents to be resurrected. Some want a simpler +# internet, others believe that the mainstream internet became too much +# controlled, and it's cool to create an alternative space for people that +# want a bit of fresh air. +# +# Anyway for the 10nth birthday of the Redis, we gave it the Gopher protocol +# as a gift. +# +# --- HOW IT WORKS? --- +# +# The Redis Gopher support uses the inline protocol of Redis, and specifically +# two kind of inline requests that were anyway illegal: an empty request +# or any request that starts with "/" (there are no Redis commands starting +# with such a slash). Normal RESP2/RESP3 requests are completely out of the +# path of the Gopher protocol implementation and are served as usually as well. +# +# If you open a connection to Redis when Gopher is enabled and send it +# a string like "/foo", if there is a key named "/foo" it is served via the +# Gopher protocol. +# +# In order to create a real Gopher "hole" (the name of a Gopher site in Gopher +# talking), you likely need a script like the following: +# +# https://github.com/antirez/gopher2redis +# +# --- SECURITY WARNING --- +# +# If you plan to put Redis on the internet in a publicly accessible address +# to server Gopher pages MAKE SURE TO SET A PASSWORD to the instance. +# Once a password is set: +# +# 1. The Gopher server (when enabled, not by default) will still serve +# content via Gopher. +# 2. However other commands cannot be called before the client will +# authenticate. +# +# So use the 'requirepass' option to protect your instance. +# +# To enable Gopher support uncomment the following line and set +# the option from no (the default) to yes. +# +# gopher-enabled no + +############################### ADVANCED CONFIG ############################### + +# Hashes are encoded using a memory efficient data structure when they have a +# small number of entries, and the biggest entry does not exceed a given +# threshold. These thresholds can be configured using the following directives. +hash-max-ziplist-entries 512 +hash-max-ziplist-value 64 + +# Lists are also encoded in a special way to save a lot of space. +# The number of entries allowed per internal list node can be specified +# as a fixed maximum size or a maximum number of elements. +# For a fixed maximum size, use -5 through -1, meaning: +# -5: max size: 64 Kb <-- not recommended for normal workloads +# -4: max size: 32 Kb <-- not recommended +# -3: max size: 16 Kb <-- probably not recommended +# -2: max size: 8 Kb <-- good +# -1: max size: 4 Kb <-- good +# Positive numbers mean store up to _exactly_ that number of elements +# per list node. +# The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size), +# but if your use case is unique, adjust the settings as necessary. +list-max-ziplist-size -2 + +# Lists may also be compressed. +# Compress depth is the number of quicklist ziplist nodes from *each* side of +# the list to *exclude* from compression. The head and tail of the list +# are always uncompressed for fast push/pop operations. Settings are: +# 0: disable all list compression +# 1: depth 1 means "don't start compressing until after 1 node into the list, +# going from either the head or tail" +# So: [head]->node->node->...->node->[tail] +# [head], [tail] will always be uncompressed; inner nodes will compress. +# 2: [head]->[next]->node->node->...->node->[prev]->[tail] +# 2 here means: don't compress head or head->next or tail->prev or tail, +# but compress all nodes between them. +# 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail] +# etc. +list-compress-depth 0 + +# Sets have a special encoding in just one case: when a set is composed +# of just strings that happen to be integers in radix 10 in the range +# of 64 bit signed integers. +# The following configuration setting sets the limit in the size of the +# set in order to use this special memory saving encoding. +set-max-intset-entries 512 + +# Similarly to hashes and lists, sorted sets are also specially encoded in +# order to save a lot of space. This encoding is only used when the length and +# elements of a sorted set are below the following limits: +zset-max-ziplist-entries 128 +zset-max-ziplist-value 64 + +# HyperLogLog sparse representation bytes limit. The limit includes the +# 16 bytes header. When an HyperLogLog using the sparse representation crosses +# this limit, it is converted into the dense representation. +# +# A value greater than 16000 is totally useless, since at that point the +# dense representation is more memory efficient. +# +# The suggested value is ~ 3000 in order to have the benefits of +# the space efficient encoding without slowing down too much PFADD, +# which is O(N) with the sparse encoding. The value can be raised to +# ~ 10000 when CPU is not a concern, but space is, and the data set is +# composed of many HyperLogLogs with cardinality in the 0 - 15000 range. +hll-sparse-max-bytes 3000 + +# Streams macro node max size / items. The stream data structure is a radix +# tree of big nodes that encode multiple items inside. Using this configuration +# it is possible to configure how big a single node can be in bytes, and the +# maximum number of items it may contain before switching to a new node when +# appending new stream entries. If any of the following settings are set to +# zero, the limit is ignored, so for instance it is possible to set just a +# max entires limit by setting max-bytes to 0 and max-entries to the desired +# value. +stream-node-max-bytes 4096 +stream-node-max-entries 100 + +# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in +# order to help rehashing the main Redis hash table (the one mapping top-level +# keys to values). The hash table implementation Redis uses (see dict.c) +# performs a lazy rehashing: the more operation you run into a hash table +# that is rehashing, the more rehashing "steps" are performed, so if the +# server is idle the rehashing is never complete and some more memory is used +# by the hash table. +# +# The default is to use this millisecond 10 times every second in order to +# actively rehash the main dictionaries, freeing memory when possible. +# +# If unsure: +# use "activerehashing no" if you have hard latency requirements and it is +# not a good thing in your environment that Redis can reply from time to time +# to queries with 2 milliseconds delay. +# +# use "activerehashing yes" if you don't have such hard requirements but +# want to free memory asap when possible. +activerehashing yes + +# The client output buffer limits can be used to force disconnection of clients +# that are not reading data from the server fast enough for some reason (a +# common reason is that a Pub/Sub client can't consume messages as fast as the +# publisher can produce them). +# +# The limit can be set differently for the three different classes of clients: +# +# normal -> normal clients including MONITOR clients +# replica -> replica clients +# pubsub -> clients subscribed to at least one pubsub channel or pattern +# +# The syntax of every client-output-buffer-limit directive is the following: +# +# client-output-buffer-limit +# +# A client is immediately disconnected once the hard limit is reached, or if +# the soft limit is reached and remains reached for the specified number of +# seconds (continuously). +# So for instance if the hard limit is 32 megabytes and the soft limit is +# 16 megabytes / 10 seconds, the client will get disconnected immediately +# if the size of the output buffers reach 32 megabytes, but will also get +# disconnected if the client reaches 16 megabytes and continuously overcomes +# the limit for 10 seconds. +# +# By default normal clients are not limited because they don't receive data +# without asking (in a push way), but just after a request, so only +# asynchronous clients may create a scenario where data is requested faster +# than it can read. +# +# Instead there is a default limit for pubsub and replica clients, since +# subscribers and replicas receive data in a push fashion. +# +# Both the hard or the soft limit can be disabled by setting them to zero. +client-output-buffer-limit normal 0 0 0 +client-output-buffer-limit replica 256mb 64mb 60 +client-output-buffer-limit pubsub 32mb 8mb 60 + +# Client query buffers accumulate new commands. They are limited to a fixed +# amount by default in order to avoid that a protocol desynchronization (for +# instance due to a bug in the client) will lead to unbound memory usage in +# the query buffer. However you can configure it here if you have very special +# needs, such us huge multi/exec requests or alike. +# +# client-query-buffer-limit 1gb + +# In the Redis protocol, bulk requests, that are, elements representing single +# strings, are normally limited ot 512 mb. However you can change this limit +# here, but must be 1mb or greater +# +# proto-max-bulk-len 512mb + +# Redis calls an internal function to perform many background tasks, like +# closing connections of clients in timeout, purging expired keys that are +# never requested, and so forth. +# +# Not all tasks are performed with the same frequency, but Redis checks for +# tasks to perform according to the specified "hz" value. +# +# By default "hz" is set to 10. Raising the value will use more CPU when +# Redis is idle, but at the same time will make Redis more responsive when +# there are many keys expiring at the same time, and timeouts may be +# handled with more precision. +# +# The range is between 1 and 500, however a value over 100 is usually not +# a good idea. Most users should use the default of 10 and raise this up to +# 100 only in environments where very low latency is required. +hz 10 + +# Normally it is useful to have an HZ value which is proportional to the +# number of clients connected. This is useful in order, for instance, to +# avoid too many clients are processed for each background task invocation +# in order to avoid latency spikes. +# +# Since the default HZ value by default is conservatively set to 10, Redis +# offers, and enables by default, the ability to use an adaptive HZ value +# which will temporary raise when there are many connected clients. +# +# When dynamic HZ is enabled, the actual configured HZ will be used +# as a baseline, but multiples of the configured HZ value will be actually +# used as needed once more clients are connected. In this way an idle +# instance will use very little CPU time while a busy instance will be +# more responsive. +dynamic-hz yes + +# When a child rewrites the AOF file, if the following option is enabled +# the file will be fsync-ed every 32 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +aof-rewrite-incremental-fsync yes + +# When redis saves RDB file, if the following option is enabled +# the file will be fsync-ed every 32 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +rdb-save-incremental-fsync yes + +# Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good +# idea to start with the default settings and only change them after investigating +# how to improve the performances and how the keys LFU change over time, which +# is possible to inspect via the OBJECT FREQ command. +# +# There are two tunable parameters in the Redis LFU implementation: the +# counter logarithm factor and the counter decay time. It is important to +# understand what the two parameters mean before changing them. +# +# The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis +# uses a probabilistic increment with logarithmic behavior. Given the value +# of the old counter, when a key is accessed, the counter is incremented in +# this way: +# +# 1. A random number R between 0 and 1 is extracted. +# 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1). +# 3. The counter is incremented only if R < P. +# +# The default lfu-log-factor is 10. This is a table of how the frequency +# counter changes with a different number of accesses with different +# logarithmic factors: +# +# +--------+------------+------------+------------+------------+------------+ +# | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits | +# +--------+------------+------------+------------+------------+------------+ +# | 0 | 104 | 255 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 1 | 18 | 49 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 10 | 10 | 18 | 142 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 100 | 8 | 11 | 49 | 143 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# +# NOTE: The above table was obtained by running the following commands: +# +# redis-benchmark -n 1000000 incr foo +# redis-cli object freq foo +# +# NOTE 2: The counter initial value is 5 in order to give new objects a chance +# to accumulate hits. +# +# The counter decay time is the time, in minutes, that must elapse in order +# for the key counter to be divided by two (or decremented if it has a value +# less <= 10). +# +# The default value for the lfu-decay-time is 1. A Special value of 0 means to +# decay the counter every time it happens to be scanned. +# +# lfu-log-factor 10 +# lfu-decay-time 1 + +########################### ACTIVE DEFRAGMENTATION ####################### +# +# What is active defragmentation? +# ------------------------------- +# +# Active (online) defragmentation allows a Redis server to compact the +# spaces left between small allocations and deallocations of data in memory, +# thus allowing to reclaim back memory. +# +# Fragmentation is a natural process that happens with every allocator (but +# less so with Jemalloc, fortunately) and certain workloads. Normally a server +# restart is needed in order to lower the fragmentation, or at least to flush +# away all the data and create it again. However thanks to this feature +# implemented by Oran Agra for Redis 4.0 this process can happen at runtime +# in an "hot" way, while the server is running. +# +# Basically when the fragmentation is over a certain level (see the +# configuration options below) Redis will start to create new copies of the +# values in contiguous memory regions by exploiting certain specific Jemalloc +# features (in order to understand if an allocation is causing fragmentation +# and to allocate it in a better place), and at the same time, will release the +# old copies of the data. This process, repeated incrementally for all the keys +# will cause the fragmentation to drop back to normal values. +# +# Important things to understand: +# +# 1. This feature is disabled by default, and only works if you compiled Redis +# to use the copy of Jemalloc we ship with the source code of Redis. +# This is the default with Linux builds. +# +# 2. You never need to enable this feature if you don't have fragmentation +# issues. +# +# 3. Once you experience fragmentation, you can enable this feature when +# needed with the command "CONFIG SET activedefrag yes". +# +# The configuration parameters are able to fine tune the behavior of the +# defragmentation process. If you are not sure about what they mean it is +# a good idea to leave the defaults untouched. + +# Enabled active defragmentation +# activedefrag no + +# Minimum amount of fragmentation waste to start active defrag +# active-defrag-ignore-bytes 100mb + +# Minimum percentage of fragmentation to start active defrag +# active-defrag-threshold-lower 10 + +# Maximum percentage of fragmentation at which we use maximum effort +# active-defrag-threshold-upper 100 + +# Minimal effort for defrag in CPU percentage, to be used when the lower +# threshold is reached +# active-defrag-cycle-min 1 + +# Maximal effort for defrag in CPU percentage, to be used when the upper +# threshold is reached +# active-defrag-cycle-max 25 + +# Maximum number of set/hash/zset/list fields that will be processed from +# the main dictionary scan +# active-defrag-max-scan-fields 1000 + +# Jemalloc background thread for purging will be enabled by default +jemalloc-bg-thread yes + +# It is possible to pin different threads and processes of Redis to specific +# CPUs in your system, in order to maximize the performances of the server. +# This is useful both in order to pin different Redis threads in different +# CPUs, but also in order to make sure that multiple Redis instances running +# in the same host will be pinned to different CPUs. +# +# Normally you can do this using the "taskset" command, however it is also +# possible to this via Redis configuration directly, both in Linux and FreeBSD. +# +# You can pin the server/IO threads, bio threads, aof rewrite child process, and +# the bgsave child process. The syntax to specify the cpu list is the same as +# the taskset command: +# +# Set redis server/io threads to cpu affinity 0,2,4,6: +# server_cpulist 0-7:2 +# +# Set bio threads to cpu affinity 1,3: +# bio_cpulist 1,3 +# +# Set aof rewrite child process to cpu affinity 8,9,10,11: +# aof_rewrite_cpulist 8-11 +# +# Set bgsave child process to cpu affinity 1,10,11 +# bgsave_cpulist 1,10-11 \ No newline at end of file diff --git a/ptero_eggs/application/database/redis/redis-7/README.md b/ptero_eggs/application/database/redis/redis-7/README.md new file mode 100644 index 0000000..d425ff6 --- /dev/null +++ b/ptero_eggs/application/database/redis/redis-7/README.md @@ -0,0 +1,23 @@ +# Redis + +## From their [Website](https://redis.io/) + +Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. + +## Server Startup + +You must first authenticate before trying to execute commands, to do this run `AUTH ` (without the `<>`). This should be the same as the password set in the `SERVER_PASSWORD` variable. + +## Minimum RAM warning + +It's recommended to have 4gb of RAM for redis + +See here + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Server | 6379 | diff --git a/ptero_eggs/application/database/redis/redis-7/egg-redis-7.json b/ptero_eggs/application/database/redis/redis-7/egg-redis-7.json new file mode 100644 index 0000000..f6fca35 --- /dev/null +++ b/ptero_eggs/application/database/redis/redis-7/egg-redis-7.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2025-10-03T14:09:30+02:00", + "name": "Redis-7", + "author": "parker@parkervcp.com", + "description": "Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker. It supports data structures such as strings, hashes, lists, sets, sorted sets with range queries, bitmaps, hyperloglogs, geospatial indexes with radius queries and streams.", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:redis_7": "ghcr.io\/ptero-eggs\/yolks:redis_7" + }, + "file_denylist": [], + "startup": "\/usr\/local\/bin\/redis-server \/home\/container\/redis.conf --save 60 1 --dir \/home\/container\/ --bind 0.0.0.0 --port {{SERVER_PORT}} --requirepass {{SERVER_PASSWORD}} --maxmemory {{SERVER_MEMORY}}mb --daemonize yes && redis-cli -p {{SERVER_PORT}}; redis-cli -p {{SERVER_PORT}} -a {{SERVER_PASSWORD}} shutdown save", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"Configuration loaded\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/ash\r\n# Redis Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\n\r\napk add --no-cache curl\r\n\r\nif [ ! -d \/mnt\/server ]; then\r\n mkdir \/mnt\/server\/\r\nfi\r\n\r\ncd \/mnt\/server\/\r\n\r\nif [ ! -d \/mnt\/server\/redis.conf ]; then\r\n curl https:\/\/raw.githubusercontent.com\/Ptero-Eggs\/application-eggs\/main\/database\/redis\/redis-7\/redis.conf -o redis.conf\r\nfi\r\n\r\nsleep 5\r\necho -e \"Install complete. Made this to not have issues.\"", + "container": "ghcr.io\/ptero-eggs\/installers:alpine", + "entrypoint": "ash" + } + }, + "variables": [ + { + "name": "Redis Password", + "description": "The password redis should use to secure the server.", + "env_variable": "SERVER_PASSWORD", + "default_value": "P@55w0rd", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/redis/redis-7/redis.conf b/ptero_eggs/application/database/redis/redis-7/redis.conf new file mode 100644 index 0000000..c1d7622 --- /dev/null +++ b/ptero_eggs/application/database/redis/redis-7/redis.conf @@ -0,0 +1,2276 @@ +# Redis configuration file example. +# +# Note that in order to read the configuration file, Redis must be +# started with the file path as first argument: +# +# ./redis-server /path/to/redis.conf + +# Note on units: when memory size is needed, it is possible to specify +# it in the usual form of 1k 5GB 4M and so forth: +# +# 1k => 1000 bytes +# 1kb => 1024 bytes +# 1m => 1000000 bytes +# 1mb => 1024*1024 bytes +# 1g => 1000000000 bytes +# 1gb => 1024*1024*1024 bytes +# +# units are case insensitive so 1GB 1Gb 1gB are all the same. + +################################## INCLUDES ################################### + +# Include one or more other config files here. This is useful if you +# have a standard template that goes to all Redis servers but also need +# to customize a few per-server settings. Include files can include +# other files, so use this wisely. +# +# Note that option "include" won't be rewritten by command "CONFIG REWRITE" +# from admin or Redis Sentinel. Since Redis always uses the last processed +# line as value of a configuration directive, you'd better put includes +# at the beginning of this file to avoid overwriting config change at runtime. +# +# If instead you are interested in using includes to override configuration +# options, it is better to use include as the last line. +# +# Included paths may contain wildcards. All files matching the wildcards will +# be included in alphabetical order. +# Note that if an include path contains a wildcards but no files match it when +# the server is started, the include statement will be ignored and no error will +# be emitted. It is safe, therefore, to include wildcard files from empty +# directories. +# +# include /path/to/local.conf +# include /path/to/other.conf +# include /path/to/fragments/*.conf +# + +################################## MODULES ##################################### + +# Load modules at startup. If the server is not able to load modules +# it will abort. It is possible to use multiple loadmodule directives. +# +# loadmodule /path/to/my_module.so +# loadmodule /path/to/other_module.so + +################################## NETWORK ##################################### + +# By default, if no "bind" configuration directive is specified, Redis listens +# for connections from all available network interfaces on the host machine. +# It is possible to listen to just one or multiple selected interfaces using +# the "bind" configuration directive, followed by one or more IP addresses. +# Each address can be prefixed by "-", which means that redis will not fail to +# start if the address is not available. Being not available only refers to +# addresses that does not correspond to any network interface. Addresses that +# are already in use will always fail, and unsupported protocols will always BE +# silently skipped. +# +# Examples: +# +# bind 192.168.1.100 10.0.0.1 # listens on two specific IPv4 addresses +# bind 127.0.0.1 ::1 # listens on loopback IPv4 and IPv6 +# bind * -::* # like the default, all available interfaces +# +# ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the +# internet, binding to all the interfaces is dangerous and will expose the +# instance to everybody on the internet. So by default we uncomment the +# following bind directive, that will force Redis to listen only on the +# IPv4 and IPv6 (if available) loopback interface addresses (this means Redis +# will only be able to accept client connections from the same host that it is +# running on). +# +# IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES +# COMMENT OUT THE FOLLOWING LINE. +# +# You will also need to set a password unless you explicitly disable protected +# mode. +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +bind 127.0.0.1 -::1 + +# By default, outgoing connections (from replica to master, from Sentinel to +# instances, cluster bus, etc.) are not bound to a specific local address. In +# most cases, this means the operating system will handle that based on routing +# and the interface through which the connection goes out. +# +# Using bind-source-addr it is possible to configure a specific address to bind +# to, which may also affect how the connection gets routed. +# +# Example: +# +# bind-source-addr 10.0.0.1 + +# Protected mode is a layer of security protection, in order to avoid that +# Redis instances left open on the internet are accessed and exploited. +# +# When protected mode is on and the default user has no password, the server +# only accepts local connections from the IPv4 address (127.0.0.1), IPv6 address +# (::1) or Unix domain sockets. +# +# By default protected mode is enabled. You should disable it only if +# you are sure you want clients from other hosts to connect to Redis +# even if no authentication is configured. +protected-mode yes + +# Redis uses default hardened security configuration directives to reduce the +# attack surface on innocent users. Therefore, several sensitive configuration +# directives are immutable, and some potentially-dangerous commands are blocked. +# +# Configuration directives that control files that Redis writes to (e.g., 'dir' +# and 'dbfilename') and that aren't usually modified during runtime +# are protected by making them immutable. +# +# Commands that can increase the attack surface of Redis and that aren't usually +# called by users are blocked by default. +# +# These can be exposed to either all connections or just local ones by setting +# each of the configs listed below to either of these values: +# +# no - Block for any connection (remain immutable) +# yes - Allow for any connection (no protection) +# local - Allow only for local connections. Ones originating from the +# IPv4 address (127.0.0.1), IPv6 address (::1) or Unix domain sockets. +# +# enable-protected-configs no +# enable-debug-command no +# enable-module-command no + +# Accept connections on the specified port, default is 6379 (IANA #815344). +# If port 0 is specified Redis will not listen on a TCP socket. +port 6379 + +# TCP listen() backlog. +# +# In high requests-per-second environments you need a high backlog in order +# to avoid slow clients connection issues. Note that the Linux kernel +# will silently truncate it to the value of /proc/sys/net/core/somaxconn so +# make sure to raise both the value of somaxconn and tcp_max_syn_backlog +# in order to get the desired effect. +tcp-backlog 511 + +# Unix socket. +# +# Specify the path for the Unix socket that will be used to listen for +# incoming connections. There is no default, so Redis will not listen +# on a unix socket when not specified. +# +# unixsocket /run/redis.sock +# unixsocketperm 700 + +# Close the connection after a client is idle for N seconds (0 to disable) +timeout 0 + +# TCP keepalive. +# +# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence +# of communication. This is useful for two reasons: +# +# 1) Detect dead peers. +# 2) Force network equipment in the middle to consider the connection to be +# alive. +# +# On Linux, the specified value (in seconds) is the period used to send ACKs. +# Note that to close the connection the double of the time is needed. +# On other kernels the period depends on the kernel configuration. +# +# A reasonable value for this option is 300 seconds, which is the new +# Redis default starting with Redis 3.2.1. +tcp-keepalive 300 + +# Apply OS-specific mechanism to mark the listening socket with the specified +# ID, to support advanced routing and filtering capabilities. +# +# On Linux, the ID represents a connection mark. +# On FreeBSD, the ID represents a socket cookie ID. +# On OpenBSD, the ID represents a route table ID. +# +# The default value is 0, which implies no marking is required. +# socket-mark-id 0 + +################################# TLS/SSL ##################################### + +# By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration +# directive can be used to define TLS-listening ports. To enable TLS on the +# default port, use: +# +# port 0 +# tls-port 6379 + +# Configure a X.509 certificate and private key to use for authenticating the +# server to connected clients, masters or cluster peers. These files should be +# PEM formatted. +# +# tls-cert-file redis.crt +# tls-key-file redis.key +# +# If the key file is encrypted using a passphrase, it can be included here +# as well. +# +# tls-key-file-pass secret + +# Normally Redis uses the same certificate for both server functions (accepting +# connections) and client functions (replicating from a master, establishing +# cluster bus connections, etc.). +# +# Sometimes certificates are issued with attributes that designate them as +# client-only or server-only certificates. In that case it may be desired to use +# different certificates for incoming (server) and outgoing (client) +# connections. To do that, use the following directives: +# +# tls-client-cert-file client.crt +# tls-client-key-file client.key +# +# If the key file is encrypted using a passphrase, it can be included here +# as well. +# +# tls-client-key-file-pass secret + +# Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange, +# required by older versions of OpenSSL (<3.0). Newer versions do not require +# this configuration and recommend against it. +# +# tls-dh-params-file redis.dh + +# Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL +# clients and peers. Redis requires an explicit configuration of at least one +# of these, and will not implicitly use the system wide configuration. +# +# tls-ca-cert-file ca.crt +# tls-ca-cert-dir /etc/ssl/certs + +# By default, clients (including replica servers) on a TLS port are required +# to authenticate using valid client side certificates. +# +# If "no" is specified, client certificates are not required and not accepted. +# If "optional" is specified, client certificates are accepted and must be +# valid if provided, but are not required. +# +# tls-auth-clients no +# tls-auth-clients optional + +# By default, a Redis replica does not attempt to establish a TLS connection +# with its master. +# +# Use the following directive to enable TLS on replication links. +# +# tls-replication yes + +# By default, the Redis Cluster bus uses a plain TCP connection. To enable +# TLS for the bus protocol, use the following directive: +# +# tls-cluster yes + +# By default, only TLSv1.2 and TLSv1.3 are enabled and it is highly recommended +# that older formally deprecated versions are kept disabled to reduce the attack surface. +# You can explicitly specify TLS versions to support. +# Allowed values are case insensitive and include "TLSv1", "TLSv1.1", "TLSv1.2", +# "TLSv1.3" (OpenSSL >= 1.1.1) or any combination. +# To enable only TLSv1.2 and TLSv1.3, use: +# +# tls-protocols "TLSv1.2 TLSv1.3" + +# Configure allowed ciphers. See the ciphers(1ssl) manpage for more information +# about the syntax of this string. +# +# Note: this configuration applies only to <= TLSv1.2. +# +# tls-ciphers DEFAULT:!MEDIUM + +# Configure allowed TLSv1.3 ciphersuites. See the ciphers(1ssl) manpage for more +# information about the syntax of this string, and specifically for TLSv1.3 +# ciphersuites. +# +# tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256 + +# When choosing a cipher, use the server's preference instead of the client +# preference. By default, the server follows the client's preference. +# +# tls-prefer-server-ciphers yes + +# By default, TLS session caching is enabled to allow faster and less expensive +# reconnections by clients that support it. Use the following directive to disable +# caching. +# +# tls-session-caching no + +# Change the default number of TLS sessions cached. A zero value sets the cache +# to unlimited size. The default size is 20480. +# +# tls-session-cache-size 5000 + +# Change the default timeout of cached TLS sessions. The default timeout is 300 +# seconds. +# +# tls-session-cache-timeout 60 + +################################# GENERAL ##################################### + +# By default Redis does not run as a daemon. Use 'yes' if you need it. +# Note that Redis will write a pid file in /var/run/redis.pid when daemonized. +# When Redis is supervised by upstart or systemd, this parameter has no impact. +daemonize no + +# If you run Redis from upstart or systemd, Redis can interact with your +# supervision tree. Options: +# supervised no - no supervision interaction +# supervised upstart - signal upstart by putting Redis into SIGSTOP mode +# requires "expect stop" in your upstart job config +# supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET +# on startup, and updating Redis status on a regular +# basis. +# supervised auto - detect upstart or systemd method based on +# UPSTART_JOB or NOTIFY_SOCKET environment variables +# Note: these supervision methods only signal "process is ready." +# They do not enable continuous pings back to your supervisor. +# +# The default is "no". To run under upstart/systemd, you can simply uncomment +# the line below: +# +# supervised auto + +# If a pid file is specified, Redis writes it where specified at startup +# and removes it at exit. +# +# When the server runs non daemonized, no pid file is created if none is +# specified in the configuration. When the server is daemonized, the pid file +# is used even if not specified, defaulting to "/var/run/redis.pid". +# +# Creating a pid file is best effort: if Redis is not able to create it +# nothing bad happens, the server will start and run normally. +# +# Note that on modern Linux systems "/run/redis.pid" is more conforming +# and should be used instead. +pidfile /var/run/redis_6379.pid + +# Specify the server verbosity level. +# This can be one of: +# debug (a lot of information, useful for development/testing) +# verbose (many rarely useful info, but not a mess like the debug level) +# notice (moderately verbose, what you want in production probably) +# warning (only very important / critical messages are logged) +loglevel notice + +# Specify the log file name. Also the empty string can be used to force +# Redis to log on the standard output. Note that if you use standard +# output for logging but daemonize, logs will be sent to /dev/null +logfile "" + +# To enable logging to the system logger, just set 'syslog-enabled' to yes, +# and optionally update the other syslog parameters to suit your needs. +# syslog-enabled no + +# Specify the syslog identity. +# syslog-ident redis + +# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. +# syslog-facility local0 + +# To disable the built in crash log, which will possibly produce cleaner core +# dumps when they are needed, uncomment the following: +# +# crash-log-enabled no + +# To disable the fast memory check that's run as part of the crash log, which +# will possibly let redis terminate sooner, uncomment the following: +# +# crash-memcheck-enabled no + +# Set the number of databases. The default database is DB 0, you can select +# a different one on a per-connection basis using SELECT where +# dbid is a number between 0 and 'databases'-1 +databases 16 + +# By default Redis shows an ASCII art logo only when started to log to the +# standard output and if the standard output is a TTY and syslog logging is +# disabled. Basically this means that normally a logo is displayed only in +# interactive sessions. +# +# However it is possible to force the pre-4.0 behavior and always show a +# ASCII art logo in startup logs by setting the following option to yes. +always-show-logo no + +# By default, Redis modifies the process title (as seen in 'top' and 'ps') to +# provide some runtime information. It is possible to disable this and leave +# the process name as executed by setting the following to no. +set-proc-title yes + +# When changing the process title, Redis uses the following template to construct +# the modified title. +# +# Template variables are specified in curly brackets. The following variables are +# supported: +# +# {title} Name of process as executed if parent, or type of child process. +# {listen-addr} Bind address or '*' followed by TCP or TLS port listening on, or +# Unix socket if only that's available. +# {server-mode} Special mode, i.e. "[sentinel]" or "[cluster]". +# {port} TCP port listening on, or 0. +# {tls-port} TLS port listening on, or 0. +# {unixsocket} Unix domain socket listening on, or "". +# {config-file} Name of configuration file used. +# +proc-title-template "{title} {listen-addr} {server-mode}" + +################################ SNAPSHOTTING ################################ + +# Save the DB to disk. +# +# save [ ...] +# +# Redis will save the DB if the given number of seconds elapsed and it +# surpassed the given number of write operations against the DB. +# +# Snapshotting can be completely disabled with a single empty string argument +# as in following example: +# +# save "" +# +# Unless specified otherwise, by default Redis will save the DB: +# * After 3600 seconds (an hour) if at least 1 change was performed +# * After 300 seconds (5 minutes) if at least 100 changes were performed +# * After 60 seconds if at least 10000 changes were performed +# +# You can set these explicitly by uncommenting the following line. +# +# save 3600 1 300 100 60 10000 + +# By default Redis will stop accepting writes if RDB snapshots are enabled +# (at least one save point) and the latest background save failed. +# This will make the user aware (in a hard way) that data is not persisting +# on disk properly, otherwise chances are that no one will notice and some +# disaster will happen. +# +# If the background saving process will start working again Redis will +# automatically allow writes again. +# +# However if you have setup your proper monitoring of the Redis server +# and persistence, you may want to disable this feature so that Redis will +# continue to work as usual even if there are problems with disk, +# permissions, and so forth. +stop-writes-on-bgsave-error yes + +# Compress string objects using LZF when dump .rdb databases? +# By default compression is enabled as it's almost always a win. +# If you want to save some CPU in the saving child set it to 'no' but +# the dataset will likely be bigger if you have compressible values or keys. +rdbcompression yes + +# Since version 5 of RDB a CRC64 checksum is placed at the end of the file. +# This makes the format more resistant to corruption but there is a performance +# hit to pay (around 10%) when saving and loading RDB files, so you can disable it +# for maximum performances. +# +# RDB files created with checksum disabled have a checksum of zero that will +# tell the loading code to skip the check. +rdbchecksum yes + +# Enables or disables full sanitization checks for ziplist and listpack etc when +# loading an RDB or RESTORE payload. This reduces the chances of a assertion or +# crash later on while processing commands. +# Options: +# no - Never perform full sanitization +# yes - Always perform full sanitization +# clients - Perform full sanitization only for user connections. +# Excludes: RDB files, RESTORE commands received from the master +# connection, and client connections which have the +# skip-sanitize-payload ACL flag. +# The default should be 'clients' but since it currently affects cluster +# resharding via MIGRATE, it is temporarily set to 'no' by default. +# +# sanitize-dump-payload no + +# The filename where to dump the DB +dbfilename dump.rdb + +# Remove RDB files used by replication in instances without persistence +# enabled. By default this option is disabled, however there are environments +# where for regulations or other security concerns, RDB files persisted on +# disk by masters in order to feed replicas, or stored on disk by replicas +# in order to load them for the initial synchronization, should be deleted +# ASAP. Note that this option ONLY WORKS in instances that have both AOF +# and RDB persistence disabled, otherwise is completely ignored. +# +# An alternative (and sometimes better) way to obtain the same effect is +# to use diskless replication on both master and replicas instances. However +# in the case of replicas, diskless is not always an option. +rdb-del-sync-files no + +# The working directory. +# +# The DB will be written inside this directory, with the filename specified +# above using the 'dbfilename' configuration directive. +# +# The Append Only File will also be created inside this directory. +# +# Note that you must specify a directory here, not a file name. +dir ./ + +################################# REPLICATION ################################# + +# Master-Replica replication. Use replicaof to make a Redis instance a copy of +# another Redis server. A few things to understand ASAP about Redis replication. +# +# +------------------+ +---------------+ +# | Master | ---> | Replica | +# | (receive writes) | | (exact copy) | +# +------------------+ +---------------+ +# +# 1) Redis replication is asynchronous, but you can configure a master to +# stop accepting writes if it appears to be not connected with at least +# a given number of replicas. +# 2) Redis replicas are able to perform a partial resynchronization with the +# master if the replication link is lost for a relatively small amount of +# time. You may want to configure the replication backlog size (see the next +# sections of this file) with a sensible value depending on your needs. +# 3) Replication is automatic and does not need user intervention. After a +# network partition replicas automatically try to reconnect to masters +# and resynchronize with them. +# +# replicaof + +# If the master is password protected (using the "requirepass" configuration +# directive below) it is possible to tell the replica to authenticate before +# starting the replication synchronization process, otherwise the master will +# refuse the replica request. +# +# masterauth +# +# However this is not enough if you are using Redis ACLs (for Redis version +# 6 or greater), and the default user is not capable of running the PSYNC +# command and/or other commands needed for replication. In this case it's +# better to configure a special user to use with replication, and specify the +# masteruser configuration as such: +# +# masteruser +# +# When masteruser is specified, the replica will authenticate against its +# master using the new AUTH form: AUTH . + +# When a replica loses its connection with the master, or when the replication +# is still in progress, the replica can act in two different ways: +# +# 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will +# still reply to client requests, possibly with out of date data, or the +# data set may just be empty if this is the first synchronization. +# +# 2) If replica-serve-stale-data is set to 'no' the replica will reply with error +# "MASTERDOWN Link with MASTER is down and replica-serve-stale-data is set to 'no'" +# to all data access commands, excluding commands such as: +# INFO, REPLICAOF, AUTH, SHUTDOWN, REPLCONF, ROLE, CONFIG, SUBSCRIBE, +# UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB, COMMAND, POST, +# HOST and LATENCY. +# +replica-serve-stale-data yes + +# You can configure a replica instance to accept writes or not. Writing against +# a replica instance may be useful to store some ephemeral data (because data +# written on a replica will be easily deleted after resync with the master) but +# may also cause problems if clients are writing to it because of a +# misconfiguration. +# +# Since Redis 2.6 by default replicas are read-only. +# +# Note: read only replicas are not designed to be exposed to untrusted clients +# on the internet. It's just a protection layer against misuse of the instance. +# Still a read only replica exports by default all the administrative commands +# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve +# security of read only replicas using 'rename-command' to shadow all the +# administrative / dangerous commands. +replica-read-only yes + +# Replication SYNC strategy: disk or socket. +# +# New replicas and reconnecting replicas that are not able to continue the +# replication process just receiving differences, need to do what is called a +# "full synchronization". An RDB file is transmitted from the master to the +# replicas. +# +# The transmission can happen in two different ways: +# +# 1) Disk-backed: The Redis master creates a new process that writes the RDB +# file on disk. Later the file is transferred by the parent +# process to the replicas incrementally. +# 2) Diskless: The Redis master creates a new process that directly writes the +# RDB file to replica sockets, without touching the disk at all. +# +# With disk-backed replication, while the RDB file is generated, more replicas +# can be queued and served with the RDB file as soon as the current child +# producing the RDB file finishes its work. With diskless replication instead +# once the transfer starts, new replicas arriving will be queued and a new +# transfer will start when the current one terminates. +# +# When diskless replication is used, the master waits a configurable amount of +# time (in seconds) before starting the transfer in the hope that multiple +# replicas will arrive and the transfer can be parallelized. +# +# With slow disks and fast (large bandwidth) networks, diskless replication +# works better. +repl-diskless-sync yes + +# When diskless replication is enabled, it is possible to configure the delay +# the server waits in order to spawn the child that transfers the RDB via socket +# to the replicas. +# +# This is important since once the transfer starts, it is not possible to serve +# new replicas arriving, that will be queued for the next RDB transfer, so the +# server waits a delay in order to let more replicas arrive. +# +# The delay is specified in seconds, and by default is 5 seconds. To disable +# it entirely just set it to 0 seconds and the transfer will start ASAP. +repl-diskless-sync-delay 5 + +# When diskless replication is enabled with a delay, it is possible to let +# the replication start before the maximum delay is reached if the maximum +# number of replicas expected have connected. Default of 0 means that the +# maximum is not defined and Redis will wait the full delay. +repl-diskless-sync-max-replicas 0 + +# ----------------------------------------------------------------------------- +# WARNING: RDB diskless load is experimental. Since in this setup the replica +# does not immediately store an RDB on disk, it may cause data loss during +# failovers. RDB diskless load + Redis modules not handling I/O reads may also +# cause Redis to abort in case of I/O errors during the initial synchronization +# stage with the master. Use only if you know what you are doing. +# ----------------------------------------------------------------------------- +# +# Replica can load the RDB it reads from the replication link directly from the +# socket, or store the RDB to a file and read that file after it was completely +# received from the master. +# +# In many cases the disk is slower than the network, and storing and loading +# the RDB file may increase replication time (and even increase the master's +# Copy on Write memory and replica buffers). +# However, parsing the RDB file directly from the socket may mean that we have +# to flush the contents of the current database before the full rdb was +# received. For this reason we have the following options: +# +# "disabled" - Don't use diskless load (store the rdb file to the disk first) +# "on-empty-db" - Use diskless load only when it is completely safe. +# "swapdb" - Keep current db contents in RAM while parsing the data directly +# from the socket. Replicas in this mode can keep serving current +# data set while replication is in progress, except for cases where +# they can't recognize master as having a data set from same +# replication history. +# Note that this requires sufficient memory, if you don't have it, +# you risk an OOM kill. +repl-diskless-load disabled + +# Master send PINGs to its replicas in a predefined interval. It's possible to +# change this interval with the repl_ping_replica_period option. The default +# value is 10 seconds. +# +# repl-ping-replica-period 10 + +# The following option sets the replication timeout for: +# +# 1) Bulk transfer I/O during SYNC, from the point of view of replica. +# 2) Master timeout from the point of view of replicas (data, pings). +# 3) Replica timeout from the point of view of masters (REPLCONF ACK pings). +# +# It is important to make sure that this value is greater than the value +# specified for repl-ping-replica-period otherwise a timeout will be detected +# every time there is low traffic between the master and the replica. The default +# value is 60 seconds. +# +# repl-timeout 60 + +# Disable TCP_NODELAY on the replica socket after SYNC? +# +# If you select "yes" Redis will use a smaller number of TCP packets and +# less bandwidth to send data to replicas. But this can add a delay for +# the data to appear on the replica side, up to 40 milliseconds with +# Linux kernels using a default configuration. +# +# If you select "no" the delay for data to appear on the replica side will +# be reduced but more bandwidth will be used for replication. +# +# By default we optimize for low latency, but in very high traffic conditions +# or when the master and replicas are many hops away, turning this to "yes" may +# be a good idea. +repl-disable-tcp-nodelay no + +# Set the replication backlog size. The backlog is a buffer that accumulates +# replica data when replicas are disconnected for some time, so that when a +# replica wants to reconnect again, often a full resync is not needed, but a +# partial resync is enough, just passing the portion of data the replica +# missed while disconnected. +# +# The bigger the replication backlog, the longer the replica can endure the +# disconnect and later be able to perform a partial resynchronization. +# +# The backlog is only allocated if there is at least one replica connected. +# +# repl-backlog-size 1mb + +# After a master has no connected replicas for some time, the backlog will be +# freed. The following option configures the amount of seconds that need to +# elapse, starting from the time the last replica disconnected, for the backlog +# buffer to be freed. +# +# Note that replicas never free the backlog for timeout, since they may be +# promoted to masters later, and should be able to correctly "partially +# resynchronize" with other replicas: hence they should always accumulate backlog. +# +# A value of 0 means to never release the backlog. +# +# repl-backlog-ttl 3600 + +# The replica priority is an integer number published by Redis in the INFO +# output. It is used by Redis Sentinel in order to select a replica to promote +# into a master if the master is no longer working correctly. +# +# A replica with a low priority number is considered better for promotion, so +# for instance if there are three replicas with priority 10, 100, 25 Sentinel +# will pick the one with priority 10, that is the lowest. +# +# However a special priority of 0 marks the replica as not able to perform the +# role of master, so a replica with priority of 0 will never be selected by +# Redis Sentinel for promotion. +# +# By default the priority is 100. +replica-priority 100 + +# The propagation error behavior controls how Redis will behave when it is +# unable to handle a command being processed in the replication stream from a master +# or processed while reading from an AOF file. Errors that occur during propagation +# are unexpected, and can cause data inconsistency. However, there are edge cases +# in earlier versions of Redis where it was possible for the server to replicate or persist +# commands that would fail on future versions. For this reason the default behavior +# is to ignore such errors and continue processing commands. +# +# If an application wants to ensure there is no data divergence, this configuration +# should be set to 'panic' instead. The value can also be set to 'panic-on-replicas' +# to only panic when a replica encounters an error on the replication stream. One of +# these two panic values will become the default value in the future once there are +# sufficient safety mechanisms in place to prevent false positive crashes. +# +# propagation-error-behavior ignore + +# Replica ignore disk write errors controls the behavior of a replica when it is +# unable to persist a write command received from its master to disk. By default, +# this configuration is set to 'no' and will crash the replica in this condition. +# It is not recommended to change this default, however in order to be compatible +# with older versions of Redis this config can be toggled to 'yes' which will just +# log a warning and execute the write command it got from the master. +# +# replica-ignore-disk-write-errors no + +# ----------------------------------------------------------------------------- +# By default, Redis Sentinel includes all replicas in its reports. A replica +# can be excluded from Redis Sentinel's announcements. An unannounced replica +# will be ignored by the 'sentinel replicas ' command and won't be +# exposed to Redis Sentinel's clients. +# +# This option does not change the behavior of replica-priority. Even with +# replica-announced set to 'no', the replica can be promoted to master. To +# prevent this behavior, set replica-priority to 0. +# +# replica-announced yes + +# It is possible for a master to stop accepting writes if there are less than +# N replicas connected, having a lag less or equal than M seconds. +# +# The N replicas need to be in "online" state. +# +# The lag in seconds, that must be <= the specified value, is calculated from +# the last ping received from the replica, that is usually sent every second. +# +# This option does not GUARANTEE that N replicas will accept the write, but +# will limit the window of exposure for lost writes in case not enough replicas +# are available, to the specified number of seconds. +# +# For example to require at least 3 replicas with a lag <= 10 seconds use: +# +# min-replicas-to-write 3 +# min-replicas-max-lag 10 +# +# Setting one or the other to 0 disables the feature. +# +# By default min-replicas-to-write is set to 0 (feature disabled) and +# min-replicas-max-lag is set to 10. + +# A Redis master is able to list the address and port of the attached +# replicas in different ways. For example the "INFO replication" section +# offers this information, which is used, among other tools, by +# Redis Sentinel in order to discover replica instances. +# Another place where this info is available is in the output of the +# "ROLE" command of a master. +# +# The listed IP address and port normally reported by a replica is +# obtained in the following way: +# +# IP: The address is auto detected by checking the peer address +# of the socket used by the replica to connect with the master. +# +# Port: The port is communicated by the replica during the replication +# handshake, and is normally the port that the replica is using to +# listen for connections. +# +# However when port forwarding or Network Address Translation (NAT) is +# used, the replica may actually be reachable via different IP and port +# pairs. The following two options can be used by a replica in order to +# report to its master a specific set of IP and port, so that both INFO +# and ROLE will report those values. +# +# There is no need to use both the options if you need to override just +# the port or the IP address. +# +# replica-announce-ip 5.5.5.5 +# replica-announce-port 1234 + +############################### KEYS TRACKING ################################# + +# Redis implements server assisted support for client side caching of values. +# This is implemented using an invalidation table that remembers, using +# a radix key indexed by key name, what clients have which keys. In turn +# this is used in order to send invalidation messages to clients. Please +# check this page to understand more about the feature: +# +# https://redis.io/topics/client-side-caching +# +# When tracking is enabled for a client, all the read only queries are assumed +# to be cached: this will force Redis to store information in the invalidation +# table. When keys are modified, such information is flushed away, and +# invalidation messages are sent to the clients. However if the workload is +# heavily dominated by reads, Redis could use more and more memory in order +# to track the keys fetched by many clients. +# +# For this reason it is possible to configure a maximum fill value for the +# invalidation table. By default it is set to 1M of keys, and once this limit +# is reached, Redis will start to evict keys in the invalidation table +# even if they were not modified, just to reclaim memory: this will in turn +# force the clients to invalidate the cached values. Basically the table +# maximum size is a trade off between the memory you want to spend server +# side to track information about who cached what, and the ability of clients +# to retain cached objects in memory. +# +# If you set the value to 0, it means there are no limits, and Redis will +# retain as many keys as needed in the invalidation table. +# In the "stats" INFO section, you can find information about the number of +# keys in the invalidation table at every given moment. +# +# Note: when key tracking is used in broadcasting mode, no memory is used +# in the server side so this setting is useless. +# +# tracking-table-max-keys 1000000 + +################################## SECURITY ################################### + +# Warning: since Redis is pretty fast, an outside user can try up to +# 1 million passwords per second against a modern box. This means that you +# should use very strong passwords, otherwise they will be very easy to break. +# Note that because the password is really a shared secret between the client +# and the server, and should not be memorized by any human, the password +# can be easily a long string from /dev/urandom or whatever, so by using a +# long and unguessable password no brute force attack will be possible. + +# Redis ACL users are defined in the following format: +# +# user ... acl rules ... +# +# For example: +# +# user worker +@list +@connection ~jobs:* on >ffa9203c493aa99 +# +# The special username "default" is used for new connections. If this user +# has the "nopass" rule, then new connections will be immediately authenticated +# as the "default" user without the need of any password provided via the +# AUTH command. Otherwise if the "default" user is not flagged with "nopass" +# the connections will start in not authenticated state, and will require +# AUTH (or the HELLO command AUTH option) in order to be authenticated and +# start to work. +# +# The ACL rules that describe what a user can do are the following: +# +# on Enable the user: it is possible to authenticate as this user. +# off Disable the user: it's no longer possible to authenticate +# with this user, however the already authenticated connections +# will still work. +# skip-sanitize-payload RESTORE dump-payload sanitization is skipped. +# sanitize-payload RESTORE dump-payload is sanitized (default). +# + Allow the execution of that command. +# May be used with `|` for allowing subcommands (e.g "+config|get") +# - Disallow the execution of that command. +# May be used with `|` for blocking subcommands (e.g "-config|set") +# +@ Allow the execution of all the commands in such category +# with valid categories are like @admin, @set, @sortedset, ... +# and so forth, see the full list in the server.c file where +# the Redis command table is described and defined. +# The special category @all means all the commands, but currently +# present in the server, and that will be loaded in the future +# via modules. +# +|first-arg Allow a specific first argument of an otherwise +# disabled command. It is only supported on commands with +# no sub-commands, and is not allowed as negative form +# like -SELECT|1, only additive starting with "+". This +# feature is deprecated and may be removed in the future. +# allcommands Alias for +@all. Note that it implies the ability to execute +# all the future commands loaded via the modules system. +# nocommands Alias for -@all. +# ~ Add a pattern of keys that can be mentioned as part of +# commands. For instance ~* allows all the keys. The pattern +# is a glob-style pattern like the one of KEYS. +# It is possible to specify multiple patterns. +# %R~ Add key read pattern that specifies which keys can be read +# from. +# %W~ Add key write pattern that specifies which keys can be +# written to. +# allkeys Alias for ~* +# resetkeys Flush the list of allowed keys patterns. +# & Add a glob-style pattern of Pub/Sub channels that can be +# accessed by the user. It is possible to specify multiple channel +# patterns. +# allchannels Alias for &* +# resetchannels Flush the list of allowed channel patterns. +# > Add this password to the list of valid password for the user. +# For example >mypass will add "mypass" to the list. +# This directive clears the "nopass" flag (see later). +# < Remove this password from the list of valid passwords. +# nopass All the set passwords of the user are removed, and the user +# is flagged as requiring no password: it means that every +# password will work against this user. If this directive is +# used for the default user, every new connection will be +# immediately authenticated with the default user without +# any explicit AUTH command required. Note that the "resetpass" +# directive will clear this condition. +# resetpass Flush the list of allowed passwords. Moreover removes the +# "nopass" status. After "resetpass" the user has no associated +# passwords and there is no way to authenticate without adding +# some password (or setting it as "nopass" later). +# reset Performs the following actions: resetpass, resetkeys, off, +# -@all. The user returns to the same state it has immediately +# after its creation. +# () Create a new selector with the options specified within the +# parentheses and attach it to the user. Each option should be +# space separated. The first character must be ( and the last +# character must be ). +# clearselectors Remove all of the currently attached selectors. +# Note this does not change the "root" user permissions, +# which are the permissions directly applied onto the +# user (outside the parentheses). +# +# ACL rules can be specified in any order: for instance you can start with +# passwords, then flags, or key patterns. However note that the additive +# and subtractive rules will CHANGE MEANING depending on the ordering. +# For instance see the following example: +# +# user alice on +@all -DEBUG ~* >somepassword +# +# This will allow "alice" to use all the commands with the exception of the +# DEBUG command, since +@all added all the commands to the set of the commands +# alice can use, and later DEBUG was removed. However if we invert the order +# of two ACL rules the result will be different: +# +# user alice on -DEBUG +@all ~* >somepassword +# +# Now DEBUG was removed when alice had yet no commands in the set of allowed +# commands, later all the commands are added, so the user will be able to +# execute everything. +# +# Basically ACL rules are processed left-to-right. +# +# The following is a list of command categories and their meanings: +# * keyspace - Writing or reading from keys, databases, or their metadata +# in a type agnostic way. Includes DEL, RESTORE, DUMP, RENAME, EXISTS, DBSIZE, +# KEYS, EXPIRE, TTL, FLUSHALL, etc. Commands that may modify the keyspace, +# key or metadata will also have `write` category. Commands that only read +# the keyspace, key or metadata will have the `read` category. +# * read - Reading from keys (values or metadata). Note that commands that don't +# interact with keys, will not have either `read` or `write`. +# * write - Writing to keys (values or metadata) +# * admin - Administrative commands. Normal applications will never need to use +# these. Includes REPLICAOF, CONFIG, DEBUG, SAVE, MONITOR, ACL, SHUTDOWN, etc. +# * dangerous - Potentially dangerous (each should be considered with care for +# various reasons). This includes FLUSHALL, MIGRATE, RESTORE, SORT, KEYS, +# CLIENT, DEBUG, INFO, CONFIG, SAVE, REPLICAOF, etc. +# * connection - Commands affecting the connection or other connections. +# This includes AUTH, SELECT, COMMAND, CLIENT, ECHO, PING, etc. +# * blocking - Potentially blocking the connection until released by another +# command. +# * fast - Fast O(1) commands. May loop on the number of arguments, but not the +# number of elements in the key. +# * slow - All commands that are not Fast. +# * pubsub - PUBLISH / SUBSCRIBE related +# * transaction - WATCH / MULTI / EXEC related commands. +# * scripting - Scripting related. +# * set - Data type: sets related. +# * sortedset - Data type: zsets related. +# * list - Data type: lists related. +# * hash - Data type: hashes related. +# * string - Data type: strings related. +# * bitmap - Data type: bitmaps related. +# * hyperloglog - Data type: hyperloglog related. +# * geo - Data type: geo related. +# * stream - Data type: streams related. +# +# For more information about ACL configuration please refer to +# the Redis web site at https://redis.io/topics/acl + +# ACL LOG +# +# The ACL Log tracks failed commands and authentication events associated +# with ACLs. The ACL Log is useful to troubleshoot failed commands blocked +# by ACLs. The ACL Log is stored in memory. You can reclaim memory with +# ACL LOG RESET. Define the maximum entry length of the ACL Log below. +acllog-max-len 128 + +# Using an external ACL file +# +# Instead of configuring users here in this file, it is possible to use +# a stand-alone file just listing users. The two methods cannot be mixed: +# if you configure users here and at the same time you activate the external +# ACL file, the server will refuse to start. +# +# The format of the external ACL user file is exactly the same as the +# format that is used inside redis.conf to describe users. +# +# aclfile /etc/redis/users.acl + +# IMPORTANT NOTE: starting with Redis 6 "requirepass" is just a compatibility +# layer on top of the new ACL system. The option effect will be just setting +# the password for the default user. Clients will still authenticate using +# AUTH as usually, or more explicitly with AUTH default +# if they follow the new protocol: both will work. +# +# The requirepass is not compatible with aclfile option and the ACL LOAD +# command, these will cause requirepass to be ignored. +# +# requirepass foobared + +# New users are initialized with restrictive permissions by default, via the +# equivalent of this ACL rule 'off resetkeys -@all'. Starting with Redis 6.2, it +# is possible to manage access to Pub/Sub channels with ACL rules as well. The +# default Pub/Sub channels permission if new users is controlled by the +# acl-pubsub-default configuration directive, which accepts one of these values: +# +# allchannels: grants access to all Pub/Sub channels +# resetchannels: revokes access to all Pub/Sub channels +# +# From Redis 7.0, acl-pubsub-default defaults to 'resetchannels' permission. +# +# acl-pubsub-default resetchannels + +# Command renaming (DEPRECATED). +# +# ------------------------------------------------------------------------ +# WARNING: avoid using this option if possible. Instead use ACLs to remove +# commands from the default user, and put them only in some admin user you +# create for administrative purposes. +# ------------------------------------------------------------------------ +# +# It is possible to change the name of dangerous commands in a shared +# environment. For instance the CONFIG command may be renamed into something +# hard to guess so that it will still be available for internal-use tools +# but not available for general clients. +# +# Example: +# +# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 +# +# It is also possible to completely kill a command by renaming it into +# an empty string: +# +# rename-command CONFIG "" +# +# Please note that changing the name of commands that are logged into the +# AOF file or transmitted to replicas may cause problems. + +################################### CLIENTS #################################### + +# Set the max number of connected clients at the same time. By default +# this limit is set to 10000 clients, however if the Redis server is not +# able to configure the process file limit to allow for the specified limit +# the max number of allowed clients is set to the current file limit +# minus 32 (as Redis reserves a few file descriptors for internal uses). +# +# Once the limit is reached Redis will close all the new connections sending +# an error 'max number of clients reached'. +# +# IMPORTANT: When Redis Cluster is used, the max number of connections is also +# shared with the cluster bus: every node in the cluster will use two +# connections, one incoming and another outgoing. It is important to size the +# limit accordingly in case of very large clusters. +# +# maxclients 10000 + +############################## MEMORY MANAGEMENT ################################ + +# Set a memory usage limit to the specified amount of bytes. +# When the memory limit is reached Redis will try to remove keys +# according to the eviction policy selected (see maxmemory-policy). +# +# If Redis can't remove keys according to the policy, or if the policy is +# set to 'noeviction', Redis will start to reply with errors to commands +# that would use more memory, like SET, LPUSH, and so on, and will continue +# to reply to read-only commands like GET. +# +# This option is usually useful when using Redis as an LRU or LFU cache, or to +# set a hard memory limit for an instance (using the 'noeviction' policy). +# +# WARNING: If you have replicas attached to an instance with maxmemory on, +# the size of the output buffers needed to feed the replicas are subtracted +# from the used memory count, so that network problems / resyncs will +# not trigger a loop where keys are evicted, and in turn the output +# buffer of replicas is full with DELs of keys evicted triggering the deletion +# of more keys, and so forth until the database is completely emptied. +# +# In short... if you have replicas attached it is suggested that you set a lower +# limit for maxmemory so that there is some free RAM on the system for replica +# output buffers (but this is not needed if the policy is 'noeviction'). +# +# maxmemory + +# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory +# is reached. You can select one from the following behaviors: +# +# volatile-lru -> Evict using approximated LRU, only keys with an expire set. +# allkeys-lru -> Evict any key using approximated LRU. +# volatile-lfu -> Evict using approximated LFU, only keys with an expire set. +# allkeys-lfu -> Evict any key using approximated LFU. +# volatile-random -> Remove a random key having an expire set. +# allkeys-random -> Remove a random key, any key. +# volatile-ttl -> Remove the key with the nearest expire time (minor TTL) +# noeviction -> Don't evict anything, just return an error on write operations. +# +# LRU means Least Recently Used +# LFU means Least Frequently Used +# +# Both LRU, LFU and volatile-ttl are implemented using approximated +# randomized algorithms. +# +# Note: with any of the above policies, when there are no suitable keys for +# eviction, Redis will return an error on write operations that require +# more memory. These are usually commands that create new keys, add data or +# modify existing keys. A few examples are: SET, INCR, HSET, LPUSH, SUNIONSTORE, +# SORT (due to the STORE argument), and EXEC (if the transaction includes any +# command that requires memory). +# +# The default is: +# +# maxmemory-policy noeviction + +# LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated +# algorithms (in order to save memory), so you can tune it for speed or +# accuracy. By default Redis will check five keys and pick the one that was +# used least recently, you can change the sample size using the following +# configuration directive. +# +# The default of 5 produces good enough results. 10 Approximates very closely +# true LRU but costs more CPU. 3 is faster but not very accurate. +# +# maxmemory-samples 5 + +# Eviction processing is designed to function well with the default setting. +# If there is an unusually large amount of write traffic, this value may need to +# be increased. Decreasing this value may reduce latency at the risk of +# eviction processing effectiveness +# 0 = minimum latency, 10 = default, 100 = process without regard to latency +# +# maxmemory-eviction-tenacity 10 + +# Starting from Redis 5, by default a replica will ignore its maxmemory setting +# (unless it is promoted to master after a failover or manually). It means +# that the eviction of keys will be just handled by the master, sending the +# DEL commands to the replica as keys evict in the master side. +# +# This behavior ensures that masters and replicas stay consistent, and is usually +# what you want, however if your replica is writable, or you want the replica +# to have a different memory setting, and you are sure all the writes performed +# to the replica are idempotent, then you may change this default (but be sure +# to understand what you are doing). +# +# Note that since the replica by default does not evict, it may end using more +# memory than the one set via maxmemory (there are certain buffers that may +# be larger on the replica, or data structures may sometimes take more memory +# and so forth). So make sure you monitor your replicas and make sure they +# have enough memory to never hit a real out-of-memory condition before the +# master hits the configured maxmemory setting. +# +# replica-ignore-maxmemory yes + +# Redis reclaims expired keys in two ways: upon access when those keys are +# found to be expired, and also in background, in what is called the +# "active expire key". The key space is slowly and interactively scanned +# looking for expired keys to reclaim, so that it is possible to free memory +# of keys that are expired and will never be accessed again in a short time. +# +# The default effort of the expire cycle will try to avoid having more than +# ten percent of expired keys still in memory, and will try to avoid consuming +# more than 25% of total memory and to add latency to the system. However +# it is possible to increase the expire "effort" that is normally set to +# "1", to a greater value, up to the value "10". At its maximum value the +# system will use more CPU, longer cycles (and technically may introduce +# more latency), and will tolerate less already expired keys still present +# in the system. It's a tradeoff between memory, CPU and latency. +# +# active-expire-effort 1 + +############################# LAZY FREEING #################################### + +# Redis has two primitives to delete keys. One is called DEL and is a blocking +# deletion of the object. It means that the server stops processing new commands +# in order to reclaim all the memory associated with an object in a synchronous +# way. If the key deleted is associated with a small object, the time needed +# in order to execute the DEL command is very small and comparable to most other +# O(1) or O(log_N) commands in Redis. However if the key is associated with an +# aggregated value containing millions of elements, the server can block for +# a long time (even seconds) in order to complete the operation. +# +# For the above reasons Redis also offers non blocking deletion primitives +# such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and +# FLUSHDB commands, in order to reclaim memory in background. Those commands +# are executed in constant time. Another thread will incrementally free the +# object in the background as fast as possible. +# +# DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled. +# It's up to the design of the application to understand when it is a good +# idea to use one or the other. However the Redis server sometimes has to +# delete keys or flush the whole database as a side effect of other operations. +# Specifically Redis deletes objects independently of a user call in the +# following scenarios: +# +# 1) On eviction, because of the maxmemory and maxmemory policy configurations, +# in order to make room for new data, without going over the specified +# memory limit. +# 2) Because of expire: when a key with an associated time to live (see the +# EXPIRE command) must be deleted from memory. +# 3) Because of a side effect of a command that stores data on a key that may +# already exist. For example the RENAME command may delete the old key +# content when it is replaced with another one. Similarly SUNIONSTORE +# or SORT with STORE option may delete existing keys. The SET command +# itself removes any old content of the specified key in order to replace +# it with the specified string. +# 4) During replication, when a replica performs a full resynchronization with +# its master, the content of the whole database is removed in order to +# load the RDB file just transferred. +# +# In all the above cases the default is to delete objects in a blocking way, +# like if DEL was called. However you can configure each case specifically +# in order to instead release memory in a non-blocking way like if UNLINK +# was called, using the following configuration directives. + +lazyfree-lazy-eviction no +lazyfree-lazy-expire no +lazyfree-lazy-server-del no +replica-lazy-flush no + +# It is also possible, for the case when to replace the user code DEL calls +# with UNLINK calls is not easy, to modify the default behavior of the DEL +# command to act exactly like UNLINK, using the following configuration +# directive: + +lazyfree-lazy-user-del no + +# FLUSHDB, FLUSHALL, SCRIPT FLUSH and FUNCTION FLUSH support both asynchronous and synchronous +# deletion, which can be controlled by passing the [SYNC|ASYNC] flags into the +# commands. When neither flag is passed, this directive will be used to determine +# if the data should be deleted asynchronously. + +lazyfree-lazy-user-flush no + +################################ THREADED I/O ################################# + +# Redis is mostly single threaded, however there are certain threaded +# operations such as UNLINK, slow I/O accesses and other things that are +# performed on side threads. +# +# Now it is also possible to handle Redis clients socket reads and writes +# in different I/O threads. Since especially writing is so slow, normally +# Redis users use pipelining in order to speed up the Redis performances per +# core, and spawn multiple instances in order to scale more. Using I/O +# threads it is possible to easily speedup two times Redis without resorting +# to pipelining nor sharding of the instance. +# +# By default threading is disabled, we suggest enabling it only in machines +# that have at least 4 or more cores, leaving at least one spare core. +# Using more than 8 threads is unlikely to help much. We also recommend using +# threaded I/O only if you actually have performance problems, with Redis +# instances being able to use a quite big percentage of CPU time, otherwise +# there is no point in using this feature. +# +# So for instance if you have a four cores boxes, try to use 2 or 3 I/O +# threads, if you have a 8 cores, try to use 6 threads. In order to +# enable I/O threads use the following configuration directive: +# +# io-threads 4 +# +# Setting io-threads to 1 will just use the main thread as usual. +# When I/O threads are enabled, we only use threads for writes, that is +# to thread the write(2) syscall and transfer the client buffers to the +# socket. However it is also possible to enable threading of reads and +# protocol parsing using the following configuration directive, by setting +# it to yes: +# +# io-threads-do-reads no +# +# Usually threading reads doesn't help much. +# +# NOTE 1: This configuration directive cannot be changed at runtime via +# CONFIG SET. Also, this feature currently does not work when SSL is +# enabled. +# +# NOTE 2: If you want to test the Redis speedup using redis-benchmark, make +# sure you also run the benchmark itself in threaded mode, using the +# --threads option to match the number of Redis threads, otherwise you'll not +# be able to notice the improvements. + +############################ KERNEL OOM CONTROL ############################## + +# On Linux, it is possible to hint the kernel OOM killer on what processes +# should be killed first when out of memory. +# +# Enabling this feature makes Redis actively control the oom_score_adj value +# for all its processes, depending on their role. The default scores will +# attempt to have background child processes killed before all others, and +# replicas killed before masters. +# +# Redis supports these options: +# +# no: Don't make changes to oom-score-adj (default). +# yes: Alias to "relative" see below. +# absolute: Values in oom-score-adj-values are written as is to the kernel. +# relative: Values are used relative to the initial value of oom_score_adj when +# the server starts and are then clamped to a range of -1000 to 1000. +# Because typically the initial value is 0, they will often match the +# absolute values. +oom-score-adj no + +# When oom-score-adj is used, this directive controls the specific values used +# for master, replica and background child processes. Values range -2000 to +# 2000 (higher means more likely to be killed). +# +# Unprivileged processes (not root, and without CAP_SYS_RESOURCE capabilities) +# can freely increase their value, but not decrease it below its initial +# settings. This means that setting oom-score-adj to "relative" and setting the +# oom-score-adj-values to positive values will always succeed. +oom-score-adj-values 0 200 800 + + +#################### KERNEL transparent hugepage CONTROL ###################### + +# Usually the kernel Transparent Huge Pages control is set to "madvise" or +# or "never" by default (/sys/kernel/mm/transparent_hugepage/enabled), in which +# case this config has no effect. On systems in which it is set to "always", +# redis will attempt to disable it specifically for the redis process in order +# to avoid latency problems specifically with fork(2) and CoW. +# If for some reason you prefer to keep it enabled, you can set this config to +# "no" and the kernel global to "always". + +disable-thp yes + +############################## APPEND ONLY MODE ############################### + +# By default Redis asynchronously dumps the dataset on disk. This mode is +# good enough in many applications, but an issue with the Redis process or +# a power outage may result into a few minutes of writes lost (depending on +# the configured save points). +# +# The Append Only File is an alternative persistence mode that provides +# much better durability. For instance using the default data fsync policy +# (see later in the config file) Redis can lose just one second of writes in a +# dramatic event like a server power outage, or a single write if something +# wrong with the Redis process itself happens, but the operating system is +# still running correctly. +# +# AOF and RDB persistence can be enabled at the same time without problems. +# If the AOF is enabled on startup Redis will load the AOF, that is the file +# with the better durability guarantees. +# +# Please check https://redis.io/topics/persistence for more information. + +appendonly no + +# The base name of the append only file. +# +# Redis 7 and newer use a set of append-only files to persist the dataset +# and changes applied to it. There are two basic types of files in use: +# +# - Base files, which are a snapshot representing the complete state of the +# dataset at the time the file was created. Base files can be either in +# the form of RDB (binary serialized) or AOF (textual commands). +# - Incremental files, which contain additional commands that were applied +# to the dataset following the previous file. +# +# In addition, manifest files are used to track the files and the order in +# which they were created and should be applied. +# +# Append-only file names are created by Redis following a specific pattern. +# The file name's prefix is based on the 'appendfilename' configuration +# parameter, followed by additional information about the sequence and type. +# +# For example, if appendfilename is set to appendonly.aof, the following file +# names could be derived: +# +# - appendonly.aof.1.base.rdb as a base file. +# - appendonly.aof.1.incr.aof, appendonly.aof.2.incr.aof as incremental files. +# - appendonly.aof.manifest as a manifest file. + +appendfilename "appendonly.aof" + +# For convenience, Redis stores all persistent append-only files in a dedicated +# directory. The name of the directory is determined by the appenddirname +# configuration parameter. + +appenddirname "appendonlydir" + +# The fsync() call tells the Operating System to actually write data on disk +# instead of waiting for more data in the output buffer. Some OS will really flush +# data on disk, some other OS will just try to do it ASAP. +# +# Redis supports three different modes: +# +# no: don't fsync, just let the OS flush the data when it wants. Faster. +# always: fsync after every write to the append only log. Slow, Safest. +# everysec: fsync only one time every second. Compromise. +# +# The default is "everysec", as that's usually the right compromise between +# speed and data safety. It's up to you to understand if you can relax this to +# "no" that will let the operating system flush the output buffer when +# it wants, for better performances (but if you can live with the idea of +# some data loss consider the default persistence mode that's snapshotting), +# or on the contrary, use "always" that's very slow but a bit safer than +# everysec. +# +# More details please check the following article: +# http://antirez.com/post/redis-persistence-demystified.html +# +# If unsure, use "everysec". + +# appendfsync always +appendfsync everysec +# appendfsync no + +# When the AOF fsync policy is set to always or everysec, and a background +# saving process (a background save or AOF log background rewriting) is +# performing a lot of I/O against the disk, in some Linux configurations +# Redis may block too long on the fsync() call. Note that there is no fix for +# this currently, as even performing fsync in a different thread will block +# our synchronous write(2) call. +# +# In order to mitigate this problem it's possible to use the following option +# that will prevent fsync() from being called in the main process while a +# BGSAVE or BGREWRITEAOF is in progress. +# +# This means that while another child is saving, the durability of Redis is +# the same as "appendfsync no". In practical terms, this means that it is +# possible to lose up to 30 seconds of log in the worst scenario (with the +# default Linux settings). +# +# If you have latency problems turn this to "yes". Otherwise leave it as +# "no" that is the safest pick from the point of view of durability. + +no-appendfsync-on-rewrite no + +# Automatic rewrite of the append only file. +# Redis is able to automatically rewrite the log file implicitly calling +# BGREWRITEAOF when the AOF log size grows by the specified percentage. +# +# This is how it works: Redis remembers the size of the AOF file after the +# latest rewrite (if no rewrite has happened since the restart, the size of +# the AOF at startup is used). +# +# This base size is compared to the current size. If the current size is +# bigger than the specified percentage, the rewrite is triggered. Also +# you need to specify a minimal size for the AOF file to be rewritten, this +# is useful to avoid rewriting the AOF file even if the percentage increase +# is reached but it is still pretty small. +# +# Specify a percentage of zero in order to disable the automatic AOF +# rewrite feature. + +auto-aof-rewrite-percentage 100 +auto-aof-rewrite-min-size 64mb + +# An AOF file may be found to be truncated at the end during the Redis +# startup process, when the AOF data gets loaded back into memory. +# This may happen when the system where Redis is running +# crashes, especially when an ext4 filesystem is mounted without the +# data=ordered option (however this can't happen when Redis itself +# crashes or aborts but the operating system still works correctly). +# +# Redis can either exit with an error when this happens, or load as much +# data as possible (the default now) and start if the AOF file is found +# to be truncated at the end. The following option controls this behavior. +# +# If aof-load-truncated is set to yes, a truncated AOF file is loaded and +# the Redis server starts emitting a log to inform the user of the event. +# Otherwise if the option is set to no, the server aborts with an error +# and refuses to start. When the option is set to no, the user requires +# to fix the AOF file using the "redis-check-aof" utility before to restart +# the server. +# +# Note that if the AOF file will be found to be corrupted in the middle +# the server will still exit with an error. This option only applies when +# Redis will try to read more data from the AOF file but not enough bytes +# will be found. +aof-load-truncated yes + +# Redis can create append-only base files in either RDB or AOF formats. Using +# the RDB format is always faster and more efficient, and disabling it is only +# supported for backward compatibility purposes. +aof-use-rdb-preamble yes + +# Redis supports recording timestamp annotations in the AOF to support restoring +# the data from a specific point-in-time. However, using this capability changes +# the AOF format in a way that may not be compatible with existing AOF parsers. +aof-timestamp-enabled no + +################################ SHUTDOWN ##################################### + +# Maximum time to wait for replicas when shutting down, in seconds. +# +# During shut down, a grace period allows any lagging replicas to catch up with +# the latest replication offset before the master exists. This period can +# prevent data loss, especially for deployments without configured disk backups. +# +# The 'shutdown-timeout' value is the grace period's duration in seconds. It is +# only applicable when the instance has replicas. To disable the feature, set +# the value to 0. +# +# shutdown-timeout 10 + +# When Redis receives a SIGINT or SIGTERM, shutdown is initiated and by default +# an RDB snapshot is written to disk in a blocking operation if save points are configured. +# The options used on signaled shutdown can include the following values: +# default: Saves RDB snapshot only if save points are configured. +# Waits for lagging replicas to catch up. +# save: Forces a DB saving operation even if no save points are configured. +# nosave: Prevents DB saving operation even if one or more save points are configured. +# now: Skips waiting for lagging replicas. +# force: Ignores any errors that would normally prevent the server from exiting. +# +# Any combination of values is allowed as long as "save" and "nosave" are not set simultaneously. +# Example: "nosave force now" +# +# shutdown-on-sigint default +# shutdown-on-sigterm default + +################ NON-DETERMINISTIC LONG BLOCKING COMMANDS ##################### + +# Maximum time in milliseconds for EVAL scripts, functions and in some cases +# modules' commands before Redis can start processing or rejecting other clients. +# +# If the maximum execution time is reached Redis will start to reply to most +# commands with a BUSY error. +# +# In this state Redis will only allow a handful of commands to be executed. +# For instance, SCRIPT KILL, FUNCTION KILL, SHUTDOWN NOSAVE and possibly some +# module specific 'allow-busy' commands. +# +# SCRIPT KILL and FUNCTION KILL will only be able to stop a script that did not +# yet call any write commands, so SHUTDOWN NOSAVE may be the only way to stop +# the server in the case a write command was already issued by the script when +# the user doesn't want to wait for the natural termination of the script. +# +# The default is 5 seconds. It is possible to set it to 0 or a negative value +# to disable this mechanism (uninterrupted execution). Note that in the past +# this config had a different name, which is now an alias, so both of these do +# the same: +# lua-time-limit 5000 +# busy-reply-threshold 5000 + +################################ REDIS CLUSTER ############################### + +# Normal Redis instances can't be part of a Redis Cluster; only nodes that are +# started as cluster nodes can. In order to start a Redis instance as a +# cluster node enable the cluster support uncommenting the following: +# +# cluster-enabled yes + +# Every cluster node has a cluster configuration file. This file is not +# intended to be edited by hand. It is created and updated by Redis nodes. +# Every Redis Cluster node requires a different cluster configuration file. +# Make sure that instances running in the same system do not have +# overlapping cluster configuration file names. +# +# cluster-config-file nodes-6379.conf + +# Cluster node timeout is the amount of milliseconds a node must be unreachable +# for it to be considered in failure state. +# Most other internal time limits are a multiple of the node timeout. +# +# cluster-node-timeout 15000 + +# The cluster port is the port that the cluster bus will listen for inbound connections on. When set +# to the default value, 0, it will be bound to the command port + 10000. Setting this value requires +# you to specify the cluster bus port when executing cluster meet. +# cluster-port 0 + +# A replica of a failing master will avoid to start a failover if its data +# looks too old. +# +# There is no simple way for a replica to actually have an exact measure of +# its "data age", so the following two checks are performed: +# +# 1) If there are multiple replicas able to failover, they exchange messages +# in order to try to give an advantage to the replica with the best +# replication offset (more data from the master processed). +# Replicas will try to get their rank by offset, and apply to the start +# of the failover a delay proportional to their rank. +# +# 2) Every single replica computes the time of the last interaction with +# its master. This can be the last ping or command received (if the master +# is still in the "connected" state), or the time that elapsed since the +# disconnection with the master (if the replication link is currently down). +# If the last interaction is too old, the replica will not try to failover +# at all. +# +# The point "2" can be tuned by user. Specifically a replica will not perform +# the failover if, since the last interaction with the master, the time +# elapsed is greater than: +# +# (node-timeout * cluster-replica-validity-factor) + repl-ping-replica-period +# +# So for example if node-timeout is 30 seconds, and the cluster-replica-validity-factor +# is 10, and assuming a default repl-ping-replica-period of 10 seconds, the +# replica will not try to failover if it was not able to talk with the master +# for longer than 310 seconds. +# +# A large cluster-replica-validity-factor may allow replicas with too old data to failover +# a master, while a too small value may prevent the cluster from being able to +# elect a replica at all. +# +# For maximum availability, it is possible to set the cluster-replica-validity-factor +# to a value of 0, which means, that replicas will always try to failover the +# master regardless of the last time they interacted with the master. +# (However they'll always try to apply a delay proportional to their +# offset rank). +# +# Zero is the only value able to guarantee that when all the partitions heal +# the cluster will always be able to continue. +# +# cluster-replica-validity-factor 10 + +# Cluster replicas are able to migrate to orphaned masters, that are masters +# that are left without working replicas. This improves the cluster ability +# to resist to failures as otherwise an orphaned master can't be failed over +# in case of failure if it has no working replicas. +# +# Replicas migrate to orphaned masters only if there are still at least a +# given number of other working replicas for their old master. This number +# is the "migration barrier". A migration barrier of 1 means that a replica +# will migrate only if there is at least 1 other working replica for its master +# and so forth. It usually reflects the number of replicas you want for every +# master in your cluster. +# +# Default is 1 (replicas migrate only if their masters remain with at least +# one replica). To disable migration just set it to a very large value or +# set cluster-allow-replica-migration to 'no'. +# A value of 0 can be set but is useful only for debugging and dangerous +# in production. +# +# cluster-migration-barrier 1 + +# Turning off this option allows to use less automatic cluster configuration. +# It both disables migration to orphaned masters and migration from masters +# that became empty. +# +# Default is 'yes' (allow automatic migrations). +# +# cluster-allow-replica-migration yes + +# By default Redis Cluster nodes stop accepting queries if they detect there +# is at least a hash slot uncovered (no available node is serving it). +# This way if the cluster is partially down (for example a range of hash slots +# are no longer covered) all the cluster becomes, eventually, unavailable. +# It automatically returns available as soon as all the slots are covered again. +# +# However sometimes you want the subset of the cluster which is working, +# to continue to accept queries for the part of the key space that is still +# covered. In order to do so, just set the cluster-require-full-coverage +# option to no. +# +# cluster-require-full-coverage yes + +# This option, when set to yes, prevents replicas from trying to failover its +# master during master failures. However the replica can still perform a +# manual failover, if forced to do so. +# +# This is useful in different scenarios, especially in the case of multiple +# data center operations, where we want one side to never be promoted if not +# in the case of a total DC failure. +# +# cluster-replica-no-failover no + +# This option, when set to yes, allows nodes to serve read traffic while the +# cluster is in a down state, as long as it believes it owns the slots. +# +# This is useful for two cases. The first case is for when an application +# doesn't require consistency of data during node failures or network partitions. +# One example of this is a cache, where as long as the node has the data it +# should be able to serve it. +# +# The second use case is for configurations that don't meet the recommended +# three shards but want to enable cluster mode and scale later. A +# master outage in a 1 or 2 shard configuration causes a read/write outage to the +# entire cluster without this option set, with it set there is only a write outage. +# Without a quorum of masters, slot ownership will not change automatically. +# +# cluster-allow-reads-when-down no + +# This option, when set to yes, allows nodes to serve pubsub shard traffic while +# the cluster is in a down state, as long as it believes it owns the slots. +# +# This is useful if the application would like to use the pubsub feature even when +# the cluster global stable state is not OK. If the application wants to make sure only +# one shard is serving a given channel, this feature should be kept as yes. +# +# cluster-allow-pubsubshard-when-down yes + +# Cluster link send buffer limit is the limit on the memory usage of an individual +# cluster bus link's send buffer in bytes. Cluster links would be freed if they exceed +# this limit. This is to primarily prevent send buffers from growing unbounded on links +# toward slow peers (E.g. PubSub messages being piled up). +# This limit is disabled by default. Enable this limit when 'mem_cluster_links' INFO field +# and/or 'send-buffer-allocated' entries in the 'CLUSTER LINKS` command output continuously increase. +# Minimum limit of 1gb is recommended so that cluster link buffer can fit in at least a single +# PubSub message by default. (client-query-buffer-limit default value is 1gb) +# +# cluster-link-sendbuf-limit 0 + +# Clusters can configure their announced hostname using this config. This is a common use case for +# applications that need to use TLS Server Name Indication (SNI) or dealing with DNS based +# routing. By default this value is only shown as additional metadata in the CLUSTER SLOTS +# command, but can be changed using 'cluster-preferred-endpoint-type' config. This value is +# communicated along the clusterbus to all nodes, setting it to an empty string will remove +# the hostname and also propagate the removal. +# +# cluster-announce-hostname "" + +# Clusters can advertise how clients should connect to them using either their IP address, +# a user defined hostname, or by declaring they have no endpoint. Which endpoint is +# shown as the preferred endpoint is set by using the cluster-preferred-endpoint-type +# config with values 'ip', 'hostname', or 'unknown-endpoint'. This value controls how +# the endpoint returned for MOVED/ASKING requests as well as the first field of CLUSTER SLOTS. +# If the preferred endpoint type is set to hostname, but no announced hostname is set, a '?' +# will be returned instead. +# +# When a cluster advertises itself as having an unknown endpoint, it's indicating that +# the server doesn't know how clients can reach the cluster. This can happen in certain +# networking situations where there are multiple possible routes to the node, and the +# server doesn't know which one the client took. In this case, the server is expecting +# the client to reach out on the same endpoint it used for making the last request, but use +# the port provided in the response. +# +# cluster-preferred-endpoint-type ip + +# In order to setup your cluster make sure to read the documentation +# available at https://redis.io web site. + +########################## CLUSTER DOCKER/NAT support ######################## + +# In certain deployments, Redis Cluster nodes address discovery fails, because +# addresses are NAT-ted or because ports are forwarded (the typical case is +# Docker and other containers). +# +# In order to make Redis Cluster working in such environments, a static +# configuration where each node knows its public address is needed. The +# following four options are used for this scope, and are: +# +# * cluster-announce-ip +# * cluster-announce-port +# * cluster-announce-tls-port +# * cluster-announce-bus-port +# +# Each instructs the node about its address, client ports (for connections +# without and with TLS) and cluster message bus port. The information is then +# published in the header of the bus packets so that other nodes will be able to +# correctly map the address of the node publishing the information. +# +# If cluster-tls is set to yes and cluster-announce-tls-port is omitted or set +# to zero, then cluster-announce-port refers to the TLS port. Note also that +# cluster-announce-tls-port has no effect if cluster-tls is set to no. +# +# If the above options are not used, the normal Redis Cluster auto-detection +# will be used instead. +# +# Note that when remapped, the bus port may not be at the fixed offset of +# clients port + 10000, so you can specify any port and bus-port depending +# on how they get remapped. If the bus-port is not set, a fixed offset of +# 10000 will be used as usual. +# +# Example: +# +# cluster-announce-ip 10.1.1.5 +# cluster-announce-tls-port 6379 +# cluster-announce-port 0 +# cluster-announce-bus-port 6380 + +################################## SLOW LOG ################################### + +# The Redis Slow Log is a system to log queries that exceeded a specified +# execution time. The execution time does not include the I/O operations +# like talking with the client, sending the reply and so forth, +# but just the time needed to actually execute the command (this is the only +# stage of command execution where the thread is blocked and can not serve +# other requests in the meantime). +# +# You can configure the slow log with two parameters: one tells Redis +# what is the execution time, in microseconds, to exceed in order for the +# command to get logged, and the other parameter is the length of the +# slow log. When a new command is logged the oldest one is removed from the +# queue of logged commands. + +# The following time is expressed in microseconds, so 1000000 is equivalent +# to one second. Note that a negative number disables the slow log, while +# a value of zero forces the logging of every command. +slowlog-log-slower-than 10000 + +# There is no limit to this length. Just be aware that it will consume memory. +# You can reclaim memory used by the slow log with SLOWLOG RESET. +slowlog-max-len 128 + +################################ LATENCY MONITOR ############################## + +# The Redis latency monitoring subsystem samples different operations +# at runtime in order to collect data related to possible sources of +# latency of a Redis instance. +# +# Via the LATENCY command this information is available to the user that can +# print graphs and obtain reports. +# +# The system only logs operations that were performed in a time equal or +# greater than the amount of milliseconds specified via the +# latency-monitor-threshold configuration directive. When its value is set +# to zero, the latency monitor is turned off. +# +# By default latency monitoring is disabled since it is mostly not needed +# if you don't have latency issues, and collecting data has a performance +# impact, that while very small, can be measured under big load. Latency +# monitoring can easily be enabled at runtime using the command +# "CONFIG SET latency-monitor-threshold " if needed. +latency-monitor-threshold 0 + +################################ LATENCY TRACKING ############################## + +# The Redis extended latency monitoring tracks the per command latencies and enables +# exporting the percentile distribution via the INFO latencystats command, +# and cumulative latency distributions (histograms) via the LATENCY command. +# +# By default, the extended latency monitoring is enabled since the overhead +# of keeping track of the command latency is very small. +# latency-tracking yes + +# By default the exported latency percentiles via the INFO latencystats command +# are the p50, p99, and p999. +# latency-tracking-info-percentiles 50 99 99.9 + +############################# EVENT NOTIFICATION ############################## + +# Redis can notify Pub/Sub clients about events happening in the key space. +# This feature is documented at https://redis.io/topics/notifications +# +# For instance if keyspace events notification is enabled, and a client +# performs a DEL operation on key "foo" stored in the Database 0, two +# messages will be published via Pub/Sub: +# +# PUBLISH __keyspace@0__:foo del +# PUBLISH __keyevent@0__:del foo +# +# It is possible to select the events that Redis will notify among a set +# of classes. Every class is identified by a single character: +# +# K Keyspace events, published with __keyspace@__ prefix. +# E Keyevent events, published with __keyevent@__ prefix. +# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... +# $ String commands +# l List commands +# s Set commands +# h Hash commands +# z Sorted set commands +# x Expired events (events generated every time a key expires) +# e Evicted events (events generated when a key is evicted for maxmemory) +# n New key events (Note: not included in the 'A' class) +# t Stream commands +# d Module key type events +# m Key-miss events (Note: It is not included in the 'A' class) +# A Alias for g$lshzxetd, so that the "AKE" string means all the events +# (Except key-miss events which are excluded from 'A' due to their +# unique nature). +# +# The "notify-keyspace-events" takes as argument a string that is composed +# of zero or multiple characters. The empty string means that notifications +# are disabled. +# +# Example: to enable list and generic events, from the point of view of the +# event name, use: +# +# notify-keyspace-events Elg +# +# Example 2: to get the stream of the expired keys subscribing to channel +# name __keyevent@0__:expired use: +# +# notify-keyspace-events Ex +# +# By default all notifications are disabled because most users don't need +# this feature and the feature has some overhead. Note that if you don't +# specify at least one of K or E, no events will be delivered. +notify-keyspace-events "" + +############################### ADVANCED CONFIG ############################### + +# Hashes are encoded using a memory efficient data structure when they have a +# small number of entries, and the biggest entry does not exceed a given +# threshold. These thresholds can be configured using the following directives. +hash-max-listpack-entries 512 +hash-max-listpack-value 64 + +# Lists are also encoded in a special way to save a lot of space. +# The number of entries allowed per internal list node can be specified +# as a fixed maximum size or a maximum number of elements. +# For a fixed maximum size, use -5 through -1, meaning: +# -5: max size: 64 Kb <-- not recommended for normal workloads +# -4: max size: 32 Kb <-- not recommended +# -3: max size: 16 Kb <-- probably not recommended +# -2: max size: 8 Kb <-- good +# -1: max size: 4 Kb <-- good +# Positive numbers mean store up to _exactly_ that number of elements +# per list node. +# The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size), +# but if your use case is unique, adjust the settings as necessary. +list-max-listpack-size -2 + +# Lists may also be compressed. +# Compress depth is the number of quicklist ziplist nodes from *each* side of +# the list to *exclude* from compression. The head and tail of the list +# are always uncompressed for fast push/pop operations. Settings are: +# 0: disable all list compression +# 1: depth 1 means "don't start compressing until after 1 node into the list, +# going from either the head or tail" +# So: [head]->node->node->...->node->[tail] +# [head], [tail] will always be uncompressed; inner nodes will compress. +# 2: [head]->[next]->node->node->...->node->[prev]->[tail] +# 2 here means: don't compress head or head->next or tail->prev or tail, +# but compress all nodes between them. +# 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail] +# etc. +list-compress-depth 0 + +# Sets have a special encoding in just one case: when a set is composed +# of just strings that happen to be integers in radix 10 in the range +# of 64 bit signed integers. +# The following configuration setting sets the limit in the size of the +# set in order to use this special memory saving encoding. +set-max-intset-entries 512 + +# Similarly to hashes and lists, sorted sets are also specially encoded in +# order to save a lot of space. This encoding is only used when the length and +# elements of a sorted set are below the following limits: +zset-max-listpack-entries 128 +zset-max-listpack-value 64 + +# HyperLogLog sparse representation bytes limit. The limit includes the +# 16 bytes header. When an HyperLogLog using the sparse representation crosses +# this limit, it is converted into the dense representation. +# +# A value greater than 16000 is totally useless, since at that point the +# dense representation is more memory efficient. +# +# The suggested value is ~ 3000 in order to have the benefits of +# the space efficient encoding without slowing down too much PFADD, +# which is O(N) with the sparse encoding. The value can be raised to +# ~ 10000 when CPU is not a concern, but space is, and the data set is +# composed of many HyperLogLogs with cardinality in the 0 - 15000 range. +hll-sparse-max-bytes 3000 + +# Streams macro node max size / items. The stream data structure is a radix +# tree of big nodes that encode multiple items inside. Using this configuration +# it is possible to configure how big a single node can be in bytes, and the +# maximum number of items it may contain before switching to a new node when +# appending new stream entries. If any of the following settings are set to +# zero, the limit is ignored, so for instance it is possible to set just a +# max entries limit by setting max-bytes to 0 and max-entries to the desired +# value. +stream-node-max-bytes 4096 +stream-node-max-entries 100 + +# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in +# order to help rehashing the main Redis hash table (the one mapping top-level +# keys to values). The hash table implementation Redis uses (see dict.c) +# performs a lazy rehashing: the more operation you run into a hash table +# that is rehashing, the more rehashing "steps" are performed, so if the +# server is idle the rehashing is never complete and some more memory is used +# by the hash table. +# +# The default is to use this millisecond 10 times every second in order to +# actively rehash the main dictionaries, freeing memory when possible. +# +# If unsure: +# use "activerehashing no" if you have hard latency requirements and it is +# not a good thing in your environment that Redis can reply from time to time +# to queries with 2 milliseconds delay. +# +# use "activerehashing yes" if you don't have such hard requirements but +# want to free memory asap when possible. +activerehashing yes + +# The client output buffer limits can be used to force disconnection of clients +# that are not reading data from the server fast enough for some reason (a +# common reason is that a Pub/Sub client can't consume messages as fast as the +# publisher can produce them). +# +# The limit can be set differently for the three different classes of clients: +# +# normal -> normal clients including MONITOR clients +# replica -> replica clients +# pubsub -> clients subscribed to at least one pubsub channel or pattern +# +# The syntax of every client-output-buffer-limit directive is the following: +# +# client-output-buffer-limit +# +# A client is immediately disconnected once the hard limit is reached, or if +# the soft limit is reached and remains reached for the specified number of +# seconds (continuously). +# So for instance if the hard limit is 32 megabytes and the soft limit is +# 16 megabytes / 10 seconds, the client will get disconnected immediately +# if the size of the output buffers reach 32 megabytes, but will also get +# disconnected if the client reaches 16 megabytes and continuously overcomes +# the limit for 10 seconds. +# +# By default normal clients are not limited because they don't receive data +# without asking (in a push way), but just after a request, so only +# asynchronous clients may create a scenario where data is requested faster +# than it can read. +# +# Instead there is a default limit for pubsub and replica clients, since +# subscribers and replicas receive data in a push fashion. +# +# Note that it doesn't make sense to set the replica clients output buffer +# limit lower than the repl-backlog-size config (partial sync will succeed +# and then replica will get disconnected). +# Such a configuration is ignored (the size of repl-backlog-size will be used). +# This doesn't have memory consumption implications since the replica client +# will share the backlog buffers memory. +# +# Both the hard or the soft limit can be disabled by setting them to zero. +client-output-buffer-limit normal 0 0 0 +client-output-buffer-limit replica 256mb 64mb 60 +client-output-buffer-limit pubsub 32mb 8mb 60 + +# Client query buffers accumulate new commands. They are limited to a fixed +# amount by default in order to avoid that a protocol desynchronization (for +# instance due to a bug in the client) will lead to unbound memory usage in +# the query buffer. However you can configure it here if you have very special +# needs, such us huge multi/exec requests or alike. +# +# client-query-buffer-limit 1gb + +# In some scenarios client connections can hog up memory leading to OOM +# errors or data eviction. To avoid this we can cap the accumulated memory +# used by all client connections (all pubsub and normal clients). Once we +# reach that limit connections will be dropped by the server freeing up +# memory. The server will attempt to drop the connections using the most +# memory first. We call this mechanism "client eviction". +# +# Client eviction is configured using the maxmemory-clients setting as follows: +# 0 - client eviction is disabled (default) +# +# A memory value can be used for the client eviction threshold, +# for example: +# maxmemory-clients 1g +# +# A percentage value (between 1% and 100%) means the client eviction threshold +# is based on a percentage of the maxmemory setting. For example to set client +# eviction at 5% of maxmemory: +# maxmemory-clients 5% + +# In the Redis protocol, bulk requests, that are, elements representing single +# strings, are normally limited to 512 mb. However you can change this limit +# here, but must be 1mb or greater +# +# proto-max-bulk-len 512mb + +# Redis calls an internal function to perform many background tasks, like +# closing connections of clients in timeout, purging expired keys that are +# never requested, and so forth. +# +# Not all tasks are performed with the same frequency, but Redis checks for +# tasks to perform according to the specified "hz" value. +# +# By default "hz" is set to 10. Raising the value will use more CPU when +# Redis is idle, but at the same time will make Redis more responsive when +# there are many keys expiring at the same time, and timeouts may be +# handled with more precision. +# +# The range is between 1 and 500, however a value over 100 is usually not +# a good idea. Most users should use the default of 10 and raise this up to +# 100 only in environments where very low latency is required. +hz 10 + +# Normally it is useful to have an HZ value which is proportional to the +# number of clients connected. This is useful in order, for instance, to +# avoid too many clients are processed for each background task invocation +# in order to avoid latency spikes. +# +# Since the default HZ value by default is conservatively set to 10, Redis +# offers, and enables by default, the ability to use an adaptive HZ value +# which will temporarily raise when there are many connected clients. +# +# When dynamic HZ is enabled, the actual configured HZ will be used +# as a baseline, but multiples of the configured HZ value will be actually +# used as needed once more clients are connected. In this way an idle +# instance will use very little CPU time while a busy instance will be +# more responsive. +dynamic-hz yes + +# When a child rewrites the AOF file, if the following option is enabled +# the file will be fsync-ed every 4 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +aof-rewrite-incremental-fsync yes + +# When redis saves RDB file, if the following option is enabled +# the file will be fsync-ed every 4 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +rdb-save-incremental-fsync yes + +# Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good +# idea to start with the default settings and only change them after investigating +# how to improve the performances and how the keys LFU change over time, which +# is possible to inspect via the OBJECT FREQ command. +# +# There are two tunable parameters in the Redis LFU implementation: the +# counter logarithm factor and the counter decay time. It is important to +# understand what the two parameters mean before changing them. +# +# The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis +# uses a probabilistic increment with logarithmic behavior. Given the value +# of the old counter, when a key is accessed, the counter is incremented in +# this way: +# +# 1. A random number R between 0 and 1 is extracted. +# 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1). +# 3. The counter is incremented only if R < P. +# +# The default lfu-log-factor is 10. This is a table of how the frequency +# counter changes with a different number of accesses with different +# logarithmic factors: +# +# +--------+------------+------------+------------+------------+------------+ +# | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits | +# +--------+------------+------------+------------+------------+------------+ +# | 0 | 104 | 255 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 1 | 18 | 49 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 10 | 10 | 18 | 142 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 100 | 8 | 11 | 49 | 143 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# +# NOTE: The above table was obtained by running the following commands: +# +# redis-benchmark -n 1000000 incr foo +# redis-cli object freq foo +# +# NOTE 2: The counter initial value is 5 in order to give new objects a chance +# to accumulate hits. +# +# The counter decay time is the time, in minutes, that must elapse in order +# for the key counter to be divided by two (or decremented if it has a value +# less <= 10). +# +# The default value for the lfu-decay-time is 1. A special value of 0 means to +# decay the counter every time it happens to be scanned. +# +# lfu-log-factor 10 +# lfu-decay-time 1 + +########################### ACTIVE DEFRAGMENTATION ####################### +# +# What is active defragmentation? +# ------------------------------- +# +# Active (online) defragmentation allows a Redis server to compact the +# spaces left between small allocations and deallocations of data in memory, +# thus allowing to reclaim back memory. +# +# Fragmentation is a natural process that happens with every allocator (but +# less so with Jemalloc, fortunately) and certain workloads. Normally a server +# restart is needed in order to lower the fragmentation, or at least to flush +# away all the data and create it again. However thanks to this feature +# implemented by Oran Agra for Redis 4.0 this process can happen at runtime +# in a "hot" way, while the server is running. +# +# Basically when the fragmentation is over a certain level (see the +# configuration options below) Redis will start to create new copies of the +# values in contiguous memory regions by exploiting certain specific Jemalloc +# features (in order to understand if an allocation is causing fragmentation +# and to allocate it in a better place), and at the same time, will release the +# old copies of the data. This process, repeated incrementally for all the keys +# will cause the fragmentation to drop back to normal values. +# +# Important things to understand: +# +# 1. This feature is disabled by default, and only works if you compiled Redis +# to use the copy of Jemalloc we ship with the source code of Redis. +# This is the default with Linux builds. +# +# 2. You never need to enable this feature if you don't have fragmentation +# issues. +# +# 3. Once you experience fragmentation, you can enable this feature when +# needed with the command "CONFIG SET activedefrag yes". +# +# The configuration parameters are able to fine tune the behavior of the +# defragmentation process. If you are not sure about what they mean it is +# a good idea to leave the defaults untouched. + +# Active defragmentation is disabled by default +# activedefrag no + +# Minimum amount of fragmentation waste to start active defrag +# active-defrag-ignore-bytes 100mb + +# Minimum percentage of fragmentation to start active defrag +# active-defrag-threshold-lower 10 + +# Maximum percentage of fragmentation at which we use maximum effort +# active-defrag-threshold-upper 100 + +# Minimal effort for defrag in CPU percentage, to be used when the lower +# threshold is reached +# active-defrag-cycle-min 1 + +# Maximal effort for defrag in CPU percentage, to be used when the upper +# threshold is reached +# active-defrag-cycle-max 25 + +# Maximum number of set/hash/zset/list fields that will be processed from +# the main dictionary scan +# active-defrag-max-scan-fields 1000 + +# Jemalloc background thread for purging will be enabled by default +jemalloc-bg-thread yes + +# It is possible to pin different threads and processes of Redis to specific +# CPUs in your system, in order to maximize the performances of the server. +# This is useful both in order to pin different Redis threads in different +# CPUs, but also in order to make sure that multiple Redis instances running +# in the same host will be pinned to different CPUs. +# +# Normally you can do this using the "taskset" command, however it is also +# possible to this via Redis configuration directly, both in Linux and FreeBSD. +# +# You can pin the server/IO threads, bio threads, aof rewrite child process, and +# the bgsave child process. The syntax to specify the cpu list is the same as +# the taskset command: +# +# Set redis server/io threads to cpu affinity 0,2,4,6: +# server_cpulist 0-7:2 +# +# Set bio threads to cpu affinity 1,3: +# bio_cpulist 1,3 +# +# Set aof rewrite child process to cpu affinity 8,9,10,11: +# aof_rewrite_cpulist 8-11 +# +# Set bgsave child process to cpu affinity 1,10,11 +# bgsave_cpulist 1,10-11 + +# In some cases redis will emit warnings and even refuse to start if it detects +# that the system is in bad state, it is possible to suppress these warnings +# by setting the following config which takes a space delimited list of warnings +# to suppress +# +# ignore-warnings ARM64-COW-BUG \ No newline at end of file diff --git a/ptero_eggs/application/database/sql/mariadb/README.md b/ptero_eggs/application/database/sql/mariadb/README.md new file mode 100644 index 0000000..51c8f27 --- /dev/null +++ b/ptero_eggs/application/database/sql/mariadb/README.md @@ -0,0 +1,20 @@ +# MariaDB + +## From their [Website](https://mariadb.org/) + +One of the most popular database servers. Made by the original developers of MySQL. +Guaranteed to stay open source. + +## Minimum RAM warning + +There is no actual minimum suggested for MariaDB. + +See here + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Server | 3306 | diff --git a/ptero_eggs/application/database/sql/mariadb/egg-maria-d-b.json b/ptero_eggs/application/database/sql/mariadb/egg-maria-d-b.json new file mode 100644 index 0000000..5b03ad6 --- /dev/null +++ b/ptero_eggs/application/database/sql/mariadb/egg-maria-d-b.json @@ -0,0 +1,35 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2025-07-04T08:38:00+00:00", + "name": "MariaDB", + "author": "danielb@purpleflaghosting.com", + "description": "MariaDB is a community-developed, commercially supported fork of the MySQL relational database management system, intended to remain free and open-source software under the GNU General Public.", + "features": null, + "docker_images": { + "MariaDB 11.8 LTS": "ghcr.io\/ptero-eggs\/yolks:mariadb_11.8", + "MariaDB 11.6": "ghcr.io\/ptero-eggs\/yolks:mariadb_11.6", + "MariaDB 11.4 LTS": "ghcr.io\/ptero-eggs\/yolks:mariadb_11.4", + "MariaDB 10.11 LTS": "ghcr.io\/ptero-eggs\/yolks:mariadb_10.11", + "MariaDB 10.6 LTS": "ghcr.io\/ptero-eggs\/yolks:mariadb_10.6" + }, + "file_denylist": [], + "startup": "${MARIADB_EXECUTABLE}", + "config": { + "files": "{\r\n \".my.cnf\": {\r\n \"parser\": \"ini\",\r\n \"find\": {\r\n \"mysqld.port\": \"{{server.build.default.port}}\",\r\n \"client.port\": \"{{server.build.default.port}}\",\r\n \"mysqld.bind-address\": \"0.0.0.0\",\r\n \"mysqld.pid-file\": \"\/home\/container\/run\/mysqld\/mysqld.pid\",\r\n \"mysqld.socket\": \"\/home\/container\/run\/mysqld\/mysqld.sock\",\r\n \"client.socket\": \"\/home\/container\/run\/mysqld\/mysqld.sock\",\r\n \"mysqld.general_log_file\": \"\/home\/container\/log\/mysql\/mysql.log\",\r\n \"client.user\": \"container\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"ready for connections.\"\r\n}", + "logs": "{}", + "stop": "shutdown; exit;" + }, + "scripts": { + "installation": { + "script": "# Nothing here - All the magic is in the entrypoint.sh\r\necho \"Installation complete\"", + "container": "alpine", + "entrypoint": "ash" + } + }, + "variables": [] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/sql/postgres/README.md b/ptero_eggs/application/database/sql/postgres/README.md new file mode 100644 index 0000000..317c23e --- /dev/null +++ b/ptero_eggs/application/database/sql/postgres/README.md @@ -0,0 +1,19 @@ +# PostgreSQL + +## From their [Website](https://www.postgresql.org/) + +The World's Most Advanced Open Source Relational Database + +## Minimum RAM warning + +2 Gigabytes minimum recommended + +See here + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Server | 5432 | diff --git a/ptero_eggs/application/database/sql/postgres/egg-postgres13.json b/ptero_eggs/application/database/sql/postgres/egg-postgres13.json new file mode 100644 index 0000000..408b2f9 --- /dev/null +++ b/ptero_eggs/application/database/sql/postgres/egg-postgres13.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": "2025-01-26T01:12:12+00:00", + "name": "Postgres 13", + "author": "parker@parkervcp.com", + "description": "A default Postgres install that is not really editable.", + "features": [], + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:postgres_13": "ghcr.io\/ptero-eggs\/yolks:postgres_13" + }, + "file_denylist": [], + "startup": "postgres -D \/home\/container\/postgres_db\/ & wait-port; psql -h127.0.0.1 -p{{SERVER_PORT}} --dbname postgres", + "config": { + "files": "{\r\n \"postgres_db\/postgresql.conf\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"#port =\": \"port = {{server.build.default.port}}\",\r\n \"#external_pid_file =\": \"external_pid_file = '\/home\/container\/postgres_db\/run\/postgres.pid'\",\r\n \"#unix_socket_directories =\": \"unix_socket_directories = '\/home\/container\/postgres_db\/run\/'\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"database system is ready to accept connections\"\r\n}", + "logs": "{}", + "stop": "\\q" + }, + "scripts": { + "installation": { + "script": "#! \/bin\/ash\r\nadduser -D -h \/home\/container container\r\n\r\nchown -R container: \/mnt\/server\/\r\n\r\nsu container -c 'initdb -D \/mnt\/server\/postgres_db\/ -A md5 -U \"$PGUSER\" --pwfile=<(echo \"$PGPASSWORD\")'\r\n\r\nmkdir -p \/mnt\/server\/postgres_db\/run\/\r\n\r\n## Add default \"allow from all\" auth rule to pg_hba\r\nif ! grep -q \"# Custom rules\" \"\/mnt\/server\/postgres_db\/pg_hba.conf\"; then\r\n echo -e \"# Custom rules\\nhost all all 0.0.0.0\/0 md5\" >> \"\/mnt\/server\/postgres_db\/pg_hba.conf\"\r\nfi\r\n\r\necho -e \"Done\"", + "container": "postgres:13-alpine", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Superuser Name", + "description": "The username for the postgres superuser", + "env_variable": "PGUSER", + "default_value": "pterodactyl", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Superuser Password", + "description": "The postgres super user password with a strong default.\r\nYou should be generating new ones for each server.\r\nIf you don't then users can hit other users DB's", + "env_variable": "PGPASSWORD", + "default_value": "Pl3453Ch4n63M3!", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/sql/postgres/egg-postgres14.json b/ptero_eggs/application/database/sql/postgres/egg-postgres14.json new file mode 100644 index 0000000..bef5312 --- /dev/null +++ b/ptero_eggs/application/database/sql/postgres/egg-postgres14.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": "2025-01-26T01:12:12+00:00", + "name": "Postgres 14", + "author": "parker@parkervcp.com", + "description": "A default Postgres install that is not really editable.", + "features": [], + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:postgres_14": "ghcr.io\/ptero-eggs\/yolks:postgres_14" + }, + "file_denylist": [], + "startup": "postgres -D \/home\/container\/postgres_db\/ & wait-port; psql -h127.0.0.1 -p{{SERVER_PORT}} --dbname postgres", + "config": { + "files": "{\r\n \"postgres_db\/postgresql.conf\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"#port =\": \"port = {{server.build.default.port}}\",\r\n \"#external_pid_file =\": \"external_pid_file = '\/home\/container\/postgres_db\/run\/postgres.pid'\",\r\n \"#unix_socket_directories =\": \"unix_socket_directories = '\/home\/container\/postgres_db\/run\/'\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"database system is ready to accept connections\"\r\n}", + "logs": "{}", + "stop": "\\q" + }, + "scripts": { + "installation": { + "script": "#! \/bin\/ash\r\nadduser -D -h \/home\/container container\r\n\r\nchown -R container: \/mnt\/server\/\r\n\r\nsu container -c 'initdb -D \/mnt\/server\/postgres_db\/ -A md5 -U \"$PGUSER\" --pwfile=<(echo \"$PGPASSWORD\")'\r\n\r\nmkdir -p \/mnt\/server\/postgres_db\/run\/\r\n\r\n## Add default \"allow from all\" auth rule to pg_hba\r\nif ! grep -q \"# Custom rules\" \"\/mnt\/server\/postgres_db\/pg_hba.conf\"; then\r\n echo -e \"# Custom rules\\nhost all all 0.0.0.0\/0 md5\" >> \"\/mnt\/server\/postgres_db\/pg_hba.conf\"\r\nfi\r\n\r\necho -e \"Done\"", + "container": "postgres:14-alpine", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Superuser Name", + "description": "The username for the postgres superuser", + "env_variable": "PGUSER", + "default_value": "pterodactyl", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Superuser Password", + "description": "The postgres super user password with a strong default.\r\nYou should be generating new ones for each server.\r\nIf you don't then users can hit other users DB's", + "env_variable": "PGPASSWORD", + "default_value": "Pl3453Ch4n63M3!", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/sql/postgres/egg-postgres15.json b/ptero_eggs/application/database/sql/postgres/egg-postgres15.json new file mode 100644 index 0000000..fb1154d --- /dev/null +++ b/ptero_eggs/application/database/sql/postgres/egg-postgres15.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": "2025-01-26T01:12:12+00:00", + "name": "Postgres 15", + "author": "parker@parkervcp.com", + "description": "A default Postgres install that is not really editable.", + "features": [], + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:postgres_15": "ghcr.io\/ptero-eggs\/yolks:postgres_15" + }, + "file_denylist": [], + "startup": "postgres -D \/home\/container\/postgres_db\/ & wait-port; psql -h127.0.0.1 -p{{SERVER_PORT}} --dbname postgres", + "config": { + "files": "{\r\n \"postgres_db\/postgresql.conf\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"#port =\": \"port = {{server.build.default.port}}\",\r\n \"#external_pid_file =\": \"external_pid_file = '\/home\/container\/postgres_db\/run\/postgres.pid'\",\r\n \"#unix_socket_directories =\": \"unix_socket_directories = '\/home\/container\/postgres_db\/run\/'\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"database system is ready to accept connections\"\r\n}", + "logs": "{}", + "stop": "\\q" + }, + "scripts": { + "installation": { + "script": "#! \/bin\/ash\r\nadduser -D -h \/home\/container container\r\n\r\nchown -R container: \/mnt\/server\/\r\n\r\nsu container -c 'initdb -D \/mnt\/server\/postgres_db\/ -A md5 -U \"$PGUSER\" --pwfile=<(echo \"$PGPASSWORD\")'\r\n\r\nmkdir -p \/mnt\/server\/postgres_db\/run\/\r\n\r\n## Add default \"allow from all\" auth rule to pg_hba\r\nif ! grep -q \"# Custom rules\" \"\/mnt\/server\/postgres_db\/pg_hba.conf\"; then\r\n echo -e \"# Custom rules\\nhost all all 0.0.0.0\/0 md5\" >> \"\/mnt\/server\/postgres_db\/pg_hba.conf\"\r\nfi\r\n\r\necho -e \"Done\"", + "container": "postgres:15-alpine", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Superuser Name", + "description": "The username for the postgres superuser", + "env_variable": "PGUSER", + "default_value": "pterodactyl", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Superuser Password", + "description": "The postgres super user password with a strong default.\r\nYou should be generating new ones for each server.\r\nIf you don't then users can hit other users DB's", + "env_variable": "PGPASSWORD", + "default_value": "Pl3453Ch4n63M3!", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/sql/postgres/egg-postgres16.json b/ptero_eggs/application/database/sql/postgres/egg-postgres16.json new file mode 100644 index 0000000..3c03185 --- /dev/null +++ b/ptero_eggs/application/database/sql/postgres/egg-postgres16.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": "2025-01-26T01:12:12+00:00", + "name": "Postgres 16", + "author": "parker@parkervcp.com", + "description": "A default Postgres install that is not really editable.", + "features": [], + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:postgres_16": "ghcr.io\/ptero-eggs\/yolks:postgres_16" + }, + "file_denylist": [], + "startup": "postgres -D \/home\/container\/postgres_db\/ & wait-port; psql -h127.0.0.1 -p{{SERVER_PORT}} --dbname postgres", + "config": { + "files": "{\r\n \"postgres_db\/postgresql.conf\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"#port =\": \"port = {{server.build.default.port}}\",\r\n \"#external_pid_file =\": \"external_pid_file = '\/home\/container\/postgres_db\/run\/postgres.pid'\",\r\n \"#unix_socket_directories =\": \"unix_socket_directories = '\/home\/container\/postgres_db\/run\/'\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"database system is ready to accept connections\"\r\n}", + "logs": "{}", + "stop": "\\q" + }, + "scripts": { + "installation": { + "script": "#! \/bin\/ash\r\nadduser -D -h \/home\/container container\r\n\r\nchown -R container: \/mnt\/server\/\r\n\r\nsu container -c 'initdb -D \/mnt\/server\/postgres_db\/ -A md5 -U \"$PGUSER\" --pwfile=<(echo \"$PGPASSWORD\")'\r\n\r\nmkdir -p \/mnt\/server\/postgres_db\/run\/\r\n\r\n## Add default \"allow from all\" auth rule to pg_hba\r\nif ! grep -q \"# Custom rules\" \"\/mnt\/server\/postgres_db\/pg_hba.conf\"; then\r\n echo -e \"# Custom rules\\nhost all all 0.0.0.0\/0 md5\" >> \"\/mnt\/server\/postgres_db\/pg_hba.conf\"\r\nfi\r\n\r\necho -e \"Done\"", + "container": "postgres:16-alpine", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Superuser Name", + "description": "The username for the postgres superuser", + "env_variable": "PGUSER", + "default_value": "pterodactyl", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Superuser Password", + "description": "The postgres super user password with a strong default.\r\nYou should be generating new ones for each server.\r\nIf you don't then users can hit other users DB's", + "env_variable": "PGPASSWORD", + "default_value": "Pl3453Ch4n63M3!", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/database/sql/postgres/egg-postgres17.json b/ptero_eggs/application/database/sql/postgres/egg-postgres17.json new file mode 100644 index 0000000..0f7936d --- /dev/null +++ b/ptero_eggs/application/database/sql/postgres/egg-postgres17.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": "2025-01-26T01:12:12+00:00", + "name": "Postgres 17", + "author": "parker@parkervcp.com", + "description": "A default Postgres install that is not really editable.", + "features": [], + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:postgres_17": "ghcr.io\/ptero-eggs\/yolks:postgres_17" + }, + "file_denylist": [], + "startup": "postgres -D \/home\/container\/postgres_db\/ & wait-port; psql -h127.0.0.1 -p{{SERVER_PORT}} --dbname postgres", + "config": { + "files": "{\r\n \"postgres_db\/postgresql.conf\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"#port =\": \"port = {{server.build.default.port}}\",\r\n \"#external_pid_file =\": \"external_pid_file = '\/home\/container\/postgres_db\/run\/postgres.pid'\",\r\n \"#unix_socket_directories =\": \"unix_socket_directories = '\/home\/container\/postgres_db\/run\/'\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"database system is ready to accept connections\"\r\n}", + "logs": "{}", + "stop": "\\q" + }, + "scripts": { + "installation": { + "script": "#! \/bin\/ash\r\nadduser -D -h \/home\/container container\r\n\r\nchown -R container: \/mnt\/server\/\r\n\r\nsu container -c 'initdb -D \/mnt\/server\/postgres_db\/ -A md5 -U \"$PGUSER\" --pwfile=<(echo \"$PGPASSWORD\")'\r\n\r\nmkdir -p \/mnt\/server\/postgres_db\/run\/\r\n\r\n## Add default \"allow from all\" auth rule to pg_hba\r\nif ! grep -q \"# Custom rules\" \"\/mnt\/server\/postgres_db\/pg_hba.conf\"; then\r\n echo -e \"# Custom rules\\nhost all all 0.0.0.0\/0 md5\" >> \"\/mnt\/server\/postgres_db\/pg_hba.conf\"\r\nfi\r\n\r\necho -e \"Done\"", + "container": "postgres:17-alpine", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Superuser Name", + "description": "The username for the postgres superuser", + "env_variable": "PGUSER", + "default_value": "pterodactyl", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Superuser Password", + "description": "The postgres super user password with a strong default.\r\nYou should be generating new ones for each server.\r\nIf you don't then users can hit other users DB's", + "env_variable": "PGPASSWORD", + "default_value": "Pl3453Ch4n63M3!", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/elasticsearch/README.md b/ptero_eggs/application/elasticsearch/README.md new file mode 100644 index 0000000..9b140f9 --- /dev/null +++ b/ptero_eggs/application/elasticsearch/README.md @@ -0,0 +1,17 @@ +# Elasticsearch + +## From the [Elasticsearch](https://github.com/elastic/elasticsearch) GitHub + +Run [Elasticsearch](https://github.com/elastic/elasticsearch) on any machine anywhere and access it in the browser. + +## vm.max_map_count requirement + +Please follow this for the vm.max_map_count requirement: + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +| ---- | ------- | +| Game | 9200 | diff --git a/ptero_eggs/application/elasticsearch/egg-elasticsearch.json b/ptero_eggs/application/elasticsearch/egg-elasticsearch.json new file mode 100644 index 0000000..3a85580 --- /dev/null +++ b/ptero_eggs/application/elasticsearch/egg-elasticsearch.json @@ -0,0 +1,52 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:58+00:00", + "name": "Elasticsearch", + "author": "dominic@stilma.net", + "description": "Elasticsearch is a distributed, RESTful search and analytics engine capable of addressing a growing number of use cases. As the heart of the Elastic Stack, it centrally stores your data for lightning fast search, fine‑tuned relevancy, and powerful analytics that scale with ease.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:debian": "ghcr.io/ptero-eggs/yolks:debian" + }, + "file_denylist": [], + "startup": "./bin/elasticsearch -E network.host=0.0.0.0 -E http.port={{SERVER_PORT}} -E discovery.type={{DISCOVERY_SEED_HOSTS}}", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"started\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n# Elasticsearch Installation Script\r\n#\r\n# Server Files: /mnt/server\r\n\r\n## Install Requirements\r\n\r\ncd /mnt/server\r\n\r\n## Install Elasticsearch\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] \u0026\u0026 echo \"x86_64\" || echo \"aarch64\")\r\ncurl -sSL -o elasticsearch.tar.gz https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-$VERSION-linux-${ARCH}.tar.gz\r\n\r\ntar -zxf elasticsearch.tar.gz --directory /mnt/server\r\nmv elasticsearch*/* /mnt/server\r\nrm elasticsearch.tar.gz\r\nrm -R elasticsearch-*\r\n\r\n## Finish command\r\necho \"All done! Just start it up :)\"" + } + }, + "variables": [ + { + "name": "Discovery Seed Hosts", + "description": "Please keep default if you are unsure.", + "env_variable": "DISCOVERY_SEED_HOSTS", + "default_value": "single-node", + "user_viewable": true, + "user_editable": true, + "rules": "required", + "field_type": "text" + }, + { + "name": "Elasticsearch Version", + "description": "Go to https://www.elastic.co/downloads/elasticsearch and look at the version at the top.", + "env_variable": "VERSION", + "default_value": "8.13.0", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/foldingathome/README.md b/ptero_eggs/application/foldingathome/README.md new file mode 100644 index 0000000..817293c --- /dev/null +++ b/ptero_eggs/application/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 | diff --git a/ptero_eggs/application/foldingathome/egg-folding--home.json b/ptero_eggs/application/foldingathome/egg-folding--home.json new file mode 100644 index 0000000..11291cd --- /dev/null +++ b/ptero_eggs/application/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": "2024-09-08T19:48:06+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": [], + "docker_images": { + "Debian": "ghcr.io\/ptero-eggs\/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\/v7\/public\/fahclient\/debian-stable-${ARCH}\/release\/fahclient_${FAH_VERSION}-64bit-release.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\r\n \r\n \r\n \r\n \r\n<\/config>\r\nEOF\r\nfi\r\n\r\necho \"Done!\"", + "container": "ghcr.io\/ptero-eggs\/installers: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\/v7\/public\/fahclient\/debian-stable-64bit\/release\/", + "env_variable": "FAH_VERSION", + "default_value": "7.6.21", + "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" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/forgejo/README.md b/ptero_eggs/application/forgejo/README.md new file mode 100644 index 0000000..bdd440f --- /dev/null +++ b/ptero_eggs/application/forgejo/README.md @@ -0,0 +1,18 @@ +# Forgejo + +[Forgejo](https://forgejo.org/) is a community managed lightweight code hosting solution written in Go. It is published under the MIT license. + +## Supported Versions +You can set the version in Version variable. You can use following values: + +latest - latest stable release +version - set the version according to this page: https://forgejo.org/releases/ + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +| ---- | ------- | +| App | 3000 | +| SSH | 2020 | diff --git a/ptero_eggs/application/forgejo/egg-forgejo.json b/ptero_eggs/application/forgejo/egg-forgejo.json new file mode 100644 index 0000000..1d3771a --- /dev/null +++ b/ptero_eggs/application/forgejo/egg-forgejo.json @@ -0,0 +1,64 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:58+00:00", + "name": "Forgejo", + "author": "seaswimmerthefsh@gmail.com", + "description": "Forgejo is a community managed lightweight code hosting solution written in Go. It is published under the MIT license, and is a fork of Gitea.", + "features": null, + "docker_images": { + "Debian": "ghcr.io/ptero-eggs/yolks:debian" + }, + "file_denylist": [ + "forgejo" + ], + "startup": "./forgejo web -p {{SERVER_PORT}} -c ./app.ini", + "config": { + "files": "{\r\n \"custom/app.ini\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"DISABLE_SSH\": \"DISABLE_SSH: {{server.build.env.DISABLE_SSH}}\",\r\n \"SSH_PORT\": \"SSH_PORT: {{server.build.env.SSH_PORT}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Listen: \"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/yolks:debian", + "entrypoint": "bash", + "script": "## Forgejo Installscript\r\n## Modified version of the Gitea installscript, see https://github.com/parkervcp/eggs/blob/master/software/gitea/egg-gitea.json\r\n\r\n## update system\r\napt update\r\napt -y install --no-install-recommends jq curl ca-certificates dnsutils\r\n\r\n## Variables\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] \u0026\u0026 echo \"amd64\" || echo \"arm64\")\r\nLATEST=$(dig +short release.forgejo.org TXT | grep -oE '([0-9]+\\.){2}[0-9]+(-[a-zA-Z0-9]+)*')\r\n\r\n\r\ncd /mnt/server\r\n\r\n## install forgejo\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n echo -e \"Downloading Forgejo $LATEST (latest)\"\r\n URL=https://codeberg.org/forgejo/forgejo/releases/download/v${LATEST}/forgejo-${LATEST}-linux-${ARCH}\r\nelse\r\n echo -e \"Downloading Forgejo $VERSION\"\r\n URL=https://codeberg.org/forgejo/forgejo/releases/download/v${VERSION}/forgejo-${VERSION}-linux-${ARCH}\r\nfi\r\n\r\necho -e \"Download URL: $URL\"\r\n\r\ncurl -sSL -o forgejo $URL\r\n\r\nchmod +x forgejo\r\n\r\nmkdir -p custom\r\n\r\nif [ -f \"/mnt/server/custom/app.ini\" ]; then\r\n echo \"Config file exists\"\r\nelse\r\n echo \"[server]\r\n LOCAL_ROOT_URL = http://${SERVER_IP}:${SERVER_PORT}/\r\n DOMAIN = ${SERVER_IP}\r\n HTTP_PORT = ${SERVER_PORT}\r\n ROOT_URL = http://${SERVER_IP}:${SERVER_PORT}/\r\n DISABLE_SSH = ${DISABLE_SSH}\r\n SSH_PORT = ${SSH_PORT}\" \u003e /mnt/server/custom/app.ini\r\nfi\r\n\r\necho -e \"-------------------------------------------------\"\r\necho -e \"Installation completed\"\r\necho -e \"-------------------------------------------------\"" + } + }, + "variables": [ + { + "name": "Disable SSH", + "description": "Disable the SSH feature when it’s not available.", + "env_variable": "DISABLE_SSH", + "default_value": "false", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|in:true,false", + "field_type": "text" + }, + { + "name": "SSH Port", + "description": "SSH port displayed in clone URL.", + "env_variable": "SSH_PORT", + "default_value": "2020", + "user_viewable": true, + "user_editable": false, + "rules": "required|integer|between:1024,65535", + "field_type": "text" + }, + { + "name": "Version", + "description": "Use either `latest` or a specific version, such as `1.21.7-0`.", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:15", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/gitea/README.md b/ptero_eggs/application/gitea/README.md new file mode 100644 index 0000000..83df836 --- /dev/null +++ b/ptero_eggs/application/gitea/README.md @@ -0,0 +1,19 @@ +# Gitea + +[Gitea](https://gitea.io/en-us/) is a community managed lightweight code hosting solution written in Go. It is published under the MIT license. + +## Supported Versions +You can set the version in Version variable. You can use following values: + +latest - latest stable release +nightly - latest Github master branch +version - set the version according this page: https://dl.gitea.io/gitea + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +| ---- | ------- | +| App | 3000 | +| SSH | 2020 | diff --git a/ptero_eggs/application/gitea/egg-gitea.json b/ptero_eggs/application/gitea/egg-gitea.json new file mode 100644 index 0000000..8d45929 --- /dev/null +++ b/ptero_eggs/application/gitea/egg-gitea.json @@ -0,0 +1,62 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:59+00:00", + "name": "Gitea", + "author": "mario.franze@gmail.com", + "description": "Gitea is a community managed lightweight code hosting solution written in Go. It is published under the MIT license.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:debian": "ghcr.io/ptero-eggs/yolks:debian" + }, + "file_denylist": [], + "startup": "./gitea web -p {{SERVER_PORT}} -c ./app.ini", + "config": { + "files": "{\r\n \"custom/app.ini\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"DISABLE_SSH\": \"DISABLE_SSH: {{server.build.env.DISABLE_SSH}}\",\r\n \"SSH_PORT\": \"SSH_PORT: {{server.build.env.SSH_PORT}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Listen: \"\r\n}", + "stop": "^^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "## Gitea Installscript\r\n\r\n## update system\r\napt update\r\napt -y install --no-install-recommends jq curl ca-certificates\r\n\r\n## Variables\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] \u0026\u0026 echo \"amd64\" || echo \"arm64\")\r\nLATEST=$(curl -sSL https://dl.gitea.io/gitea/version.json | jq -r .latest.version)\r\n\r\n\r\ncd /mnt/server\r\n\r\n## install gitea\r\necho -e \"Download url: https://dl.gitea.io/gitea/${LATEST}/gitea-${LATEST}-linux-${ARCH}\"\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n echo -e \"downloading Gitea $LATEST\"\r\n curl -sSL -o gitea https://dl.gitea.io/gitea/${LATEST}/gitea-${LATEST}-linux-${ARCH}\r\nelif [ \"${VERSION}\" == \"nightly\" ]; then\r\n echo -e \"downloading Gitea nightly\"\r\n curl -sSL -o gitea https://dl.gitea.io/gitea/main/gitea-main-linux-${ARCH}\r\nelse\r\n curl -sSL -o gitea https://dl.gitea.io/gitea/${VERSION}/gitea-${VERSION}-linux-${ARCH}\r\n echo -e \"downloading Gitea $VERSION\"\r\nfi\r\n\r\nchmod +x gitea\r\n\r\nmkdir -p custom\r\n\r\nif [ -f \"/mnt/server/custom/app.ini\" ]; then\r\n echo \"config file exists\"\r\nelse\r\n echo \"[server]\r\n LOCAL_ROOT_URL = http://${SERVER_IP}:${SERVER_PORT}/\r\n DOMAIN = ${SERVER_IP}\r\n HTTP_PORT = ${SERVER_PORT}\r\n ROOT_URL = http://${SERVER_IP}:${SERVER_PORT}/\r\n DISABLE_SSH = ${DISABLE_SSH}\r\n SSH_PORT = ${SSH_PORT}\" \u003e /mnt/server/custom/app.ini\r\nfi\r\n\r\necho -e \"-------------------------------------------------\"\r\necho -e \"Installation completed\"\r\necho -e \"-------------------------------------------------\"" + } + }, + "variables": [ + { + "name": "Disable SSH", + "description": "Disable SSH feature when it’s not available", + "env_variable": "DISABLE_SSH", + "default_value": "false", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|in:true,false", + "field_type": "text" + }, + { + "name": "SSH Port", + "description": "SSH port displayed in clone URL.", + "env_variable": "SSH_PORT", + "default_value": "2020", + "user_viewable": true, + "user_editable": false, + "rules": "required|integer|between:1024,65535", + "field_type": "text" + }, + { + "name": "Version", + "description": "you can use latest, nightly or version (e.g. 1.18.1)", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/grafana/README.md b/ptero_eggs/application/grafana/README.md new file mode 100644 index 0000000..5320008 --- /dev/null +++ b/ptero_eggs/application/grafana/README.md @@ -0,0 +1,27 @@ +# Grafana + +## From the [Grafana](https://github.com/grafana/grafana) GitHub + +The open and composable observability and data visualization platform. +Visualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more. + +## Initial credentials + +After the first start of Grafana, you can login using the following credentials: + +- Username: admin +- Password: admin + +## Update support + +The egg _should_ keep the data and conf folder when reinstalling. Therefore a reinstallation with "latest" as the selected version can be used to update Grafana. + +If you want to reset the server completly, remove the `conf` and `data` directories manually before reinstalling. + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +| ------------ | ------- | +| Webinterface | 3000 | diff --git a/ptero_eggs/application/grafana/egg-grafana.json b/ptero_eggs/application/grafana/egg-grafana.json new file mode 100644 index 0000000..3f9a760 --- /dev/null +++ b/ptero_eggs/application/grafana/egg-grafana.json @@ -0,0 +1,52 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:41:00+00:00", + "name": "Grafana", + "author": "p.zarrad@outlook.de", + "description": "The open and composable observability and data visualization platform.\r\nVisualize metrics, logs, and traces from multiple sources like Prometheus, Loki, Elasticsearch, InfluxDB, Postgres and many more.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:debian": "ghcr.io/ptero-eggs/yolks:debian" + }, + "file_denylist": [], + "startup": "./bin/grafana server web", + "config": { + "files": "{\r\n \"conf/defaults.ini\": {\r\n \"parser\": \"ini\",\r\n \"find\": {\r\n \"server.http_port\": \"{{server.build.default.port}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"HTTP Server Listen\"\r\n}", + "stop": "^^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\nshopt -s extglob\r\n\r\n# Switch to mounted directory\r\nmkdir -p /mnt/server\r\ncd /mnt/server\r\n\r\n# Update installation system and install curl\r\napt-get update\r\napt-get install -y curl\r\n\r\n# Cleanup previous install if available\r\nif [ -d \"conf\" ]; then mv conf conf.bak; fi\r\nrm -rfv !(conf.bak|data)\r\n\r\n# Download and extract Grafana\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] \u0026\u0026 echo \"amd64\" || echo \"arm64\")\r\n\r\nversion=${GRAFANA_VERSION}\r\nif [ \"$version\" = \"latest\" ]; then version=$(curl --silent \"https://api.github.com/repos/grafana/grafana/releases/latest\" | grep '\"tag_name\":' | sed -E 's/.*\"([^\"]+)\".*/\\1/' | cut -c2-); fi\r\ncurl https://dl.grafana.com/oss/release/grafana-${version}.linux-${ARCH}.tar.gz --output grafana.tar.gz\r\ntar -zxvf grafana.tar.gz\r\nmv -n grafana-*/* ./\r\nrm -rf grafana.tar.gz grafana-*/\r\n\r\n# Restore configuration if necessary\r\nif [ -d \"conf.bak\" ]; then rm -rf conf \u0026\u0026 mv conf.bak conf \u0026\u0026 rm -rf conf.bak; fi\r\n\r\n# Update existing plugins and install Grafana plugins\r\nif [ ! -z \"${GRAFANA_PLUGINS}\" ]; then\r\nfor v in $(tr ',' '\\n' \u003c\u003c\u003c \"${GRAFANA_PLUGINS}\") ; do ./bin/grafana-cli --pluginsDir=\"/mnt/server/data/plugins\" plugins install \"$v\" ; done\r\nfi\r\n\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------" + } + }, + "variables": [ + { + "name": "Grafana Version", + "description": "The version of Grafana to install. By default the latest version is being installed.", + "env_variable": "GRAFANA_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Grafana Plugins", + "description": "A list of Grafana plugins that should be installed. Enter the plugins comma separated (e. g. a,b,c).", + "env_variable": "grafana_plugins", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/haste-server/README.md b/ptero_eggs/application/haste-server/README.md new file mode 100644 index 0000000..b337cb5 --- /dev/null +++ b/ptero_eggs/application/haste-server/README.md @@ -0,0 +1,13 @@ +# haste-server + +## Their [Github](https://github.com/seejohnrun/haste-server) + +Host your own [Hastebin](https://hastebin.com). + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +| ---- | ------- | +| Game | 7777 | diff --git a/ptero_eggs/application/haste-server/egg-haste-server.json b/ptero_eggs/application/haste-server/egg-haste-server.json new file mode 100644 index 0000000..5308c5f --- /dev/null +++ b/ptero_eggs/application/haste-server/egg-haste-server.json @@ -0,0 +1,31 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:41:01+00:00", + "name": "haste-server", + "author": "eggs@harryw.link", + "description": "Haste is an open-source pastebin software written in node.js, which is easily installable in any network. It can be backed by either redis or filesystem, and has a very easy adapter interface for other stores. A publicly available version can be found at hastebin.com", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:nodejs_18": "ghcr.io/ptero-eggs/yolks:nodejs_18" + }, + "file_denylist": [], + "startup": "npm start", + "config": { + "files": "{\r\n \"config.js\": {\r\n \"parser\": \"json\",\r\n \"find\": {\r\n \"port\": \"{{server.build.default.port}}\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"listening on\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "node:18-bookworm-slim", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n\r\napt update\r\napt install -y git curl\r\nmkdir -p /mnt/server\r\ncd /mnt/server\r\n\r\ngit clone https://github.com/toptal/haste-server\r\ncd haste-server\r\nmv * /mnt/server\r\ncd ..\r\nrm -rf haste-server\r\nnpm install\r\n\r\nexit 0" + } + }, + "variables": [] +} \ No newline at end of file diff --git a/ptero_eggs/application/languagetool/README.md b/ptero_eggs/application/languagetool/README.md new file mode 100644 index 0000000..1ed45d7 --- /dev/null +++ b/ptero_eggs/application/languagetool/README.md @@ -0,0 +1,9 @@ +# LanguageTool + +LanguageTool is an Open Source proofreading software for English, French, German, Polish, Russian, [and more than 20 other languages](https://languagetool.org/languages/). It finds many errors that a simple spell checker cannot find. + +View https://languagetool.org for more information. + +Requires one port for comunication. + +Try `addr:port/v2/check?language=en-US&text=this+is+a+test` to test diff --git a/ptero_eggs/application/languagetool/egg-language-tool.json b/ptero_eggs/application/languagetool/egg-language-tool.json new file mode 100644 index 0000000..2a9a9bd --- /dev/null +++ b/ptero_eggs/application/languagetool/egg-language-tool.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:41:01+00:00", + "name": "LanguageTool", + "author": "thomasruhl@live.de", + "description": "This egg installs a LanguageTool server\r\n\r\nLanguageTool is an Open Source proofreading software for English, French, German, Polish, Russian, and more than 20 other languages. It finds many errors that a simple spell checker cannot find.\r\n\r\nView https://languagetool.org for more information.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:java_17": "ghcr.io/ptero-eggs/yolks:java_17" + }, + "file_denylist": [], + "startup": "java -cp languagetool-server.jar org.languagetool.server.HTTPServer --port {{SERVER_PORT}} --allow-origin --public --config config.properties", + "config": { + "files": "{\r\n \"config.properties\": {\r\n \"parser\": \"properties\",\r\n \"find\": {\r\n \"languageModel\": \"models/\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Server started\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:alpine", + "entrypoint": "ash", + "script": "#!/bin/ash\r\napk add --no-cache unzip # to make shure the unzipper is working properly\r\nmkdir -p /mnt/server\r\nmkdir -p /mnt/server/models\r\ntouch config.properties\r\n\r\n# if TRAIN_MODELS has content install them\r\nif [ -n TRAIN_MODELS ]; then\r\n\r\n content=$(curl -L https://languagetool.org/download/ngram-data/)\r\n\r\n links=$(echo \"$content\" | grep -o '\u003ca href=\"[^\"]*\\.zip\"\u003e' | sed 's/\u003ca href=\"//' | sed 's/\"\u003e//')\r\n echo $links\r\n\r\n cd /mnt/server/models\r\n for model in $TRAIN_MODELS; do\r\n echo \"$model\"\r\n for link in $links; do\r\n # echo \" $link\"\r\n if [[ $link == *\"-$model-\"* ]]; then\r\n fullLink=\"https://languagetool.org/download/ngram-data/$link\"\r\n echo \"Downloading $fullLink\"\r\n echo \"this could take some while\"\r\n curl $fullLink --output $model.zip\r\n echo \"unziping $model.zip\"\r\n unzip $model.zip\r\n rm $model.zip\r\n fi\r\n done\r\n done\r\nfi\r\n\r\n# main languagetool install\r\ncd /mnt/server\r\n\r\necho \"downloading languagetool\"\r\ncurl https://languagetool.org/download/LanguageTool-stable.zip --output download.zip\r\necho unziping\r\nunzip download.zip\r\necho moving files\r\n\r\ncp -r LanguageTool-*/* .\r\n\r\nrm -rf LanguageTool-*\r\nrm download.zip -rf\r\n\r\necho Finished install" + } + }, + "variables": [ + { + "name": "Include traindata", + "description": "This uses many gigabytes of disk space. \r\n\r\nSeparate each value with spaces. For example, \"de en\". \r\n\r\nView all available models at https://languagetool.org/download/ngram-data/", + "env_variable": "TRAIN_MODELS", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/lavalink/README.md b/ptero_eggs/application/lavalink/README.md new file mode 100644 index 0000000..42fed78 --- /dev/null +++ b/ptero_eggs/application/lavalink/README.md @@ -0,0 +1,15 @@ +# Lavalink Server + +## From their [Github](https://github.com/lavalink-devs/Lavalink) + +Standalone audio sending node based on Lavaplayer and JDA-Audio. Allows for sending audio without it ever reaching any of your shards. + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|----------|----------| +| Lavalink | 2333 | + +### Mods/Plugins may require ports to be added to the server diff --git a/ptero_eggs/application/lavalink/egg-lavalink.json b/ptero_eggs/application/lavalink/egg-lavalink.json new file mode 100644 index 0000000..98c2213 --- /dev/null +++ b/ptero_eggs/application/lavalink/egg-lavalink.json @@ -0,0 +1,62 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2024-12-11T19:05:06+00:00", + "name": "Lavalink", + "author": "damuffin36@gmail.com", + "description": "A standalone audio sending node based on Lavaplayer and Koe. Allows for sending audio without it ever reaching any of your shards.\r\nDescription taken from https:\/\/github.com\/lavalink-devs\/Lavalink", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:java_21": "ghcr.io\/ptero-eggs\/yolks:java_21" + }, + "file_denylist": [], + "startup": "java -jar Lavalink.jar", + "config": { + "files": "{\r\n \"application.yml\": {\r\n \"parser\": \"yml\",\r\n \"find\": {\r\n \"server.address\": \"0.0.0.0\",\r\n \"server.port\": \"{{server.build.default.port}}\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"Started Launcher in \"\r\n}", + "logs": "{}", + "stop": "^^C" + }, + "scripts": { + "installation": { + "script": "## this is a simple script to use the github API for release versions.\r\n## this requires the egg has a variable for GITHUB_PACKAGE, VERSION and MATCH (match is to match the filename in some way)\r\n## this supports using oauth\/personal access tokens via GITHUB_USER and GITHUB_OAUTH_TOKEN (both are required.)\r\n## if you are getting hit with GitHub API limit issues then you need to have the user and token set.\r\napt update\r\napt install -y curl jq git\r\n\r\ncd \/mnt\/server\r\n\r\nif [ -z \"${GITHUB_USER}\" ] && [ -z \"${GITHUB_OAUTH_TOKEN}\" ] ; then\r\n echo -e \"using anon api call\"\r\nelse\r\n echo -e \"user and oauth token set\"\r\n alias curl='curl -u ${GITHUB_USER}:${GITHUB_OAUTH_TOKEN} '\r\nfi\r\n\r\n## get release info and download links\r\nLATEST_JSON=$(curl --silent \"https:\/\/api.github.com\/repos\/${GITHUB_PACKAGE}\/releases\/latest\")\r\nRELEASES=$(curl --silent \"https:\/\/api.github.com\/repos\/${GITHUB_PACKAGE}\/releases\")\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i ${MATCH})\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i ${MATCH})\r\n else\r\n echo -e \"defaulting to latest release\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url)\r\n fi\r\nfi\r\nif [ ! -z \"${DOWNLOAD_URL}\" ]; then \r\n if curl --output \/dev\/null --silent --head --fail ${DOWNLOAD_URL}; then\r\n echo -e \"link is valid. setting download link to ${DOWNLOAD_URL}\"\r\n DOWNLOAD_LINK=${DOWNLOAD_URL}\r\n else \r\n echo -e \"link is invalid closing out\"\r\n exit 2\r\n fi\r\nfi\r\n\r\ncurl -L -o Lavalink.jar ${DOWNLOAD_URL}\r\ncurl -L -o application.yml https:\/\/raw.githubusercontent.com\/freyacodes\/Lavalink\/master\/LavalinkServer\/application.yml.example\r\n\r\necho \"-------------------------------------------------------\"\r\necho \"Installation completed\"\r\necho \"-------------------------------------------------------\"", + "container": "debian:bookworm-slim", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Version", + "description": "", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "GITHUB_PACKAGE", + "description": "", + "env_variable": "GITHUB_PACKAGE", + "default_value": "lavalink-devs\/Lavalink", + "user_viewable": false, + "user_editable": false, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Match", + "description": "", + "env_variable": "MATCH", + "default_value": "Lavalink.jar", + "user_viewable": false, + "user_editable": false, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/meilisearch/README.md b/ptero_eggs/application/meilisearch/README.md new file mode 100644 index 0000000..1c71382 --- /dev/null +++ b/ptero_eggs/application/meilisearch/README.md @@ -0,0 +1,7 @@ +# [Meilisearch](https://www.meilisearch.com/) + +An open-source, lightning-fast, and hyper-relevant search engine that fits effortlessly into your workflow. + +## Server Ports + +One port needs to be allocated to run Meilisearch. diff --git a/ptero_eggs/application/meilisearch/egg-meilisearch.json b/ptero_eggs/application/meilisearch/egg-meilisearch.json new file mode 100644 index 0000000..eb4b0bd --- /dev/null +++ b/ptero_eggs/application/meilisearch/egg-meilisearch.json @@ -0,0 +1,112 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:52+00:00", + "name": "Meilisearch", + "author": "josdekurk@gmail.com", + "description": "A lightning-fast search engine that fits effortlessly into your apps, websites, and workflow.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:debian": "ghcr.io/ptero-eggs/yolks:debian" + }, + "file_denylist": [], + "startup": "./meilisearch --http-addr \"0.0.0.0:{{SERVER_PORT}}\" --max-indexing-memory=\"{{SERVER_MEMORY}}mb\" $([ \"$NO_ANALYTICS\" -eq 1 ] \u0026\u0026 echo \"--no-analytics\")", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Actix runtime found; starting in Actix runtime\"\r\n}", + "stop": "^^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n\r\n## get release info and download links\r\nLATEST_JSON=$(curl --silent \"https://api.github.com/repos/meilisearch/meilisearch/releases/latest\")\r\nRELEASES=$(curl --silent \"https://api.github.com/repos/meilisearch/meilisearch/releases\")\r\nMATCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] \u0026\u0026 echo \"linux-amd64\" || echo \"linux-aarch64\")\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i ${MATCH})\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i ${MATCH})\r\n else\r\n echo -e \"defaulting to latest release\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url)\r\n fi\r\nfi\r\n\r\nmkdir -p /mnt/server\r\ncd /mnt/server\r\n\r\n## Config file\r\nFILE=/mnt/server/config.toml\r\nif [ -f \"$FILE\" ]; then\r\n echo \"Config file exits\"\r\nelse \r\n echo \"Config does not exist. Making one\"\r\n curl -sSL -o config.toml https://raw.githubusercontent.com/meilisearch/meilisearch/latest/config.toml\r\nfi\r\n\r\ncurl -sSL -o meilisearch ${DOWNLOAD_URL}\r\nchmod +x meilisearch\r\n\r\n# Make the needed directory's \r\nmkdir -p /mnt/server/dumps\r\nmkdir -p /mnt/server/data.ms\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [ + { + "name": "Master key", + "description": "In production, a Master key of at least 16 bytes is mandatory\r\nSets the instance's master key, automatically protecting all routes except GET /health. This means you will need a valid API key to access all other endpoints.", + "env_variable": "MEILI_MASTER_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:64", + "field_type": "text" + }, + { + "name": "Environment", + "description": "Configures the instance's environment. Value must be either production or development.", + "env_variable": "MEILI_ENV", + "default_value": "development", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:development,production", + "field_type": "text" + }, + { + "name": "Disable analytics", + "description": "Deactivates Meilisearch's built-in telemetry when provided.", + "env_variable": "NO_ANALYTICS", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|boolean", + "field_type": "text" + }, + { + "name": "Dumps dir", + "description": "Sets the directory where Meilisearch will create dump files.", + "env_variable": "MEILI_DUMP_DIR", + "default_value": "/home/container/dumps", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:64", + "field_type": "text" + }, + { + "name": "DB PATH", + "description": "Designates the location where database files will be created and retrieved.", + "env_variable": "MEILI_DB_PATH", + "default_value": "/home/container/data.ms", + "user_viewable": true, + "user_editable": false, + "rules": "required|string|max:64", + "field_type": "text" + }, + { + "name": "Log level", + "description": "Defines how much detail should be present in Meilisearch's logs.", + "env_variable": "MEILI_LOG_LEVEL", + "default_value": "INFO", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:INFO,WARN,ERROR,TRACE", + "field_type": "text" + }, + { + "name": "Config Path", + "description": "Designates the location of the configuration file to load at launch.", + "env_variable": "MEILI_CONFIG_FILE_PATH", + "default_value": "/home/container/config.toml", + "user_viewable": true, + "user_editable": false, + "rules": "required|string", + "field_type": "text" + }, + { + "name": "Max threads", + "description": "Sets the maximum number of threads Meilisearch can use during indexing", + "env_variable": "MEILI_MAX_INDEXING_THREADS", + "default_value": "2", + "user_viewable": true, + "user_editable": false, + "rules": "required|integer", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/minio/README.md b/ptero_eggs/application/minio/README.md new file mode 100644 index 0000000..3d5998e --- /dev/null +++ b/ptero_eggs/application/minio/README.md @@ -0,0 +1,25 @@ +# minio s3 + +## Features + +Auto generate keys on server creation bypassing default minio keys + +## Update + +Auto update minio to latest version using "update" startup feature + +Automatic Key rotation using "rotate" startup feature + +## Auto Rotate + +It's possible to rotate your keys by changing the startup option to "rotate" + +Once this is changed restart your server and it will automatically move your current keys to old and create your new keys + +Be sure to change your startup back to "normal" once you have started your server using "rotate". This will ensure that you don't accidentally rotate your keys twice + +## Known Issues + +Double encryption may occur if you manually manipulate files in the keys directory + +### Key rotation is handled automatically, DO NOT manually delete files in keys directory diff --git a/ptero_eggs/application/minio/egg-minio-s3.json b/ptero_eggs/application/minio/egg-minio-s3.json new file mode 100644 index 0000000..dc78a14 --- /dev/null +++ b/ptero_eggs/application/minio/egg-minio-s3.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2025-10-02T23:22:38+02:00", + "name": "Minio S3", + "author": "accounts@bofanodes.io", + "description": "MinIO is a cloud storage server compatible with Amazon S3, released under Apache License v2. As an object store, MinIO can store unstructured data such as photos, videos, log files, backups and container images. The maximum size of an object is 5TB.", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:debian": "ghcr.io\/ptero-eggs\/yolks:debian" + }, + "file_denylist": [], + "startup": ".\/minio.sh", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"Docs:\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash\r\n#\r\napt update\r\napt install -y wget\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] && echo \"amd64\" || echo \"arm64\")\r\ncd \/mnt\/server\r\nwget https:\/\/dl.min.io\/server\/minio\/release\/linux-${ARCH}\/minio\r\nchmod +x minio\r\nmkdir data\r\nmkdir keys\r\n\r\nwget https:\/\/raw.githubusercontent.com\/Ptero-Eggs\/application-eggs\/main\/minio\/minio.sh\r\nchmod +x minio.sh\r\nexport MINIO_ACCESS_KEY=$(cat \/dev\/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)\r\necho $MINIO_ACCESS_KEY > keys\/key.txt\r\nexport MINIO_SECRET_KEY=$(cat \/dev\/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1)\r\necho $MINIO_SECRET_KEY > keys\/secret.txt\r\necho done", + "container": "ghcr.io\/ptero-eggs\/installers:debian", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Startup Type", + "description": "normal,rotate,update", + "env_variable": "STARTUP_TYPE", + "default_value": "normal", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|in:normal,rotate,update", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/minio/minio.sh b/ptero_eggs/application/minio/minio.sh new file mode 100644 index 0000000..473cc9f --- /dev/null +++ b/ptero_eggs/application/minio/minio.sh @@ -0,0 +1,70 @@ +#!/bin/bash +################################## +echo "$(tput setaf 2)Starting up...." +echo "Startup Type: $(tput setaf 2)$STARTUP_TYPE" +if [ -f "keys/key.txt" ]; then +echo "$(tput setaf 2)Key file detected..." +export MINIO_ROOT_USER=`cat keys/key.txt` +else +echo minioadmin > keys/key.txt +echo "$(tput setaf 3)No key file detected...Preparing First Time Boot" +fi +if [ -f "keys/secret.txt" ]; then +echo "$(tput setaf 2)Secret file detected..." +export MINIO_ROOT_PASSWORD=`cat keys/secret.txt` +else +echo minioadmin > keys/secret.txt +echo "No secret file detected...Preparing First Time Boot" +fi +if [ -f "keys/oldsecret.txt" ]; then +echo "$(tput setaf 1)Old secret file detected..." +export MINIO_ROOT_PASSWORD_OLD=`cat keys/oldsecret.txt` +fi +if [ -f "keys/oldkey.txt" ]; then +echo "$(tput setaf 1)Old key file detected..." +export MINIO_ROOT_USER_OLD=`cat keys/oldkey.txt` +fi +if [ -f "keys/justrotated.txt" ]; then +echo "$(tput setaf 3)Previous key rotation detected...." +echo "$(tput setaf 3)Clearing the Lanes...." +unset MINIO_ROOT_USER_OLD +unset MINIO_ROOT_PASSWORD_OLD +echo "$(tput setaf 2)Lanes Cleared!" +STARTUP_TYPE=normal +rm keys/justrotated.txt +rm keys/oldsecret.txt +rm keys/oldkey.txt +fi + +########################################## +if [ -z "$STARTUP_TYPE" ] || [ "$STARTUP_TYPE" == "update" ]; then +echo "$(tput setaf 3)Performing update...." +echo "$(tput setaf 1)Removing old minio version" +rm minio +echo "$(tput setaf 3)Downloading new minio version" +export ARCH=$([[ "$(uname -m)" == "x86_64" ]] && echo "amd64" || echo "arm64") +wget https://dl.min.io/server/minio/release/linux-$ARCH/minio +chmod +x minio +echo "$(tput setaf 2)Update Complete" +fi +########################################## +if [ -z "$STARTUP_TYPE" ] || [ "$STARTUP_TYPE" == "rotate" ]; then +touch keys/justrotated.txt +export MINIO_ROOT_USER_OLD=$MINIO_ROOT_USER +echo $MINIO_ROOT_USER_OLD > keys/oldkey.txt +export MINIO_ROOT_PASSWORD_OLD=$MINIO_ROOT_PASSWORD +echo $MINIO_ROOT_PASSWORD_OLD > keys/oldsecret.txt +export MINIO_ROOT_USER=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1) +echo $MINIO_ROOT_USER > keys/key.txt +export MINIO_ROOT_PASSWORD=$(cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1) +echo $MINIO_ROOT_PASSWORD > keys/secret.txt +echo "Your New Access Key is: $(tput setaf 2)$MINIO_ROOT_USER" +echo "Your New Secret Key is: $(tput setaf 2)$MINIO_ROOT_PASSWORD" +echo "Your Old Access Key is: $(tput setaf 3)$MINIO_ROOT_USER_OLD" +echo "Your Old Access Key is: $(tput setaf 3)$MINIO_ROOT_PASSWORD_OLD" +echo "$(tput setaf 2)Booting..." +./minio server data --console-address ":$SERVER_PORT" +else +echo "$(tput setaf 2)Booting..." +./minio server data --console-address ":$SERVER_PORT" +fi diff --git a/ptero_eggs/application/monitoring/README.md b/ptero_eggs/application/monitoring/README.md new file mode 100644 index 0000000..f2827c4 --- /dev/null +++ b/ptero_eggs/application/monitoring/README.md @@ -0,0 +1,7 @@ +# Monitoring + +## Loki + + +## Prometheus + diff --git a/ptero_eggs/application/monitoring/loki/README.md b/ptero_eggs/application/monitoring/loki/README.md new file mode 100644 index 0000000..d99b1be --- /dev/null +++ b/ptero_eggs/application/monitoring/loki/README.md @@ -0,0 +1,25 @@ +# Loki + +## From the [Loki](https://github.com/grafana/loki) GitHub repository + +Loki is a horizontally-scalable, highly-available, multi-tenant log aggregation system inspired by Prometheus. It is designed to be very cost effective and easy to operate. + +## Working with Loki + +To get logs "into" Loki you need a scrape agent, such as official [Promtail](https://grafana.com/docs/loki/latest/clients/promtail/installation/) or a library for your app that can push logs through HTTP endpoint (gRPC endpoint is disabled in Docker enviroment by default) + +## Resource consumption + +As this egg sets up Loki in single node mode, it can consume a lot of disk space really fast. It is possible to setup different kind of storages for different parts of Loki files. For further information refer to official [Loki documentation](https://grafana.com/docs/loki/latest/operations/storage/). + +To get started, you can go with a minimum of 3GB RAM and >=2.5GB disk space. + +Keep in mind that those numbers can grow pretty quick! + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|-------------|---------| +| Loki server | 3100 | diff --git a/ptero_eggs/application/monitoring/loki/egg-loki.json b/ptero_eggs/application/monitoring/loki/egg-loki.json new file mode 100644 index 0000000..7a62768 --- /dev/null +++ b/ptero_eggs/application/monitoring/loki/egg-loki.json @@ -0,0 +1,42 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2024-12-11T19:05:03+00:00", + "name": "Loki", + "author": "unknown@unknown.com", + "description": "Prometheus but for logs. This egg is for Loki instance only! You usually need pushing agents like Promtail to put logs in this", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:debian": "ghcr.io\/ptero-eggs\/yolks:debian" + }, + "file_denylist": [], + "startup": ".\/loki-linux -config.file=loki-docker-config.yaml", + "config": { + "files": "{\r\n \"loki-docker-config.yaml\": {\r\n \"parser\": \"yaml\",\r\n \"find\": {\r\n \"server.http_listen_port\": \"{{server.build.default.port}}\",\r\n \"common.ring.instance_addr\": \"0.0.0.0\",\r\n \"common.path_prefix\": \"\/home\/container\/loki\",\r\n \"common.storage.filesystem.chunks_directory\": \"\/home\/container\/loki\/chunks\",\r\n \"common.storage.filesystem.rules_directory\": \"\/home\/container\/loki\/rules\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \"Loki started\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash\r\n# Switch to mounted working install directory\r\ncd \/mnt\/server\r\n\r\napt update\r\napt install -y zip unzip wget curl git file\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] && echo \"amd64\" || echo \"arm64\")\r\n# Download and extract Loki\r\n\r\nif [ \"$LOKI_VERSION\" = \"latest\" ]; then LOKI_VERSION=$(curl --silent \"https:\/\/api.github.com\/repos\/grafana\/loki\/releases\/latest\" | grep '\"tag_name\":' | sed -E 's\/.*\"([^\"]+)\".*\/\\1\/' | cut -c2-); fi\r\necho -e \"running curl -L https:\/\/github.com\/grafana\/loki\/releases\/download\/v${LOKI_VERSION}\/loki-linux-${ARCH}.zip --output loki-linux-amd64.zip\"\r\ncurl -L https:\/\/github.com\/grafana\/loki\/releases\/download\/v${LOKI_VERSION}\/loki-linux-${ARCH}.zip --output loki-linux-${ARCH}.zip\r\nunzip loki-linux-${ARCH}.zip\r\nrm -rf loki-linux-${ARCH}.zip\r\ncurl -L https:\/\/raw.githubusercontent.com\/grafana\/loki\/v${LOKI_VERSION}\/cmd\/loki\/loki-docker-config.yaml --output loki-docker-config.yaml\r\nmv loki-linux-* loki-linux\r\necho -e \"installation completed\"", + "container": "ghcr.io\/pterodactyl\/installers:debian", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Loki Version", + "description": "The version of Loki to use.\r\n\r\nFind all versions from https:\/\/github.com\/grafana\/loki", + "env_variable": "LOKI_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/monitoring/prometheus/README.md b/ptero_eggs/application/monitoring/prometheus/README.md new file mode 100644 index 0000000..b741ab7 --- /dev/null +++ b/ptero_eggs/application/monitoring/prometheus/README.md @@ -0,0 +1,19 @@ +# Prometheus + +## From the [Prometheus](https://github.com/prometheus/prometheus) GitHub repository + +The Prometheus monitoring system and time series database. + +## Resource consumption + +As Prometheus is a monitoring software that saves data in a timeseries database, it can take up massive amounts of disk space. Due to Prometheus design, a huge memory consumption is also possible. +To get started, a minimum of 3GB RAM and >=2.5GB disk space is recommended. +Keep in mind that those numbers can grow pretty quick for large monitored environments! + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|-------------------|---------| +| Prometheus server | 9090 | diff --git a/ptero_eggs/application/monitoring/prometheus/egg-prometheus.json b/ptero_eggs/application/monitoring/prometheus/egg-prometheus.json new file mode 100644 index 0000000..b3c2de5 --- /dev/null +++ b/ptero_eggs/application/monitoring/prometheus/egg-prometheus.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": "2025-08-22T13:55:16+00:00", + "name": "Prometheus", + "author": "p.zarrad@outlook.de", + "description": "The Prometheus monitoring system and time series database.", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:debian": "ghcr.io\/ptero-eggs\/yolks:debian" + }, + "file_denylist": [], + "startup": ".\/prometheus --web.listen-address=0.0.0.0:{{SERVER_PORT}} --config.file=\/home\/container\/prometheus.yml --storage.tsdb.path=\/home\/container\/data --web.console.templates=\/home\/container\/consoles --web.console.libraries=\/home\/container\/console_libraries --web.config.file=\/home\/container\/prometheus.web.yml --storage.tsdb.retention.time={{DATA_SAVE_TIME}}", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"Server is ready to receive web requests.\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/sh\r\nshopt -s extglob\r\n# Switch to mounted directory\r\ncd \/mnt\/server\r\n# Update installation system and install curl\r\napt-get update\r\napt-get install -y curl\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] && echo \"amd64\" || echo \"arm64\")\r\n# Cleanup previous install if available\r\nif [ -f \"prometheus.yml\" ]; then mv prometheus.yml prometheus.yml.bak; fi\r\nif [ -f \"prometheus.web.yml\" ]; then mv prometheus.web.yml prometheus.web.yml.bak; fi\r\nrm -rfv !(data|prometheus.yml.bak|prometheus.web.yml.bak)\r\n# Download and extract Prometheus\r\nversion=${PROMETHEUS_VERSION}\r\nif [ \"$version\" = \"latest\" ]; then version=$(curl --silent \"https:\/\/api.github.com\/repos\/prometheus\/prometheus\/releases\/latest\" | grep '\"tag_name\":' | sed -E 's\/.*\"([^\"]+)\".*\/\\1\/' | cut -c2-); fi\r\ncurl -L https:\/\/github.com\/prometheus\/prometheus\/releases\/download\/v${version}\/prometheus-${version}.linux-${ARCH}.tar.gz --output prometheus.tar.gz\r\ntar -zxvf prometheus.tar.gz\r\nmv -n prometheus-*\/* .\/\r\nrm -rf prometheus.tar.gz prometheus-*\/\r\n# Restore configuration if necessary\r\nif [ -f \"prometheus.yml.bak\" ]; then rm -rf prometheus.yml && mv prometheus.yml.bak prometheus.yml && rm -rf prometheus.yml.bak; fi\r\nif [ -f \"prometheus.web.yml.bak\" ]; then rm -rf prometheus.web.yml && mv prometheus.web.yml.bak prometheus.web.yml && rm -rf prometheus.web.yml.bak; fi\r\n# Create dummy prometheus.web.yml as a placeholder\r\nif [ ! -f \"prometheus.web.yml\" ]; then touch prometheus.web.yml; fi", + "container": "ghcr.io\/ptero-eggs\/installers:debian", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Prometheus Version", + "description": "The version of Prometheus to install. By default the latest version is being installed.", + "env_variable": "PROMETHEUS_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Data Save time in Days", + "description": "How long the data is being saved", + "env_variable": "DATA_SAVE_TIME", + "default_value": "15d", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:10", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/nats/README.md b/ptero_eggs/application/nats/README.md new file mode 100644 index 0000000..ee75e09 --- /dev/null +++ b/ptero_eggs/application/nats/README.md @@ -0,0 +1,18 @@ +# NATS + +## From the [NATS](https://nats.io/) website + +NATS is a connective technology built for the ever increasingly hyper-connected world. It is a single technology that enables applications to securely communicate across any combination of cloud vendors, on-premise, edge, web and mobile, and devices. NATS consists of a family of open source products that are tightly integrated but can be deployed easily and independently. NATS is being used globally by thousands of companies, spanning use-cases including microservices, edge computing, mobile, IoT and can be used to augment or replace traditional messaging. + +## Configuration + +Set the username/password or auth token configuration under the start variables + + +### Server Ports + +Ports required to run the server in a table format. + +| Port | default | +| --------------- | ------- | +| Client Port | 4222 | diff --git a/ptero_eggs/application/nats/egg-n-a-t-s.json b/ptero_eggs/application/nats/egg-n-a-t-s.json new file mode 100644 index 0000000..134a469 --- /dev/null +++ b/ptero_eggs/application/nats/egg-n-a-t-s.json @@ -0,0 +1,82 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2025-10-06T11:40:39+00:00", + "name": "NATS", + "author": "eggs@purpleflaghosting.com", + "description": "NATS is a connective technology built for the ever increasingly hyper-connected world. It is a single technology that enables applications to securely communicate across any combination of cloud vendors, on-premise, edge, web and mobile, and devices. NATS consists of a family of open source products that are tightly integrated but can be deployed easily and independently. NATS is being used globally by thousands of companies, spanning use-cases including microservices, edge computing, mobile, IoT and can be used to augment or replace traditional messaging.", + "features": [], + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:alpine": "ghcr.io\/ptero-eggs\/yolks:alpine" + }, + "file_denylist": [], + "startup": ".\/nats-server --port {{SERVER_PORT}} --store_dir $HOME\/data ${JETSTREAM:+-js} ${USERNAME:+--user \"{{USERNAME}}\"} ${PASSWORD:+--pass \"{{PASSWORD}}\"} ${AUTH_TOKEN:+--auth \"{{AUTH_TOKEN}}\"}", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"Server is ready\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash\r\n\r\n# Detect OS architecture to download the correct binary\r\nOS_ARCH=$(uname -m)\r\ncase \"$OS_ARCH\" in\r\n x86_64)\r\n OS_ARCH=\"amd64\"\r\n ;;\r\n aarch64 | arm64)\r\n OS_ARCH=\"arm64\"\r\n ;;\r\n *)\r\n echo \"Unsupported architecture: $OS_ARCH\"\r\n exit 1\r\n ;;\r\nesac\r\necho \"Detected architecture: $OS_ARCH\"\r\n\r\n# Find the version and download URL from GitHub releases\r\nif [ -z \"$VERSION\" ] || [ \"$VERSION\" = \"latest\" ]; then\r\n echo \"Downloading latest version...\"\r\n RELEASE_INFO=$(curl -s https:\/\/api.github.com\/repos\/nats-io\/nats-server\/releases\/latest)\r\n TAG_NAME=$(echo \"$RELEASE_INFO\" | jq -r .tag_name)\r\n DOWNLOAD_URL=$(echo \"$RELEASE_INFO\" | jq -r \".assets[] | select(.name | test(\\\"nats-server-.*-linux-$OS_ARCH.*.tar.gz\\\")) | .browser_download_url\")\r\n echo \"Latest version is $TAG_NAME\"\r\n echo \"Download URL: $DOWNLOAD_URL\"\r\nelse\r\n # Ensure VERSION starts with 'v'\r\n VERSION=$(echo \"$VERSION\" | sed -E 's\/^v*\/\/')\r\n VERSION=\"v$VERSION\"\r\n\r\n echo \"Downloading version $VERSION...\"\r\n RELEASE_INFO=$(curl -s https:\/\/api.github.com\/repos\/nats-io\/nats-server\/releases\/tags\/$VERSION)\r\n if [ \"$(echo \"$RELEASE_INFO\" | jq -r .message)\" = \"Not Found\" ]; then\r\n echo \"Version $VERSION not found.\"\r\n exit 1\r\n fi\r\n TAG_NAME=$(echo \"$RELEASE_INFO\" | jq -r .tag_name)\r\n DOWNLOAD_URL=$(echo \"$RELEASE_INFO\" | jq -r \".assets[] | select(.name | test(\\\"nats-server-.*-linux-$OS_ARCH.*.tar.gz\\\")) | .browser_download_url\")\r\n echo \"Version is $TAG_NAME\"\r\n\r\nfi\r\n\r\nif [ -z \"$DOWNLOAD_URL\" ]; then\r\n echo \"No suitable download URL found for version $VERSION and architecture $OS_ARCH.\"\r\n exit 1\r\nfi\r\necho \"Download URL: $DOWNLOAD_URL\"\r\n\r\n# Download release\r\nwget \"$DOWNLOAD_URL\" -O \/tmp\/nats-server.tar.gz\r\n\r\n# Extract files\r\ntar -xzf \/tmp\/nats-server.tar.gz --strip-components=1 -C \/tmp\r\n\r\n# Copy nats-server binary and set permissions\r\ncp -f \/tmp\/nats-server \/mnt\/server\r\nchmod +x \/mnt\/server\/nats-server", + "container": "ghcr.io\/ptero-eggs\/installers:debian", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Username", + "description": "User required for connections.", + "env_variable": "USERNAME", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:20", + "field_type": "text" + }, + { + "name": "Password", + "description": "Password required for connections.", + "env_variable": "PASSWORD", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:20", + "field_type": "text" + }, + { + "name": "Auth Token", + "description": "Authorization token required for connections. If set, Username\/Password based authentication will be disabled.", + "env_variable": "AUTH_TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:255", + "field_type": "text" + }, + { + "name": "Enable JetStream", + "description": "Enable JetStream functionality.", + "env_variable": "JETSTREAM", + "default_value": "1", + "user_viewable": true, + "user_editable": true, + "rules": "required|boolean|in:0,1", + "field_type": "text" + }, + { + "name": "VERSION", + "description": "Version to install", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/owncast/README.md b/ptero_eggs/application/owncast/README.md new file mode 100644 index 0000000..a126216 --- /dev/null +++ b/ptero_eggs/application/owncast/README.md @@ -0,0 +1,51 @@ +# Owncast + +## From the [Owncast](https://owncast.online) website + +Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software. + +## Installation + +Follow the common egg installation guide to install the egg on your Pterodactyl instance. +When setting up a server, the version set in the varaible will be used, default is 0.0.11. + +## Configuration + +Configuring Owncast in Pterodactyl can be done by using the command line switches: +* -backupdir string + * Directory where backups will be written to +* -database string + * Path to the database file. +* -enableDebugFeatures + * Enable additional debugging options. +* -enableVerboseLogging + * Enable additional logging. +* -logdir string + * Directory where logs will be written to +* -restoreDatabase string + * Restore an Owncast database backup +* -rtmpport int + * Set listen port for the RTMP server +* -streamkey string + * Set your stream key/admin password +* -webserverip string + * Force web server to listen on this IP address +* -webserverport string + * Force the web server to listen on a specific port + + + +## Update support + +The egg _should_ keep the `data` folder when reinstalling, to prevent destroying the configuration by accident. + +If you want to reset the server completly, remove the `data` directory manually before reinstalling. + +### Server Ports + +Ports required to run the server in a table format. + +| Port | default | +| --------------- | ------- | +| Webserver | 8090 | +| RTMP | 8091 | diff --git a/ptero_eggs/application/owncast/egg-owncast-online.json b/ptero_eggs/application/owncast/egg-owncast-online.json new file mode 100644 index 0000000..57ff897 --- /dev/null +++ b/ptero_eggs/application/owncast/egg-owncast-online.json @@ -0,0 +1,102 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:52+00:00", + "name": "owncast.online", + "author": "psychoalex@thevcbc.com", + "description": "Owncast is a self-hosted live video and web chat server for use with existing popular broadcasting software.", + "features": null, + "docker_images": { + "ghcr.io/pterodactyl/yolks:debian": "ghcr.io/pterodactyl/yolks:debian" + }, + "file_denylist": [], + "startup": "./owncast -webserverport {{SERVER_PORT}} -rtmpport {{RTMP_PORT}} -streamkey {{STREAM_KEY}}", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"The web admin interface is available at /admin.\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n\r\n#Make Server Dir\r\nif [ ! -d /mnt/server/ ]; then\r\n mkdir /mnt/server/\r\nfi\r\ncd /mnt/server/\r\n\r\n#Get Dependencies\r\napt-get -y update\r\napt-get -y install curl unzip tar jq\r\n\r\n#Get Owncast Install Files\r\n\r\nif [ -z \"${GITHUB_USER}\" ] \u0026\u0026 [ -z \"${GITHUB_OAUTH_TOKEN}\" ] ; then\r\n echo -e \"using anon api call\"\r\nelse\r\n echo -e \"user and oauth token set\"\r\n alias curl='curl -u ${GITHUB_USER}:${GITHUB_OAUTH_TOKEN} '\r\nfi\r\n\r\n## get release info and download links\r\nLATEST_JSON=$(curl --silent \"https://api.github.com/repos/${GITHUB_PACKAGE}/releases/latest\")\r\nRELEASES=$(curl --silent \"https://api.github.com/repos/${GITHUB_PACKAGE}/releases\")\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i ${MATCH})\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i ${MATCH})\r\n else\r\n echo -e \"defaulting to latest release\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url)\r\n fi\r\nfi\r\n\r\necho Download URL is: ${DOWNLOAD_URL}\r\n\r\ncurl -L ${DOWNLOAD_URL} --output ./owncast_installer.zip\r\n\r\n#curl -L https://github.com/owncast/owncast/releases/download/v${OWNCAST_VERSION}/owncast-${OWNCAST_VERSION}-linux-64bit.zip --output ./owncast_installer.zip\r\n\r\n#Unzip Install Files\r\nunzip -o -q ./owncast_installer.zip\r\nrm ./owncast_installer.zip\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [ + { + "name": "RTMP Port", + "description": "The port that is used to receive the stream data.", + "env_variable": "RTMP_PORT", + "default_value": "8091", + "user_viewable": true, + "user_editable": false, + "rules": "required|integer", + "field_type": "text" + }, + { + "name": "Stream/Admin Key", + "description": "This is used to authenticate to the web admin interface, as well as to authenticate your stream.", + "env_variable": "STREAM_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|min:32|max:128", + "field_type": "text" + }, + { + "name": "Owncast Version", + "description": "The version of Owncast that you would like to install, from https://github.com/owncast/owncast/releases\r\nAs an Example - \"v0.0.11\" for a specific version or \"latest\" for the most up to date version.", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Github Repository", + "description": "Used to identify the github repository to pull the release from.", + "env_variable": "GITHUB_PACKAGE", + "default_value": "owncast/owncast", + "user_viewable": false, + "user_editable": false, + "rules": "required|string|max:120", + "field_type": "text" + }, + { + "name": "Github File Match", + "description": "Used to identify the specific asset under a release for download.", + "env_variable": "MATCH", + "default_value": "linux-64bit", + "user_viewable": false, + "user_editable": false, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Github User", + "description": "Required if you are doing more calls than the github anonymous API user allows.", + "env_variable": "GITHUB_USER", + "default_value": "", + "user_viewable": false, + "user_editable": false, + "rules": "nullable|string|max:20", + "field_type": "text" + }, + { + "name": "Github Oauth Token", + "description": "Required if you are doing more calls than the github anonymous API user allows.", + "env_variable": "GITHUB_OAUTH_TOKEN", + "default_value": "", + "user_viewable": false, + "user_editable": false, + "rules": "nullable|string|max:128", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/rabbitmq/README.md b/ptero_eggs/application/rabbitmq/README.md new file mode 100644 index 0000000..4e9d522 --- /dev/null +++ b/ptero_eggs/application/rabbitmq/README.md @@ -0,0 +1,46 @@ +# RabbitMQ + +## From the [RabbitMQ](https://www.rabbitmq.com/) website + +RabbitMQ is the most widely deployed open source message broker. + +## Installation + +Follow the common egg installation guide to install the egg on your Pterodactyl instance. +When setting up a server, the latest RabbitMQ version will be used by default. + +With pretty new and old versions of RabbitMQ, you might have to adjust the used Erlang version. +This can be archived by adjusting the version number of the used image (e. g. `ghcr.io/pterodactyl/yolks:erlang_22` instead of `ghcr.io/ptero-eggs/yolks:erlang_24`). + +The latest version as of now requires you to use atleast ghcr.io/pterodactyl/yolks:erlang_25 + +## Configuration + +Configuring RabbitMQ in Pterodactyl is only possible using the config files. +This means: + +- Configure the server itself as normal using `/home/container/etc/rabbitmq/rabbitmq.conf` +- Enable plugins using the plugin file located at `/home/container/etc/rabbitmq/enabled_plugins` +- Configure users and vhosts through a [definitions.json](https://www.rabbitmq.com/definitions.html) + +You can set the path to the used `definitions.json` using the `load_definitions` option in your config. +Note that RabbitMQ versions prior to 3.8.6 will require a properly configured management plugin to do so! +The easiest way to get a working `definitions.json` is to setup a local instance with the management plugin. You can configure your instance there and load the definitions as stated by uploading them. + +By default, only `listeners.tcp.default` is configured to match your primary allocation. +If you want to expose some other port (e. g. the web management interface) you have to manually configure the +port in your `rabbitmq.conf`. + +## Update support + +The egg _should_ keep the `etc` folder when reinstalling, to prevent destroying the configuration by accident. Therefore a reinstallation with "latest" as the selected version can be used to update RabbitMQ. + +If you want to reset the server completly, remove the `etc` directory manually before reinstalling. + +### Server Ports + +Ports required to run the server in a table format. + +| Port | default | +| --------------- | ------- | +| RabbitMQ Broker | 5672 | diff --git a/ptero_eggs/application/rabbitmq/egg-rabbit-m-q.json b/ptero_eggs/application/rabbitmq/egg-rabbit-m-q.json new file mode 100644 index 0000000..c244a5b --- /dev/null +++ b/ptero_eggs/application/rabbitmq/egg-rabbit-m-q.json @@ -0,0 +1,46 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2025-10-03T19:05:05+02:00", + "name": "RabbitMQ", + "author": "p.zarrad@outlook.de", + "description": "RabbitMQ is a feature rich, multi-protocol messaging broker.", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:erlang_22": "ghcr.io\/ptero-eggs\/yolks:erlang_22", + "ghcr.io\/ptero-eggs\/yolks:erlang_23": "ghcr.io\/ptero-eggs\/yolks:erlang_23", + "ghcr.io\/ptero-eggs\/yolks:erlang_24": "ghcr.io\/ptero-eggs\/yolks:erlang_24", + "ghcr.io\/ptero-eggs\/yolks:erlang_25": "ghcr.io\/ptero-eggs\/yolks:erlang_25", + "ghcr.io\/ptero-eggs\/yolks:erlang_26": "ghcr.io\/ptero-eggs\/yolks:erlang_26" + }, + "file_denylist": [], + "startup": ".\/sbin\/rabbitmq-server", + "config": { + "files": "{\r\n \"etc\/rabbitmq\/rabbitmq.conf\": {\r\n \"parser\": \"file\",\r\n \"find\": {\r\n \"listeners.tcp.default\": \"listeners.tcp.default = 0.0.0.0:{{server.build.default.port}}\"\r\n }\r\n }\r\n}", + "startup": "{\r\n \"done\": \" completed with\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/sh\r\n# Switch to mounted directory\r\ncd \/mnt\/server\r\n# Update and install xz\r\napk update\r\napk add xz\r\n# Cleanup previous install if available but leave etc untouched\r\nfind . -maxdepth 1 ! -name \"etc\" ! -name . -exec rm -rf {} \\;\r\n# Download and extract RabbitMQ\r\nversion=${RABBITMQ_VERSION}\r\nif [ \"$version\" = \"latest\" ]; then version=$(curl --silent \"https:\/\/api.github.com\/repos\/rabbitmq\/rabbitmq-server\/releases\/latest\" | grep '\"tag_name\":' | sed -E 's\/.*\"([^\"]+)\".*\/\\1\/' | cut -c2-); fi\r\ncurl -L https:\/\/github.com\/rabbitmq\/rabbitmq-server\/releases\/download\/v${version}\/rabbitmq-server-generic-unix-${version}.tar.xz --output rabbitmq.tar.xz\r\nxz -v -d rabbitmq.tar.xz && tar -xvf rabbitmq.tar\r\nmv -n rabbitmq_server-*\/* .\/\r\nrm -rf rabbitmq.tar rabbitmq_server-*\/\r\n# If there is no config, download default one\r\nif [ ! -f \"etc\/rabbitmq\/rabbitmq.conf\" ]; then mkdir -p etc\/rabbitmq\/ && curl -L https:\/\/raw.githubusercontent.com\/Ptero-Eggs\/application-eggs\/main\/rabbitmq\/rabbitmq.conf --output etc\/rabbitmq\/rabbitmq.conf; fi", + "container": "ghcr.io\/ptero-eggs\/installers:alpine", + "entrypoint": "ash" + } + }, + "variables": [ + { + "name": "RabbitMQ Version", + "description": "The version of RabbitMQ to install. By default the latest version is being installed.", + "env_variable": "RABBITMQ_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/rabbitmq/rabbitmq.conf b/ptero_eggs/application/rabbitmq/rabbitmq.conf new file mode 100644 index 0000000..f889545 --- /dev/null +++ b/ptero_eggs/application/rabbitmq/rabbitmq.conf @@ -0,0 +1,1060 @@ +# ====================================== +# RabbitMQ broker section +# ====================================== + +## Related doc guide: https://rabbitmq.com/configure.html. See +## https://rabbitmq.com/documentation.html for documentation ToC. + +## Networking +## ==================== +## +## Related doc guide: https://rabbitmq.com/networking.html. +## +## By default, RabbitMQ will listen on all interfaces, using +## the standard (reserved) AMQP 0-9-1 and 1.0 port. +## +listeners.tcp.default = 5672 + + +## To listen on a specific interface, provide an IP address with port. +## For example, to listen only on localhost for both IPv4 and IPv6: +## +# IPv4 +# listeners.tcp.local = 0.0.0.0:5672 +# IPv6 +# listeners.tcp.local_v6 = ::1:5672 + +## You can define multiple listeners using listener names +# listeners.tcp.other_port = 5673 +# listeners.tcp.other_ip = 10.10.10.10:5672 + + +## TLS listeners are configured in the same fashion as TCP listeners, +## including the option to control the choice of interface. +## +# listeners.ssl.default = 5671 + +## It is possible to disable regular TCP (non-TLS) listeners. Clients +## not configured to use TLS and the correct TLS-enabled port won't be able +## to connect to this node. +# listeners.tcp = none + +## Number of Erlang processes that will accept connections for the TCP +## and TLS listeners. +## +# num_acceptors.tcp = 10 +# num_acceptors.ssl = 10 + +## Socket writer will force GC every so many bytes transferred. +## Default is 1 GiB (`1000000000`). Set to 'off' to disable. +## +# socket_writer.gc_threshold = 1000000000 +# +## To disable: +# socket_writer.gc_threshold = off + +## Maximum amount of time allowed for the AMQP 0-9-1 and AMQP 1.0 handshake +## (performed after socket connection and TLS handshake) to complete, in milliseconds. +## +# handshake_timeout = 10000 + +## Set to 'true' to perform reverse DNS lookups when accepting a +## connection. rabbitmqctl and management UI will then display hostnames +## instead of IP addresses. Default value is `false`. +## +# reverse_dns_lookups = false + +## +## Security, Access Control +## ============== +## + +## Related doc guide: https://rabbitmq.com/access-control.html. + +## The default "guest" user is only permitted to access the server +## via a loopback interface (e.g. localhost). +## {loopback_users, [<<"guest">>]}, +## +# loopback_users.guest = true + +## Uncomment the following line if you want to allow access to the +## guest user from anywhere on the network. +# loopback_users.guest = false + +## TLS configuration. +## +## Related doc guide: https://rabbitmq.com/ssl.html. +## +# listeners.ssl.1 = 5671 +# +# ssl_options.verify = verify_peer +# ssl_options.fail_if_no_peer_cert = false +# ssl_options.cacertfile = /path/to/cacert.pem +# ssl_options.certfile = /path/to/cert.pem +# ssl_options.keyfile = /path/to/key.pem +# +# ssl_options.honor_cipher_order = true +# ssl_options.honor_ecc_order = true +# +## These are highly recommended for TLSv1.2 but cannot be used +## with TLSv1.3. If TLSv1.3 is enabled, these lines MUST be removed. +# ssl_options.client_renegotiation = false +# ssl_options.secure_renegotiate = true +# +## Limits what TLS versions the server enables for client TLS +## connections. See https://www.rabbitmq.com/ssl.html#tls-versions for details. +## +## Cutting edge TLS version which requires recent client runtime +## versions and has no cipher suite in common with earlier TLS versions. +# ssl_options.versions.1 = tlsv1.3 +## Enables TLSv1.2 for best compatibility +# ssl_options.versions.2 = tlsv1.2 +## Older TLS versions have known vulnerabilities and are being phased out +## from wide use. + +## Limits what cipher suites the server will use for client TLS +## connections. Narrowing this down can prevent some clients +## from connecting. +## If TLSv1.3 is enabled and cipher suites are overridden, TLSv1.3-specific +## cipher suites must also be explicitly enabled. +## See https://www.rabbitmq.com/ssl.html#cipher-suites and https://wiki.openssl.org/index.php/TLS1.3#Ciphersuites +## for details. +# +## The example below uses TLSv1.3 cipher suites only +# +# ssl_options.ciphers.1 = TLS_AES_256_GCM_SHA384 +# ssl_options.ciphers.2 = TLS_AES_128_GCM_SHA256 +# ssl_options.ciphers.3 = TLS_CHACHA20_POLY1305_SHA256 +# ssl_options.ciphers.4 = TLS_AES_128_CCM_SHA256 +# ssl_options.ciphers.5 = TLS_AES_128_CCM_8_SHA256 +# +## The example below uses TLSv1.2 cipher suites only +# +# ssl_options.ciphers.1 = ECDHE-ECDSA-AES256-GCM-SHA384 +# ssl_options.ciphers.2 = ECDHE-RSA-AES256-GCM-SHA384 +# ssl_options.ciphers.3 = ECDHE-ECDSA-AES256-SHA384 +# ssl_options.ciphers.4 = ECDHE-RSA-AES256-SHA384 +# ssl_options.ciphers.5 = ECDH-ECDSA-AES256-GCM-SHA384 +# ssl_options.ciphers.6 = ECDH-RSA-AES256-GCM-SHA384 +# ssl_options.ciphers.7 = ECDH-ECDSA-AES256-SHA384 +# ssl_options.ciphers.8 = ECDH-RSA-AES256-SHA384 +# ssl_options.ciphers.9 = DHE-RSA-AES256-GCM-SHA384 +# ssl_options.ciphers.10 = DHE-DSS-AES256-GCM-SHA384 +# ssl_options.ciphers.11 = DHE-RSA-AES256-SHA256 +# ssl_options.ciphers.12 = DHE-DSS-AES256-SHA256 +# ssl_options.ciphers.13 = ECDHE-ECDSA-AES128-GCM-SHA256 +# ssl_options.ciphers.14 = ECDHE-RSA-AES128-GCM-SHA256 +# ssl_options.ciphers.15 = ECDHE-ECDSA-AES128-SHA256 +# ssl_options.ciphers.16 = ECDHE-RSA-AES128-SHA256 +# ssl_options.ciphers.17 = ECDH-ECDSA-AES128-GCM-SHA256 +# ssl_options.ciphers.18 = ECDH-RSA-AES128-GCM-SHA256 +# ssl_options.ciphers.19 = ECDH-ECDSA-AES128-SHA256 +# ssl_options.ciphers.20 = ECDH-RSA-AES128-SHA256 +# ssl_options.ciphers.21 = DHE-RSA-AES128-GCM-SHA256 +# ssl_options.ciphers.22 = DHE-DSS-AES128-GCM-SHA256 +# ssl_options.ciphers.23 = DHE-RSA-AES128-SHA256 +# ssl_options.ciphers.24 = DHE-DSS-AES128-SHA256 +# ssl_options.ciphers.25 = ECDHE-ECDSA-AES256-SHA +# ssl_options.ciphers.26 = ECDHE-RSA-AES256-SHA +# ssl_options.ciphers.27 = DHE-RSA-AES256-SHA +# ssl_options.ciphers.28 = DHE-DSS-AES256-SHA +# ssl_options.ciphers.29 = ECDH-ECDSA-AES256-SHA +# ssl_options.ciphers.30 = ECDH-RSA-AES256-SHA +# ssl_options.ciphers.31 = ECDHE-ECDSA-AES128-SHA +# ssl_options.ciphers.32 = ECDHE-RSA-AES128-SHA +# ssl_options.ciphers.33 = DHE-RSA-AES128-SHA +# ssl_options.ciphers.34 = DHE-DSS-AES128-SHA +# ssl_options.ciphers.35 = ECDH-ECDSA-AES128-SHA +# ssl_options.ciphers.36 = ECDH-RSA-AES128-SHA + +# ssl_options.bypass_pem_cache = true + +## Select an authentication/authorisation backend to use. +## +## Alternative backends are provided by plugins, such as rabbitmq-auth-backend-ldap. +## +## NB: These settings require certain plugins to be enabled. +## +## Related doc guides: +## +## * https://rabbitmq.com/plugins.html +## * https://rabbitmq.com/access-control.html +## + +# auth_backends.1 = rabbit_auth_backend_internal + +## uses separate backends for authentication and authorisation, +## see below. +# auth_backends.1.authn = rabbit_auth_backend_ldap +# auth_backends.1.authz = rabbit_auth_backend_internal + +## The rabbitmq_auth_backend_ldap plugin allows the broker to +## perform authentication and authorisation by deferring to an +## external LDAP server. +## +## Relevant doc guides: +## +## * https://rabbitmq.com/ldap.html +## * https://rabbitmq.com/access-control.html +## +## uses LDAP for both authentication and authorisation +# auth_backends.1 = rabbit_auth_backend_ldap + +## uses HTTP service for both authentication and +## authorisation +# auth_backends.1 = rabbit_auth_backend_http + +## uses two backends in a chain: HTTP first, then internal +# auth_backends.1 = rabbit_auth_backend_http +# auth_backends.2 = rabbit_auth_backend_internal + +## Authentication +## The built-in mechanisms are 'PLAIN', +## 'AMQPLAIN', and 'EXTERNAL' Additional mechanisms can be added via +## plugins. +## +## Related doc guide: https://rabbitmq.com/authentication.html. +## +# auth_mechanisms.1 = PLAIN +# auth_mechanisms.2 = AMQPLAIN + +## The rabbitmq-auth-mechanism-ssl plugin makes it possible to +## authenticate a user based on the client's x509 (TLS) certificate. +## Related doc guide: https://rabbitmq.com/authentication.html. +## +## To use auth-mechanism-ssl, the EXTERNAL mechanism should +## be enabled: +## +# auth_mechanisms.1 = PLAIN +# auth_mechanisms.2 = AMQPLAIN +# auth_mechanisms.3 = EXTERNAL + +## To force x509 certificate-based authentication on all clients, +## exclude all other mechanisms (note: this will disable password-based +## authentication even for the management UI!): +## +# auth_mechanisms.1 = EXTERNAL + +## This pertains to both the rabbitmq-auth-mechanism-ssl plugin and +## STOMP ssl_cert_login configurations. See the RabbitMQ STOMP plugin +## configuration section later in this file and the README in +## https://github.com/rabbitmq/rabbitmq-auth-mechanism-ssl for further +## details. +## +## To use the TLS cert's CN instead of its DN as the username +## +# ssl_cert_login_from = common_name + +## TLS handshake timeout, in milliseconds. +## +# ssl_handshake_timeout = 5000 + + +## Cluster name +## +# cluster_name = dev3.eng.megacorp.local + +## Password hashing implementation. Will only affect newly +## created users. To recalculate hash for an existing user +## it's necessary to update her password. +## +## To use SHA-512, set to rabbit_password_hashing_sha512. +## +# password_hashing_module = rabbit_password_hashing_sha256 + +## When importing definitions exported from versions earlier +## than 3.6.0, it is possible to go back to MD5 (only do this +## as a temporary measure!) by setting this to rabbit_password_hashing_md5. +## +# password_hashing_module = rabbit_password_hashing_md5 + +## +## Default User / VHost +## ==================== +## + +## On first start RabbitMQ will create a vhost and a user. These +## config items control what gets created. +## Relevant doc guide: https://rabbitmq.com/access-control.html +## +# default_vhost = / +# default_user = guest +# default_pass = guest + +# default_permissions.configure = .* +# default_permissions.read = .* +# default_permissions.write = .* + +## Tags for default user +## +## For more details about tags, see the documentation for the +## Management Plugin at https://rabbitmq.com/management.html. +## +# default_user_tags.administrator = true + +## Define other tags like this: +# default_user_tags.management = true +# default_user_tags.custom_tag = true + +## +## Additional network and protocol related configuration +## ===================================================== +## + +## Set the server AMQP 0-9-1 heartbeat timeout in seconds. +## RabbitMQ nodes will send heartbeat frames at roughly +## the (timeout / 2) interval. Two missed heartbeats from +## a client will close its connection. +## +## Values lower than 6 seconds are very likely to produce +## false positives and are not recommended. +## +## Related doc guides: +## +## * https://rabbitmq.com/heartbeats.html +## * https://rabbitmq.com/networking.html +## +# heartbeat = 60 + +## Set the max permissible size of an AMQP frame (in bytes). +## +# frame_max = 131072 + +## Set the max frame size the server will accept before connection +## tuning occurs +## +# initial_frame_max = 4096 + +## Set the max permissible number of channels per connection. +## 0 means "no limit". +## +# channel_max = 128 + +## Customising TCP Listener (Socket) Configuration. +## +## Related doc guides: +## +## * https://rabbitmq.com/networking.html +## * https://www.erlang.org/doc/man/inet.html#setopts-2 +## + +# tcp_listen_options.backlog = 128 +# tcp_listen_options.nodelay = true +# tcp_listen_options.exit_on_close = false +# +# tcp_listen_options.keepalive = true +# tcp_listen_options.send_timeout = 15000 +# +# tcp_listen_options.buffer = 196608 +# tcp_listen_options.sndbuf = 196608 +# tcp_listen_options.recbuf = 196608 + +## +## Resource Limits & Flow Control +## ============================== +## +## Related doc guide: https://rabbitmq.com/memory.html. + +## Memory-based Flow Control threshold. +## +# vm_memory_high_watermark.relative = 0.4 + +## Alternatively, we can set a limit (in bytes) of RAM used by the node. +## +# vm_memory_high_watermark.absolute = 1073741824 + +## Or you can set absolute value using memory units (with RabbitMQ 3.6.0+). +## Absolute watermark will be ignored if relative is defined! +## +# vm_memory_high_watermark.absolute = 2GB +## +## Supported unit symbols: +## +## k, kiB: kibibytes (2^10 - 1,024 bytes) +## M, MiB: mebibytes (2^20 - 1,048,576 bytes) +## G, GiB: gibibytes (2^30 - 1,073,741,824 bytes) +## kB: kilobytes (10^3 - 1,000 bytes) +## MB: megabytes (10^6 - 1,000,000 bytes) +## GB: gigabytes (10^9 - 1,000,000,000 bytes) + + + +## Fraction of the high watermark limit at which queues start to +## page message out to disc in order to free up memory. +## For example, when vm_memory_high_watermark is set to 0.4 and this value is set to 0.5, +## paging can begin as early as when 20% of total available RAM is used by the node. +## +## Values greater than 1.0 can be dangerous and should be used carefully. +## +## One alternative to this is to use durable queues and publish messages +## as persistent (delivery mode = 2). With this combination queues will +## move messages to disk much more rapidly. +## +## Another alternative is to configure queues to page all messages (both +## persistent and transient) to disk as quickly +## as possible, see https://rabbitmq.com/lazy-queues.html. +## +# vm_memory_high_watermark_paging_ratio = 0.5 + +## Selects Erlang VM memory consumption calculation strategy. Can be `allocated`, `rss` or `legacy` (aliased as `erlang`), +## Introduced in 3.6.11. `rss` is the default as of 3.6.12. +## See https://github.com/rabbitmq/rabbitmq-server/issues/1223 and rabbitmq/rabbitmq-common#224 for background. +# vm_memory_calculation_strategy = rss + +## Interval (in milliseconds) at which we perform the check of the memory +## levels against the watermarks. +## +# memory_monitor_interval = 2500 + +## The total memory available can be calculated from the OS resources +## - default option - or provided as a configuration parameter. +# total_memory_available_override_value = 2GB + +## Set disk free limit (in bytes). Once free disk space reaches this +## lower bound, a disk alarm will be set - see the documentation +## listed above for more details. +## +## Absolute watermark will be ignored if relative is defined! +# disk_free_limit.absolute = 50000 + +## Or you can set it using memory units (same as in vm_memory_high_watermark) +## with RabbitMQ 3.6.0+. +# disk_free_limit.absolute = 500KB +# disk_free_limit.absolute = 50mb +# disk_free_limit.absolute = 5GB + +## Alternatively, we can set a limit relative to total available RAM. +## +## Values lower than 1.0 can be dangerous and should be used carefully. +# disk_free_limit.relative = 2.0 + +## +## Clustering +## ===================== +## +# cluster_partition_handling = ignore + +## Pauses all nodes on the minority side of a partition. The cluster +## MUST have an odd number of nodes (3, 5, etc) +# cluster_partition_handling = pause_minority + +## pause_if_all_down strategy require additional configuration +# cluster_partition_handling = pause_if_all_down + +## Recover strategy. Can be either 'autoheal' or 'ignore' +# cluster_partition_handling.pause_if_all_down.recover = ignore + +## Node names to check +# cluster_partition_handling.pause_if_all_down.nodes.1 = rabbit@localhost +# cluster_partition_handling.pause_if_all_down.nodes.2 = hare@localhost + +## Mirror sync batch size, in messages. Increasing this will speed +## up syncing but total batch size in bytes must not exceed 2 GiB. +## Available in RabbitMQ 3.6.0 or later. +## +# mirroring_sync_batch_size = 4096 + +## Make clustering happen *automatically* at startup. Only applied +## to nodes that have just been reset or started for the first time. +## +## Relevant doc guide: https://rabbitmq.com//cluster-formation.html +## + +# cluster_formation.peer_discovery_backend = rabbit_peer_discovery_classic_config +# +# cluster_formation.classic_config.nodes.1 = rabbit1@hostname +# cluster_formation.classic_config.nodes.2 = rabbit2@hostname +# cluster_formation.classic_config.nodes.3 = rabbit3@hostname +# cluster_formation.classic_config.nodes.4 = rabbit4@hostname + +## DNS-based peer discovery. This backend will list A records +## of the configured hostname and perform reverse lookups for +## the addresses returned. + +# cluster_formation.peer_discovery_backend = rabbit_peer_discovery_dns +# cluster_formation.dns.hostname = discovery.eng.example.local + +## This node's type can be configured. If you are not sure +## what node type to use, always use 'disc'. +# cluster_formation.node_type = disc + +## Interval (in milliseconds) at which we send keepalive messages +## to other cluster members. Note that this is not the same thing +## as net_ticktime; missed keepalive messages will not cause nodes +## to be considered down. +## +# cluster_keepalive_interval = 10000 + +## +## Statistics Collection +## ===================== +## + +## Statistics collection interval (in milliseconds). Increasing +## this will reduce the load on management database. +## +# collect_statistics_interval = 5000 + +## Fine vs. coarse statistics +# +# This value is no longer meant to be configured directly. +# +# See https://www.rabbitmq.com/management.html#fine-stats. + +## +## Ra Settings +## ===================== +## +# raft.segment_max_entries = 65536 +# raft.wal_max_size_bytes = 1048576 +# raft.wal_max_batch_size = 4096 +# raft.snapshot_chunk_size = 1000000 + +## +## Misc/Advanced Options +## ===================== +## +## NB: Change these only if you understand what you are doing! +## + +## Timeout used when waiting for Mnesia tables in a cluster to +## become available. +## +# mnesia_table_loading_retry_timeout = 30000 + +## Retries when waiting for Mnesia tables in the cluster startup. Note that +## this setting is not applied to Mnesia upgrades or node deletions. +## +# mnesia_table_loading_retry_limit = 10 + +## Size in bytes below which to embed messages in the queue index. +## Related doc guide: https://rabbitmq.com/persistence-conf.html +## +# queue_index_embed_msgs_below = 4096 + +## You can also set this size in memory units +## +# queue_index_embed_msgs_below = 4kb + +## Whether or not to enable background periodic forced GC runs for all +## Erlang processes on the node in "waiting" state. +## +## Disabling background GC may reduce latency for client operations, +## keeping it enabled may reduce median RAM usage by the binary heap +## (see https://www.erlang-solutions.com/blog/erlang-garbage-collector.html). +## +## Before trying this option, please take a look at the memory +## breakdown (https://www.rabbitmq.com/memory-use.html). +## +# background_gc_enabled = false + +## Target (desired) interval (in milliseconds) at which we run background GC. +## The actual interval will vary depending on how long it takes to execute +## the operation (can be higher than this interval). Values less than +## 30000 milliseconds are not recommended. +## +# background_gc_target_interval = 60000 + +## Whether or not to enable proxy protocol support. +## Once enabled, clients cannot directly connect to the broker +## anymore. They must connect through a load balancer that sends the +## proxy protocol header to the broker at connection time. +## This setting applies only to AMQP clients, other protocols +## like MQTT or STOMP have their own setting to enable proxy protocol. +## See the plugins documentation for more information. +## +# proxy_protocol = false + +## Overriden product name and version. +## They are set to "RabbitMQ" and the release version by default. +# product.name = RabbitMQ +# product.version = 1.2.3 + +## "Message of the day" file. +## Its content is used to expand the logged and printed banners. +## Default to /etc/rabbitmq/motd on Unix, %APPDATA%\RabbitMQ\motd.txt +## on Windows. +# motd_file = /etc/rabbitmq/motd + +## Consumer timeout +## If a message delivered to a consumer has not been acknowledge before this timer +## triggers the channel will be force closed by the broker. This ensure that +## faultly consumers that never ack will not hold on to messages indefinitely. +## +# consumer_timeout = 900000 + +## ---------------------------------------------------------------------------- +## Advanced Erlang Networking/Clustering Options. +## +## Related doc guide: https://rabbitmq.com/clustering.html +## ---------------------------------------------------------------------------- + +# ====================================== +# Kernel section +# ====================================== + +## Timeout used to detect peer unavailability, including CLI tools. +## Related doc guide: https://www.rabbitmq.com/nettick.html. +## +# net_ticktime = 60 + +## Inter-node communication port range. +## The parameters inet_dist_listen_min and inet_dist_listen_max +## can be configured in the classic config format only. +## Related doc guide: https://www.rabbitmq.com/networking.html#epmd-inet-dist-port-range. + + +## ---------------------------------------------------------------------------- +## RabbitMQ Management Plugin +## +## Related doc guide: https://rabbitmq.com/management.html. +## ---------------------------------------------------------------------------- + +# ======================================= +# Management section +# ======================================= + +## Preload schema definitions from the following JSON file. +## Related doc guide: https://rabbitmq.com/management.html#load-definitions. +## +# management.load_definitions = /path/to/exported/definitions.json + +## Log all requests to the management HTTP API to a file. +## +# management.http_log_dir = /path/to/access.log + +## HTTP listener and embedded Web server settings. +# ## See https://rabbitmq.com/management.html for details. +# +# management.tcp.port = 15672 +# management.tcp.ip = 0.0.0.0 +# +# management.tcp.shutdown_timeout = 7000 +# management.tcp.max_keepalive = 120 +# management.tcp.idle_timeout = 120 +# management.tcp.inactivity_timeout = 120 +# management.tcp.request_timeout = 120 +# management.tcp.compress = true + +## HTTPS listener settings. +## See https://rabbitmq.com/management.html and https://rabbitmq.com/ssl.html for details. +## +# management.ssl.port = 15671 +# management.ssl.cacertfile = /path/to/ca_certificate.pem +# management.ssl.certfile = /path/to/server_certificate.pem +# management.ssl.keyfile = /path/to/server_key.pem + +## More TLS options +# management.ssl.honor_cipher_order = true +# management.ssl.honor_ecc_order = true + +## These are highly recommended for TLSv1.2 but cannot be used +## with TLSv1.3. If TLSv1.3 is enabled, these lines MUST be removed. +# management.ssl.client_renegotiation = false +# management.ssl.secure_renegotiate = true + +## Supported TLS versions +# management.ssl.versions.1 = tlsv1.2 + +## Cipher suites the server is allowed to use +# management.ssl.ciphers.1 = ECDHE-ECDSA-AES256-GCM-SHA384 +# management.ssl.ciphers.2 = ECDHE-RSA-AES256-GCM-SHA384 +# management.ssl.ciphers.3 = ECDHE-ECDSA-AES256-SHA384 +# management.ssl.ciphers.4 = ECDHE-RSA-AES256-SHA384 +# management.ssl.ciphers.5 = ECDH-ECDSA-AES256-GCM-SHA384 +# management.ssl.ciphers.6 = ECDH-RSA-AES256-GCM-SHA384 +# management.ssl.ciphers.7 = ECDH-ECDSA-AES256-SHA384 +# management.ssl.ciphers.8 = ECDH-RSA-AES256-SHA384 +# management.ssl.ciphers.9 = DHE-RSA-AES256-GCM-SHA384 + +## URL path prefix for HTTP API and management UI +# management.path_prefix = /a-prefix + +## One of 'basic', 'detailed' or 'none'. See +## https://rabbitmq.com/management.html#fine-stats for more details. +# management.rates_mode = basic + +## Configure how long aggregated data (such as message rates and queue +## lengths) is retained. Please read the plugin's documentation in +## https://rabbitmq.com/management.html#configuration for more +## details. +## Your can use 'minute', 'hour' and 'day' keys or integer key (in seconds) +# management.sample_retention_policies.global.minute = 5 +# management.sample_retention_policies.global.hour = 60 +# management.sample_retention_policies.global.day = 1200 + +# management.sample_retention_policies.basic.minute = 5 +# management.sample_retention_policies.basic.hour = 60 + +# management.sample_retention_policies.detailed.10 = 5 + +## ---------------------------------------------------------------------------- +## RabbitMQ Shovel Plugin +## +## Related doc guide: https://rabbitmq.com/shovel.html +## ---------------------------------------------------------------------------- + +## See advanced.config.example for a Shovel plugin example + + +## ---------------------------------------------------------------------------- +## RabbitMQ STOMP Plugin +## +## Related doc guide: https://rabbitmq.com/stomp.html +## ---------------------------------------------------------------------------- + +# ======================================= +# STOMP section +# ======================================= + +## See https://rabbitmq.com/stomp.html for details. + +## TCP listeners. +## +# stomp.listeners.tcp.1 = 127.0.0.1:61613 +# stomp.listeners.tcp.2 = ::1:61613 + +## TCP listener settings +## +# stomp.tcp_listen_options.backlog = 2048 +# stomp.tcp_listen_options.recbuf = 131072 +# stomp.tcp_listen_options.sndbuf = 131072 +# +# stomp.tcp_listen_options.keepalive = true +# stomp.tcp_listen_options.nodelay = true +# +# stomp.tcp_listen_options.exit_on_close = true +# stomp.tcp_listen_options.send_timeout = 120 + +## Proxy protocol support +## +# stomp.proxy_protocol = false + +## TLS listeners +## See https://rabbitmq.com/stomp.html and https://rabbitmq.com/ssl.html for details. +# stomp.listeners.ssl.default = 61614 +# +# ssl_options.cacertfile = path/to/cacert.pem +# ssl_options.certfile = path/to/cert.pem +# ssl_options.keyfile = path/to/key.pem +# ssl_options.verify = verify_peer +# ssl_options.fail_if_no_peer_cert = true + + +## Number of Erlang processes that will accept connections for the TCP +## and TLS listeners. +## +# stomp.num_acceptors.tcp = 10 +# stomp.num_acceptors.ssl = 1 + +## Additional TLS options + +## Extract a name from the client's certificate when using TLS. +## +# stomp.ssl_cert_login = true + +## Set a default user name and password. This is used as the default login +## whenever a CONNECT frame omits the login and passcode headers. +## +## Please note that setting this will allow clients to connect without +## authenticating! +## +# stomp.default_user = guest +# stomp.default_pass = guest + +## If a default user is configured, or you have configured use TLS client +## certificate based authentication, you can choose to allow clients to +## omit the CONNECT frame entirely. If set to true, the client is +## automatically connected as the default user or user supplied in the +## TLS certificate whenever the first frame sent on a session is not a +## CONNECT frame. +## +# stomp.implicit_connect = true + +## Whether or not to enable proxy protocol support. +## Once enabled, clients cannot directly connect to the broker +## anymore. They must connect through a load balancer that sends the +## proxy protocol header to the broker at connection time. +## This setting applies only to STOMP clients, other protocols +## like MQTT or AMQP have their own setting to enable proxy protocol. +## See the plugins or broker documentation for more information. +## +# stomp.proxy_protocol = false + +## ---------------------------------------------------------------------------- +## RabbitMQ MQTT Adapter +## +## See https://github.com/rabbitmq/rabbitmq-mqtt/blob/stable/README.md +## for details +## ---------------------------------------------------------------------------- + +# ======================================= +# MQTT section +# ======================================= + +## TCP listener settings. +## +# mqtt.listeners.tcp.1 = 127.0.0.1:61613 +# mqtt.listeners.tcp.2 = ::1:61613 + +## TCP listener options (as per the broker configuration). +## +# mqtt.tcp_listen_options.backlog = 4096 +# mqtt.tcp_listen_options.recbuf = 131072 +# mqtt.tcp_listen_options.sndbuf = 131072 +# +# mqtt.tcp_listen_options.keepalive = true +# mqtt.tcp_listen_options.nodelay = true +# +# mqtt.tcp_listen_options.exit_on_close = true +# mqtt.tcp_listen_options.send_timeout = 120 + +## TLS listener settings +## ## See https://rabbitmq.com/mqtt.html and https://rabbitmq.com/ssl.html for details. +# +# mqtt.listeners.ssl.default = 8883 +# +# ssl_options.cacertfile = /path/to/tls/ca_certificate_bundle.pem +# ssl_options.certfile = /path/to/tls/server_certificate.pem +# ssl_options.keyfile = /path/to/tls/server_key.pem +# ssl_options.verify = verify_peer +# ssl_options.fail_if_no_peer_cert = true +# + + +## Number of Erlang processes that will accept connections for the TCP +## and TLS listeners. +## +# mqtt.num_acceptors.tcp = 10 +# mqtt.num_acceptors.ssl = 10 + +## Whether or not to enable proxy protocol support. +## Once enabled, clients cannot directly connect to the broker +## anymore. They must connect through a load balancer that sends the +## proxy protocol header to the broker at connection time. +## This setting applies only to STOMP clients, other protocols +## like STOMP or AMQP have their own setting to enable proxy protocol. +## See the plugins or broker documentation for more information. +## +# mqtt.proxy_protocol = false + +## Set the default user name and password used for anonymous connections (when client +## provides no credentials). Anonymous connections are highly discouraged! +## +# mqtt.default_user = guest +# mqtt.default_pass = guest + +## Enable anonymous connections. If this is set to false, clients MUST provide +## credentials in order to connect. See also the mqtt.default_user/mqtt.default_pass +## keys. Anonymous connections are highly discouraged! +## +# mqtt.allow_anonymous = true + +## If you have multiple vhosts, specify the one to which the +## adapter connects. +## +# mqtt.vhost = / + +## Specify the exchange to which messages from MQTT clients are published. +## +# mqtt.exchange = amq.topic + +## Specify TTL (time to live) to control the lifetime of non-clean sessions. +## +# mqtt.subscription_ttl = 1800000 + +## Set the prefetch count (governing the maximum number of unacknowledged +## messages that will be delivered). +## +# mqtt.prefetch = 10 + + +## ---------------------------------------------------------------------------- +## RabbitMQ AMQP 1.0 Support +## +## See https://github.com/rabbitmq/rabbitmq-amqp1.0/blob/stable/README.md. +## ---------------------------------------------------------------------------- + +# ======================================= +# AMQP 1.0 section +# ======================================= + + +## Connections that are not authenticated with SASL will connect as this +## account. See the README for more information. +## +## Please note that setting this will allow clients to connect without +## authenticating! +## +# amqp1_0.default_user = guest + +## Enable protocol strict mode. See the README for more information. +## +# amqp1_0.protocol_strict_mode = false + +## Logging settings. +## +## See https://rabbitmq.com/logging.html for details. +## + +## Log directory, taken from the RABBITMQ_LOG_BASE env variable by default. +## +# log.dir = /var/log/rabbitmq + +## Logging to file. Can be false or a filename. +## Default: +# log.file = rabbit.log + +## To disable logging to a file +# log.file = false + +## Log level for file logging +## +# log.file.level = info + +## File rotation config. No rotation by default. +## DO NOT SET rotation date to ''. Leave the value unset if "" is the desired value +# log.file.rotation.date = $D0 +# log.file.rotation.size = 0 + +## Logging to console (can be true or false) +## +# log.console = false + +## Log level for console logging +## +# log.console.level = info + +## Logging to the amq.rabbitmq.log exchange (can be true or false) +## +# log.exchange = false + +## Log level to use when logging to the amq.rabbitmq.log exchange +## +# log.exchange.level = info + + + +## ---------------------------------------------------------------------------- +## RabbitMQ LDAP Plugin +## +## Related doc guide: https://rabbitmq.com/ldap.html. +## +## ---------------------------------------------------------------------------- + +# ======================================= +# LDAP section +# ======================================= + +## +## Connecting to the LDAP server(s) +## ================================ +## + +## Specify servers to bind to. You *must* set this in order for the plugin +## to work properly. +## +# auth_ldap.servers.1 = your-server-name-goes-here + +## You can define multiple servers +# auth_ldap.servers.2 = your-other-server + +## Connect to the LDAP server using TLS +## +# auth_ldap.use_ssl = false + +## Specify the LDAP port to connect to +## +# auth_ldap.port = 389 + +## LDAP connection timeout, in milliseconds or 'infinity' +## +# auth_ldap.timeout = infinity + +## Or number +# auth_ldap.timeout = 500 + +## Enable logging of LDAP queries. +## One of +## - false (no logging is performed) +## - true (verbose logging of the logic used by the plugin) +## - network (as true, but additionally logs LDAP network traffic) +## +## Defaults to false. +## +# auth_ldap.log = false + +## Also can be true or network +# auth_ldap.log = true +# auth_ldap.log = network + +## +## Authentication +## ============== +## + +## Pattern to convert the username given through AMQP to a DN before +## binding +## +# auth_ldap.user_dn_pattern = cn=${username},ou=People,dc=example,dc=com + +## Alternatively, you can convert a username to a Distinguished +## Name via an LDAP lookup after binding. See the documentation for +## full details. + +## When converting a username to a dn via a lookup, set these to +## the name of the attribute that represents the user name, and the +## base DN for the lookup query. +## +# auth_ldap.dn_lookup_attribute = userPrincipalName +# auth_ldap.dn_lookup_base = DC=gopivotal,DC=com + +## Controls how to bind for authorisation queries and also to +## retrieve the details of users logging in without presenting a +## password (e.g., SASL EXTERNAL). +## One of +## - as_user (to bind as the authenticated user - requires a password) +## - anon (to bind anonymously) +## - {UserDN, Password} (to bind with a specified user name and password) +## +## Defaults to 'as_user'. +## +# auth_ldap.other_bind = as_user + +## Or can be more complex: +# auth_ldap.other_bind.user_dn = User +# auth_ldap.other_bind.password = Password + +## If user_dn and password defined - other options is ignored. + +# ----------------------------- +# Too complex section of LDAP +# ----------------------------- + +## +## Authorisation +## ============= +## + +## The LDAP plugin can perform a variety of queries against your +## LDAP server to determine questions of authorisation. +## +## Related doc guide: https://rabbitmq.com/ldap.html#authorisation. + +## Following configuration should be defined in advanced.config file +## DO NOT UNCOMMENT THESE LINES! + +## Set the query to use when determining vhost access +## +## {vhost_access_query, {in_group, +## "ou=${vhost}-users,ou=vhosts,dc=example,dc=com"}}, + +## Set the query to use when determining resource (e.g., queue) access +## +## {resource_access_query, {constant, true}}, + +## Set queries to determine which tags a user has +## +## {tag_queries, []} +# ]}, +# ----------------------------- diff --git a/ptero_eggs/application/rathole/README.md b/ptero_eggs/application/rathole/README.md new file mode 100644 index 0000000..2430f4e --- /dev/null +++ b/ptero_eggs/application/rathole/README.md @@ -0,0 +1,7 @@ +# Rathole +A secure, stable and high-performance reverse proxy for NAT traversal, written in Rust + +rathole, like frp and ngrok, can help to expose the service on the device behind the NAT to the Internet, via a server with a public IP. + +## This egg only includes server side of rathole +Please refer to https://github.com/rapiz1/rathole for more information about rathole diff --git a/ptero_eggs/application/rathole/egg-rathole.json b/ptero_eggs/application/rathole/egg-rathole.json new file mode 100644 index 0000000..fc59b85 --- /dev/null +++ b/ptero_eggs/application/rathole/egg-rathole.json @@ -0,0 +1,52 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:53+00:00", + "name": "Rathole", + "author": "tunayada@gmail.com", + "description": "A lightweight and high-performance reverse proxy for NAT traversal, written in Rust. An alternative to frp and ngrok.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:rust_latest": "ghcr.io/ptero-eggs/yolks:rust_latest" + }, + "file_denylist": [], + "startup": "./rathole server.toml", + "config": { + "files": "{\r\n \"server.toml\": {\r\n \"parser\": \"ini\",\r\n \"find\": {\r\n \"server.bind_addr\": \"\\\"0.0.0.0:{{server.build.default.port}}\\\"\",\r\n \"server.services.test.token\": \"\\\"{{server.build.env.TOKEN}}\\\"\",\r\n \"server.services.test.bind_addr\": \"\\\"0.0.0.0:{{server.build.default.port}}\\\"\"\r\n }\r\n }\r\n}", + "logs": "{}", + "startup": "{\r\n \"done\": [\r\n \"Listening at \"\r\n ]\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/bash\r\n\r\n## get release info and download links\r\nmkdir -p /mnt/server\r\ncd /mnt/server\r\n\r\nLATEST_JSON=$(curl --silent \"https://api.github.com/repos/rapiz1/rathole/releases/latest\")\r\nRELEASES=$(curl --silent \"https://api.github.com/repos/rapiz1/rathole/releases\")\r\nARCH=$([[ \"$(uname -m)\" == \"x86_64\" ]] \u0026\u0026 echo \"amd64\" || echo \"aarch64\")\r\n\r\nif [\"${ARCH}\" == \"aarch64\"]; then\r\n MATCH=rathole-aarch64-unknown-linux-musl.zip\r\nelse\r\n MATCH=rathole-x86_64-unknown-linux-gnu.zip\r\nfi\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url | grep -i ${MATCH})\r\nelse\r\n VERSION_CHECK=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .tag_name')\r\n if [ \"${VERSION}\" == \"${VERSION_CHECK}\" ]; then\r\n DOWNLOAD_URL=$(echo ${RELEASES} | jq -r --arg VERSION \"${VERSION}\" '.[] | select(.tag_name==$VERSION) | .assets[].browser_download_url' | grep -i ${MATCH})\r\n else\r\n echo -e \"defaulting to latest release\"\r\n DOWNLOAD_URL=$(echo ${LATEST_JSON} | jq .assets | jq -r .[].browser_download_url)\r\n fi\r\nfi\r\n\r\necho \"Download url: ${DOWNLOAD_URL}\"\r\ncurl -ssL -o rathole.zip ${DOWNLOAD_URL}\r\nunzip rathole.zip\r\nrm rathole.zip\r\ntouch server.toml\r\n\r\nprintf \"[server]\\nbind_addr=\\\"0.0.0.0:${SERVER_PORT}\\\"\\n\\n[server.services.test]\\ntoken=\\\"${TOKEN}\\\"\\nbind_addr=\\\"0.0.0.0:${SERVER_PORT}\\\"\" \u003e server.toml\r\nchmod +x rathole\r\n\r\n## install end\r\necho \"-----------------------------------------\"\r\necho \"Installation completed...\"\r\necho \"-----------------------------------------\"" + } + }, + "variables": [ + { + "name": "Version", + "description": "", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Secret", + "description": "Your random token", + "env_variable": "TOKEN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|min:5|max:60", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/reposilite/README.md b/ptero_eggs/application/reposilite/README.md new file mode 100644 index 0000000..739545b --- /dev/null +++ b/ptero_eggs/application/reposilite/README.md @@ -0,0 +1,7 @@ +# [Reposilite](https://github.com/dzikoysk/reposilite) + +Lightweight and easy-to-use repository management software dedicated for Maven based artifacts in the JVM ecosystem. + +## Server Ports + +One port needs to be allocated to run Reposilite. diff --git a/ptero_eggs/application/reposilite/egg-reposilite.json b/ptero_eggs/application/reposilite/egg-reposilite.json new file mode 100644 index 0000000..37a77be --- /dev/null +++ b/ptero_eggs/application/reposilite/egg-reposilite.json @@ -0,0 +1,46 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:54+00:00", + "name": "Reposilite", + "author": "mk@kcra.me", + "description": "Lightweight and easy-to-use repository management software dedicated for Maven based artifacts in the JVM ecosystem.", + "features": null, + "docker_images": { + "ghcr.io/pterodactyl/yolks:java_11": "ghcr.io/pterodactyl/yolks:java_11", + "ghcr.io/pterodactyl/yolks:java_16": "ghcr.io/pterodactyl/yolks:java_16", + "ghcr.io/pterodactyl/yolks:java_17": "ghcr.io/pterodactyl/yolks:java_17", + "ghcr.io/pterodactyl/yolks:java_21": "ghcr.io/pterodactyl/yolks:java_21", + "ghcr.io/pterodactyl/yolks:java_8": "ghcr.io/pterodactyl/yolks:java_8" + }, + "file_denylist": [], + "startup": "java -Xmx{{SERVER_MEMORY}}M -Dreposilite.port={{SERVER_PORT}} -jar reposilite.jar --port {{SERVER_PORT}}", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"Done (\"\r\n}", + "stop": "stop" + }, + "scripts": { + "installation": { + "container": "ghcr.io/ptero-eggs/installers:debian", + "entrypoint": "bash", + "script": "#!/bin/sh\r\n# Switch to mounted directory\r\ncd /mnt/server\r\n# Find latest Reposilite version, if needed\r\nif [ \"$REPOSILITE_VERSION\" == \"latest\" ]; then\r\n REPOSILITE_VERSION=$(grep -oPm1 \"(?\u003c=\u003clatest\u003e)[^\u003c]+\" \u003c\u003c\u003c \"$(curl -s https://maven.reposilite.com/releases/com/reposilite/reposilite/maven-metadata.xml)\")\r\nfi\r\n# Check if -all suffixed jar is available\r\nstatus_code=$(curl --write-out '%{http_code}' -X HEAD -s -o /dev/null https://maven.reposilite.com/releases/com/reposilite/reposilite/${REPOSILITE_VERSION}/reposilite-${REPOSILITE_VERSION}-all.jar)\r\n# Download new Reposilite\r\nif [ \"$status_code\" == 200 ]; then\r\n curl -o reposilite.jar https://maven.reposilite.com/releases/com/reposilite/reposilite/${REPOSILITE_VERSION}/reposilite-${REPOSILITE_VERSION}-all.jar\r\nelse\r\n curl -o reposilite.jar https://maven.reposilite.com/releases/com/reposilite/reposilite/${REPOSILITE_VERSION}/reposilite-${REPOSILITE_VERSION}.jar\r\nfi" + } + }, + "variables": [ + { + "name": "Reposilite version", + "description": "The version of Reposilite.", + "env_variable": "REPOSILITE_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/sftp_storage_share/README.md b/ptero_eggs/application/sftp_storage_share/README.md new file mode 100644 index 0000000..bd9850b --- /dev/null +++ b/ptero_eggs/application/sftp_storage_share/README.md @@ -0,0 +1,19 @@ +# SFTP Storage Share + +### Description + +A simple "empty" egg that acts as a private SFTP storage share by utilizing Pterodactyl's built in SFTP system for servers. Sub-users can be added to the server by the owner to allow additional people to access the share. "Starting" the server performs no actions and it should be left off. + +You can access the SFTP server using your favourite SFTP client and the SFTP login information found under the "Settings" tab of the server. + +___ + +### Server Ports + +Pterodactyl may force you to assign a port to the server but it will not be used and can be any port. The only port that will be used will be the SFTP port assigned to the node the server is running on. + +___ + +### Known Issues + +- Pterodactyl currently does not enforce server storage size when the server is not running. Therefore, because this "server" does not run, the Disk Space setting when creating the server will not be enforced and caution should be used when deploying this solution to un-trusted end-users. diff --git a/ptero_eggs/application/sftp_storage_share/egg-s-f-t-p-storage-share.json b/ptero_eggs/application/sftp_storage_share/egg-s-f-t-p-storage-share.json new file mode 100644 index 0000000..27f36a2 --- /dev/null +++ b/ptero_eggs/application/sftp_storage_share/egg-s-f-t-p-storage-share.json @@ -0,0 +1,31 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL - PTERODACTYL.io", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:32:01+00:00", + "name": "SFTP Storage Share", + "author": "red_thirten@yahoo.com", + "description": "A simple \"empty\" egg that acts as a private SFTP storage share by utilizing Pterodactyl's built in SFTP system for servers. Sub-users can be added to the server by the owner to allow additional people to access the share. \"Starting\" the server performs no actions and it should be left off.", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:alpine": "ghcr.io/ptero-eggs/yolks:alpine" + }, + "file_denylist": [], + "startup": "echo -e \"\\n\\n\\033[0;31mThere is no need to start this server. The SFTP service is always running. Feel free to stop the server now.\\n\\t\\033[0;36m(Sub-users can be added via the Users tab to add/remove access to the share in real time)\\n\\n\"", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "alpine:3.4", + "entrypoint": "ash", + "script": "# Pterodactyl SFTP Storage Share Egg ~ David Wolfe (Red-Thirten) ~ 2023-01-27" + } + }, + "variables": [] +} \ No newline at end of file diff --git a/ptero_eggs/application/uptime-kuma/README.md b/ptero_eggs/application/uptime-kuma/README.md new file mode 100644 index 0000000..bcf2444 --- /dev/null +++ b/ptero_eggs/application/uptime-kuma/README.md @@ -0,0 +1,43 @@ +# Uptime Kuma + +## Author & Contributers +| Name | Github Profile | Buy me a Coffee | +| ------------- |-------------|-------------| +| gOOvER | https://github.com/gOOvER | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B351D0Q) | + +## Description +Uptime Kuma is an easy-to-use self-hosted monitoring tool +Egg is based on parkers generic nodejs egg + +## Links +Github: https://github.com/louislam/uptime-kuma + +## Admin & login +After installation and successful start, browse to your : and setup the Admin. + +## Server Ports + +Uptime Kuma requires 1 port. You can choose any port you want + +| Port | default | +|---------|---------------| +| default | 3000 | + +## Cloudflared, Apprise & Chromium + +The latest image provides support for Cloudflared and Apprise. + +### Cloudflared +With Cloudflared it is possible to create a proxy over Cloudflare without having to use an nginx proxy. More info here: +https://github.com/louislam/uptime-kuma/wiki/Reverse-Proxy-with-Cloudflare-Tunnel + +### Apprise +Apprise provides notifications for all kinds of services. Uptime Kuma has a built-in support for Apprise. +More info's here: +https://github.com/caronc/apprise#supported-notifications + +### Monitor HTTP(s) - Browser Engine (Chromium) +The image supports the monitor "HTTP(s) - Browser Engine". +To use this monitor, enter the following path in the settings under "General -> Chrome/Chromium Executable" (at the bottom): + +/usr/bin/chromium-browser \ No newline at end of file diff --git a/ptero_eggs/application/uptime-kuma/egg-uptime-kuma.json b/ptero_eggs/application/uptime-kuma/egg-uptime-kuma.json new file mode 100644 index 0000000..8c98b35 --- /dev/null +++ b/ptero_eggs/application/uptime-kuma/egg-uptime-kuma.json @@ -0,0 +1,62 @@ +{ + "_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 ]] \u0026\u0026 [[ {{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 \u0026 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" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/voice/README.md b/ptero_eggs/application/voice/README.md new file mode 100644 index 0000000..24aeeca --- /dev/null +++ b/ptero_eggs/application/voice/README.md @@ -0,0 +1,5 @@ +# Voice Servers + +* Teamspeak_ARM64 +* TS3-Manager +* Teamspeak6-server diff --git a/ptero_eggs/application/voice/teamspeak6_server/README.md b/ptero_eggs/application/voice/teamspeak6_server/README.md new file mode 100644 index 0000000..260c856 --- /dev/null +++ b/ptero_eggs/application/voice/teamspeak6_server/README.md @@ -0,0 +1,35 @@ +# TeamSpeak 6 Server + +> [!CAUTION] +> TeamSpeak 6 Server is currently in beta. Expect frequent updates and potential instability + +## [Official Website](https://teamspeak.com) + +TeamSpeak 6 is the next-generation voice communication platform for gaming and communities. + +### Notice +TeamSpeak 6 Server is currently in **beta**. Expect frequent updates and potential instability + +## Server Ports + +You can use any available ports. The most important defaults are shown below: + +| Port | Default | Description | +|------------------------|---------|------------------------ | +| Voice Port | 9987 | Main voice server port | +| File Transfer Port | 30033 | File transfers (Optional/admin) | +| Query SSH | 10022 | Server Query SSH interface (Optional/admin) | +| Query HTTP | 10080 | Server Query HTTP interface (Optional/admin) | +| Query HTTPS | 10443 | Server Query HTTPS interface (Optional/admin) | + +## Notes + +- **Admin Rights**: On first launch, copy the generated key (token) from the console to claim server admin in your TeamSpeak 6 client. +- **Beta Limits**: TeamSpeak 6 server beta is limited to 5 users. +- **Query Interfaces**: Enable/disable additional query interfaces (SSH/HTTP/HTTPS) in the server variables. +- **S3 File Transfer**: Leave S3 variables blank unless you wish use S3-compatible storage. +- **Certificates**: For HTTPS query, upload your cert/key to `/home/container` and enter the filenames in their variables. +- **More Info**: [TeamSpeak 6 Beta Announcements](https://community.teamspeak.com/c/teamspeak-6-server) + +### ARM64 +* The ARM64 egg may not perform as expected due to the AMD64 to ARM64 emulaton. diff --git a/ptero_eggs/application/voice/teamspeak6_server/egg-arm64-teamspeak6-server.json b/ptero_eggs/application/voice/teamspeak6_server/egg-arm64-teamspeak6-server.json new file mode 100644 index 0000000..70d7a9a --- /dev/null +++ b/ptero_eggs/application/voice/teamspeak6_server/egg-arm64-teamspeak6-server.json @@ -0,0 +1,212 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": "null" + }, + "exported_at": "2025-07-05T13:49:22+02:00", + "name": "Teamspeak6 Server ARM64", + "author": "ptero@redbananaofficial.com", + "description": "TeamSpeak offers the ideal voice communication for gaming, education and training, internal business communication, and staying in touch with friends and family.", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:box64": "ghcr.io\/ptero-eggs\/yolks:box64" + }, + "file_denylist": [], + "startup": "box64 .\/tsserver --default-voice-port={{SERVER_PORT}}", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"listening on 0.0.0.0:\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "cd \/mnt\/server\r\n\r\napt-get update\r\napt-get install -y jq bzip2\r\n\r\nver=\"$TS_VERSION\"\r\nif [ -z \"$ver\" ] || [ \"$ver\" = \"latest\" ]; then\r\n json=$(curl -sSL https:\/\/api.github.com\/repos\/teamspeak\/teamspeak6-server\/releases\/latest)\r\nelse\r\n json=$(curl -sSL https:\/\/api.github.com\/repos\/teamspeak\/teamspeak6-server\/releases\/tags\/$ver 2>\/dev\/null)\r\n if echo \"$json\" | grep -q \"Not Found\"; then\r\n altver=$(echo \"$ver\" | sed 's\/-\/\\\/\/')\r\n json=$(curl -sSL https:\/\/api.github.com\/repos\/teamspeak\/teamspeak6-server\/releases\/tags\/$altver 2>\/dev\/null)\r\n fi\r\nfi\r\n\r\nif echo \"$json\" | grep -q \"Not Found\"; then\r\n echo \"Not found: $ver\"\r\n exit 1\r\nfi\r\n\r\nurl=$(echo \"$json\" | jq -r '.assets | map(select((.name | contains(\"linux_amd64\")) and (.name | endswith(\".tar.bz2\"))))[0].browser_download_url')\r\n\r\nif [ -z \"$url\" ] || [ \"$url\" = \"null\" ]; then\r\n echo \"Not found: $ver\"\r\n exit 1\r\nfi\r\n\r\ncurl -sSL \"$url\" | tar xj --strip-components=1\r\necho \"Installed\"", + "container": "ghcr.io\/ptero-eggs\/installers:debian", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Server Query Admin Password", + "description": "The password for the server query admin user.", + "env_variable": "TSSERVER_QUERY_ADMIN_PASSWORD", + "default_value": "ChangeMe", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:32", + "field_type": "text" + }, + { + "name": "Server Version", + "description": "The version of Teamspeak 3 to use when running the server.", + "env_variable": "TS_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Accept TServer License (required)", + "description": "This is for accepting the license", + "env_variable": "TSSERVER_LICENSE_ACCEPTED", + "default_value": "accept", + "user_viewable": true, + "user_editable": false, + "rules": "nullable|string|max:20", + "field_type": "text" + }, + { + "name": "File Transfer Port", + "description": "The Teamspeak file transfer port (can be changed).", + "env_variable": "TSSERVER_FILE_TRANSFER_PORT", + "default_value": "30033", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:10", + "field_type": "text" + }, + { + "name": "Enable SSH Query", + "description": "Enable the SSH query interface (set to 1 to enable).", + "env_variable": "TSSERVER_QUERY_SSH_ENABLED", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:0,1", + "field_type": "text" + }, + { + "name": "SSH Query Port", + "description": "The port for the SSH query interface (can be changed).", + "env_variable": "TSSERVER_QUERY_SSH_PORT", + "default_value": "10022", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:1,65535", + "field_type": "text" + }, + { + "name": "Enable HTTP Query", + "description": "Enable the HTTP query interface (set to 1 to enable).", + "env_variable": "TSSERVER_QUERY_HTTP_ENABLED", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:0,1", + "field_type": "text" + }, + { + "name": "HTTP Query Port", + "description": "The port for the HTTP query interface (can be changed).", + "env_variable": "TSSERVER_QUERY_HTTP_PORT", + "default_value": "10080", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:1,65535", + "field_type": "text" + }, + { + "name": "Enable HTTPS Query", + "description": "Enable the HTTPS query interface (set to 1 to enable).", + "env_variable": "TSSERVER_QUERY_HTTPS_ENABLED", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:0,1", + "field_type": "text" + }, + { + "name": "HTTPS Query Port", + "description": "The port for the HTTPS query interface (can be changed).", + "env_variable": "TSSERVER_QUERY_HTTPS_PORT", + "default_value": "10443", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:1,65535", + "field_type": "text" + }, + { + "name": "Enable S3 File Transfer", + "description": "Enable S3 file transfer (set to 1 to enable).", + "env_variable": "TSSERVER_S3FT_ENABLED", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:0,1", + "field_type": "text" + }, + { + "name": "S3 Access Key", + "description": "S3 Access Key for file transfers.", + "env_variable": "TSSERVER_S3FT_ACCESS_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "S3 Secret Key", + "description": "S3 Secret Key for file transfers.", + "env_variable": "TSSERVER_S3FT_SECRET_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "S3 Bucket", + "description": "S3 Bucket name for file transfers.", + "env_variable": "TSSERVER_S3FT_BUCKET", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "S3 Domain", + "description": "S3 Domain\/endpoint for file transfers.", + "env_variable": "TSSERVER_S3FT_DOMAIN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "S3 Region", + "description": "S3 region for file transfers.", + "env_variable": "TSSERVER_S3FT_REGION", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "HTTPS Certificate Filename", + "description": "Place the certificate file in \/home\/container and enter the filename here, e.g; ts6_https_cert.pem", + "env_variable": "TSSERVER_QUERY_HTTPS_CERT", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:255", + "field_type": "text" + }, + { + "name": "HTTPS Private Key Filename", + "description": "Place the private key file in \/home\/container and enter the filename here, e.g: ts6_https_key.pem", + "env_variable": "TSSERVER_QUERY_HTTPS_PRIVATE_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:255", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/voice/teamspeak6_server/egg-teamspeak6-server.json b/ptero_eggs/application/voice/teamspeak6_server/egg-teamspeak6-server.json new file mode 100644 index 0000000..cf16c73 --- /dev/null +++ b/ptero_eggs/application/voice/teamspeak6_server/egg-teamspeak6-server.json @@ -0,0 +1,212 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": "null" + }, + "exported_at": "2025-07-05T14:56:23+02:00", + "name": "Teamspeak6 Server", + "author": "ptero@redbananaofficial.com", + "description": "TeamSpeak offers the ideal voice communication for gaming, education and training, internal business communication, and staying in touch with friends and family.", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:debian": "ghcr.io\/ptero-eggs\/yolks:debian" + }, + "file_denylist": [], + "startup": ".\/tsserver --default-voice-port={{SERVER_PORT}}", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"listening on 0.0.0.0:\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "cd \/mnt\/server\r\n\r\napt-get update\r\napt-get install -y jq bzip2\r\n\r\nver=\"$TS_VERSION\"\r\nif [ -z \"$ver\" ] || [ \"$ver\" = \"latest\" ]; then\r\n json=$(curl -sSL https:\/\/api.github.com\/repos\/teamspeak\/teamspeak6-server\/releases\/latest)\r\nelse\r\n json=$(curl -sSL https:\/\/api.github.com\/repos\/teamspeak\/teamspeak6-server\/releases\/tags\/$ver 2>\/dev\/null)\r\n if echo \"$json\" | grep -q \"Not Found\"; then\r\n altver=$(echo \"$ver\" | sed 's\/-\/\\\/\/')\r\n json=$(curl -sSL https:\/\/api.github.com\/repos\/teamspeak\/teamspeak6-server\/releases\/tags\/$altver 2>\/dev\/null)\r\n fi\r\nfi\r\n\r\nif echo \"$json\" | grep -q \"Not Found\"; then\r\n echo \"Not found: $ver\"\r\n exit 1\r\nfi\r\n\r\nurl=$(echo \"$json\" | jq -r '.assets | map(select((.name | contains(\"linux_amd64\")) and (.name | endswith(\".tar.bz2\"))))[0].browser_download_url')\r\n\r\nif [ -z \"$url\" ] || [ \"$url\" = \"null\" ]; then\r\n echo \"Not found: $ver\"\r\n exit 1\r\nfi\r\n\r\ncurl -sSL \"$url\" | tar xj --strip-components=1\r\necho \"Installed\"", + "container": "ghcr.io\/ptero-eggs\/installers:debian", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "Server Query Admin Password", + "description": "The password for the server query admin user.", + "env_variable": "TSSERVER_QUERY_ADMIN_PASSWORD", + "default_value": "ChangeMe", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:32", + "field_type": "text" + }, + { + "name": "Server Version", + "description": "The version of Teamspeak 3 to use when running the server.", + "env_variable": "TS_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:20", + "field_type": "text" + }, + { + "name": "Accept TServer License (required)", + "description": "This is for accepting the license", + "env_variable": "TSSERVER_LICENSE_ACCEPTED", + "default_value": "accept", + "user_viewable": true, + "user_editable": false, + "rules": "nullable|string|max:20", + "field_type": "text" + }, + { + "name": "File Transfer Port", + "description": "The Teamspeak file transfer port (can be changed).", + "env_variable": "TSSERVER_FILE_TRANSFER_PORT", + "default_value": "30033", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:10", + "field_type": "text" + }, + { + "name": "Enable SSH Query", + "description": "Enable the SSH query interface (set to 1 to enable).", + "env_variable": "TSSERVER_QUERY_SSH_ENABLED", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:0,1", + "field_type": "text" + }, + { + "name": "SSH Query Port", + "description": "The port for the SSH query interface (can be changed).", + "env_variable": "TSSERVER_QUERY_SSH_PORT", + "default_value": "10022", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:1,65535", + "field_type": "text" + }, + { + "name": "Enable HTTP Query", + "description": "Enable the HTTP query interface (set to 1 to enable).", + "env_variable": "TSSERVER_QUERY_HTTP_ENABLED", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:0,1", + "field_type": "text" + }, + { + "name": "HTTP Query Port", + "description": "The port for the HTTP query interface (can be changed).", + "env_variable": "TSSERVER_QUERY_HTTP_PORT", + "default_value": "10080", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:1,65535", + "field_type": "text" + }, + { + "name": "Enable HTTPS Query", + "description": "Enable the HTTPS query interface (set to 1 to enable).", + "env_variable": "TSSERVER_QUERY_HTTPS_ENABLED", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:0,1", + "field_type": "text" + }, + { + "name": "HTTPS Query Port", + "description": "The port for the HTTPS query interface (can be changed).", + "env_variable": "TSSERVER_QUERY_HTTPS_PORT", + "default_value": "10443", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:1,65535", + "field_type": "text" + }, + { + "name": "Enable S3 File Transfer", + "description": "Enable S3 file transfer (set to 1 to enable).", + "env_variable": "TSSERVER_S3FT_ENABLED", + "default_value": "0", + "user_viewable": true, + "user_editable": true, + "rules": "required|integer|between:0,1", + "field_type": "text" + }, + { + "name": "S3 Access Key", + "description": "S3 Access Key for file transfers.", + "env_variable": "TSSERVER_S3FT_ACCESS_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "S3 Secret Key", + "description": "S3 Secret Key for file transfers.", + "env_variable": "TSSERVER_S3FT_SECRET_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "S3 Bucket", + "description": "S3 Bucket name for file transfers.", + "env_variable": "TSSERVER_S3FT_BUCKET", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "S3 Domain", + "description": "S3 Domain\/endpoint for file transfers.", + "env_variable": "TSSERVER_S3FT_DOMAIN", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "S3 Region", + "description": "S3 region for file transfers.", + "env_variable": "TSSERVER_S3FT_REGION", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:100", + "field_type": "text" + }, + { + "name": "HTTPS Certificate Filename", + "description": "Place the certificate file in \/home\/container and enter the filename here, e.g; ts6_https_cert.pem", + "env_variable": "TSSERVER_QUERY_HTTPS_CERT", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:255", + "field_type": "text" + }, + { + "name": "HTTPS Private Key Filename", + "description": "Place the private key file in \/home\/container and enter the filename here, e.g: ts6_https_key.pem", + "env_variable": "TSSERVER_QUERY_HTTPS_PRIVATE_KEY", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:255", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/voice/teamspeak_ARM64/README.md b/ptero_eggs/application/voice/teamspeak_ARM64/README.md new file mode 100644 index 0000000..b7450bc --- /dev/null +++ b/ptero_eggs/application/voice/teamspeak_ARM64/README.md @@ -0,0 +1,17 @@ +# TeamSpeak ARM64 + +## From their [Website](https://www.teamspeak.com/) + + +## Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Voice | 9987 | +| Query | 10011 | +| File | 30033 | + +### arm64 +* The arm64 may not perform as expected due to the amd64 to arm emulaton. diff --git a/ptero_eggs/application/voice/teamspeak_ARM64/egg-teamspeak3-server-a-r-m64.json b/ptero_eggs/application/voice/teamspeak_ARM64/egg-teamspeak3-server-a-r-m64.json new file mode 100644 index 0000000..ff0af2f --- /dev/null +++ b/ptero_eggs/application/voice/teamspeak_ARM64/egg-teamspeak3-server-a-r-m64.json @@ -0,0 +1,72 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2024-12-11T19:05:12+00:00", + "name": "Teamspeak3 Server ARM64", + "author": "josdekurk@gmail.com", + "description": "VoIP software designed with security in mind, featuring crystal clear voice quality, endless customization options, and scalabilty up to thousands of simultaneous users.", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:box64": "ghcr.io\/ptero-eggs\/yolks:box64" + }, + "file_denylist": [], + "startup": "box64 .\/ts3server default_voice_port={{SERVER_PORT}} query_port={{QUERY_PORT}} filetransfer_ip=0.0.0.0 filetransfer_port={{FILE_TRANSFER}} serveradmin_password={{SERVERADMIN_PASSWORD}} license_accepted=1", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"listening on 0.0.0.0:\"\r\n}", + "logs": "{\r\n \"custom\": true,\r\n \"location\": \"logs\/ts3.log\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/ash\r\n# TS3 Installation Script\r\n#\r\n# Server Files: \/mnt\/server\r\n\r\nif [ -z ${TS_VERSION} ] || [ ${TS_VERSION} == latest ]; then\r\n TS_VERSION=$(curl -sSL https:\/\/teamspeak.com\/versions\/server.json | jq -r '.linux.x86_64.version')\r\nfi\r\n\r\ncd \/mnt\/server\r\n\r\necho -e \"getting files from http:\/\/files.teamspeak-services.com\/releases\/server\/${TS_VERSION}\/teamspeak3-server_linux_x86-${TS_VERSION}.tar.bz2\" \r\ncurl -L http:\/\/files.teamspeak-services.com\/releases\/server\/${TS_VERSION}\/teamspeak3-server_linux_amd64-${TS_VERSION}.tar.bz2 | tar -xvj --strip-components=1", + "container": "ghcr.io\/pterodactyl\/installers:alpine", + "entrypoint": "ash" + } + }, + "variables": [ + { + "name": "Server Query Admin Password", + "description": "The password for the server query admin user.", + "env_variable": "SERVERADMIN_PASSWORD", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "nullable|string|max:32", + "field_type": "text" + }, + { + "name": "Server Version", + "description": "The version of Teamspeak 3 to use when running the server.", + "env_variable": "TS_VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:6", + "field_type": "text" + }, + { + "name": "File Transfer Port", + "description": "The Teamspeak file transfer port", + "env_variable": "FILE_TRANSFER", + "default_value": "30033", + "user_viewable": true, + "user_editable": false, + "rules": "required|integer|between:1,65535", + "field_type": "text" + }, + { + "name": "Query Port", + "description": "The Teamspeak Query Port", + "env_variable": "QUERY_PORT", + "default_value": "10011", + "user_viewable": true, + "user_editable": false, + "rules": "required|integer|between:1,65535", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/application/voice/ts3_manager/README.md b/ptero_eggs/application/voice/ts3_manager/README.md new file mode 100644 index 0000000..731d290 --- /dev/null +++ b/ptero_eggs/application/voice/ts3_manager/README.md @@ -0,0 +1,17 @@ +# TS3 Manager + +## [Website](https://www.ts3.app/) + +TS3 Manager is a simple and lightwight webbased Teamspeak Webinterface + +### Install notes + +Connect with your IP from your Pteroserver and the assigned Port. Add your IP to TS Server Withlist + +### Server Ports + +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Game | 3000 | diff --git a/ptero_eggs/application/voice/ts3_manager/egg-t-s3-manager.json b/ptero_eggs/application/voice/ts3_manager/egg-t-s3-manager.json new file mode 100644 index 0000000..eea0d41 --- /dev/null +++ b/ptero_eggs/application/voice/ts3_manager/egg-t-s3-manager.json @@ -0,0 +1,62 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v2", + "update_url": null + }, + "exported_at": "2024-12-11T19:05:09+00:00", + "name": "TS3 Manager", + "author": "eggs@goover.dev", + "description": "The Open Source Webinterface For TeamSpeak Servers", + "features": null, + "docker_images": { + "ghcr.io\/ptero-eggs\/yolks:debian": "ghcr.io\/ptero-eggs\/yolks:debian" + }, + "file_denylist": [], + "startup": ".\/start_ts3-manager -p ${SERVER_PORT}", + "config": { + "files": "{}", + "startup": "{\r\n \"done\": \"Server listening on\"\r\n}", + "logs": "{}", + "stop": "^C" + }, + "scripts": { + "installation": { + "script": "#!\/bin\/bash\r\n\r\n## install needed packages\r\napt update\r\napt install -y git unzip jq wget tar curl\r\n\r\n## env\r\nexport HOME=\/mnt\/server\r\ncd $HOME\r\n\r\n## get release info and download links\r\nLATEST_RELEASE=$(curl -L -s -H 'Accept: application\/json' https:\/\/github.com\/${GITHUB_PACKAGE}\/releases\/latest)\r\nLATEST_VERSION=$(echo $LATEST_RELEASE | sed -e 's\/.*\"tag_name\":\"\\([^\"]*\\)\".*\/\\1\/')\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n DOWNLOAD_LINK=\"https:\/\/github.com\/${GITHUB_PACKAGE}\/releases\/download\/$LATEST_VERSION\/$MATCH-$LATEST_VERSION\"\r\nelse \r\n DOWNLOAD_LINK=\"https:\/\/github.com\/${GITHUB_PACKAGE}\/releases\/download\/v$VERSION\/$MATCH-$VERSION-v$VERSION\"\r\nfi\r\n\r\necho $DOWNLOAD_LINK\r\nwget $DOWNLOAD_LINK\r\n\r\nif [ -z \"${VERSION}\" ] || [ \"${VERSION}\" == \"latest\" ]; then\r\n mv -f $MATCH-$LATEST_VERSION $HOME\/start_ts3-manager\r\n chmod +x start_ts3-manager\r\nelse\r\n mv -f $MATCH-v$VERSION $HOME\/start_ts3-manager\r\n chmod start_ts3-manager\r\nfi\r\n\r\necho \"-------------------------------------------------------\"\r\necho \"Installation completed\"\r\necho \"-------------------------------------------------------\"", + "container": "ghcr.io\/ptero-eggs\/installers:debian", + "entrypoint": "bash" + } + }, + "variables": [ + { + "name": "GITHUB_PACKAGE", + "description": "", + "env_variable": "GITHUB_PACKAGE", + "default_value": "joni1802\/ts3-manager", + "user_viewable": false, + "user_editable": false, + "rules": "required|string|max:50", + "field_type": "text" + }, + { + "name": "VERSION", + "description": "", + "env_variable": "VERSION", + "default_value": "latest", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|max:30", + "field_type": "text" + }, + { + "name": "MATCH", + "description": "", + "env_variable": "MATCH", + "default_value": "ts3-manager-linux-x64", + "user_viewable": false, + "user_editable": false, + "rules": "required|string|max:50", + "field_type": "text" + } + ] +} diff --git a/ptero_eggs/application/yarr/README.md b/ptero_eggs/application/yarr/README.md new file mode 100644 index 0000000..c1745b1 --- /dev/null +++ b/ptero_eggs/application/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/ptero_eggs/application/yarr/egg-yarr.json b/ptero_eggs/application/yarr/egg-yarr.json new file mode 100644 index 0000000..8b8d778 --- /dev/null +++ b/ptero_eggs/application/yarr/egg-yarr.json @@ -0,0 +1,52 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PANEL", + "meta": { + "update_url": null, + "version": "PTDL_v2" + }, + "exported_at": "2024-06-02T14:40:56+00:00", + "name": "Yarr", + "author": "sotoluis90@gmail.com", + "description": "Yarr is a selfhosted feed aggregator", + "features": null, + "docker_images": { + "ghcr.io/ptero-eggs/yolks:debian": "ghcr.io/ptero-eggs/yolks:debian" + }, + "file_denylist": [], + "startup": "./yarr -addr 0.0.0.0:{{SERVER_PORT}} -auth=\"{{USERNAME}}:{{PASSWORD}}\" -db=./feed.sql", + "config": { + "files": "{}", + "logs": "{}", + "startup": "{\r\n \"done\": \"starting server\"\r\n}", + "stop": "^C" + }, + "scripts": { + "installation": { + "container": "golang:1.19.13-bookworm", + "entrypoint": "bash", + "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 # -\u003e _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\"" + } + }, + "variables": [ + { + "name": "Username", + "description": "The username used to log in to yarr", + "env_variable": "USERNAME", + "default_value": "username", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|alpha_dash", + "field_type": "text" + }, + { + "name": "Password", + "description": "The password needed to log in to yarr", + "env_variable": "PASSWORD", + "default_value": "", + "user_viewable": true, + "user_editable": true, + "rules": "required|string|alpha_dash", + "field_type": "text" + } + ] +} \ No newline at end of file diff --git a/ptero_eggs/hytale/README.md b/ptero_eggs/game_server/hytale/README.md similarity index 100% rename from ptero_eggs/hytale/README.md rename to ptero_eggs/game_server/hytale/README.md diff --git a/ptero_eggs/hytale/egg-hytale.json b/ptero_eggs/game_server/hytale/egg-hytale.json similarity index 100% rename from ptero_eggs/hytale/egg-hytale.json rename to ptero_eggs/game_server/hytale/egg-hytale.json diff --git a/ptero_eggs/minecraft/bedrock/LeviLamina/README.md b/ptero_eggs/game_server/minecraft/bedrock/LeviLamina/README.md similarity index 100% rename from ptero_eggs/minecraft/bedrock/LeviLamina/README.md rename to ptero_eggs/game_server/minecraft/bedrock/LeviLamina/README.md diff --git a/ptero_eggs/minecraft/bedrock/LeviLamina/egg-levi-lamina.json b/ptero_eggs/game_server/minecraft/bedrock/LeviLamina/egg-levi-lamina.json similarity index 100% rename from ptero_eggs/minecraft/bedrock/LeviLamina/egg-levi-lamina.json rename to ptero_eggs/game_server/minecraft/bedrock/LeviLamina/egg-levi-lamina.json diff --git a/ptero_eggs/minecraft/bedrock/LiteLoader-bedrock/README.md b/ptero_eggs/game_server/minecraft/bedrock/LiteLoader-bedrock/README.md similarity index 100% rename from ptero_eggs/minecraft/bedrock/LiteLoader-bedrock/README.md rename to ptero_eggs/game_server/minecraft/bedrock/LiteLoader-bedrock/README.md diff --git a/ptero_eggs/minecraft/bedrock/LiteLoader-bedrock/egg-LiteLoader-bedrock.json b/ptero_eggs/game_server/minecraft/bedrock/LiteLoader-bedrock/egg-LiteLoader-bedrock.json similarity index 100% rename from ptero_eggs/minecraft/bedrock/LiteLoader-bedrock/egg-LiteLoader-bedrock.json rename to ptero_eggs/game_server/minecraft/bedrock/LiteLoader-bedrock/egg-LiteLoader-bedrock.json diff --git a/ptero_eggs/minecraft/bedrock/PowerNukkitX/README.md b/ptero_eggs/game_server/minecraft/bedrock/PowerNukkitX/README.md similarity index 100% rename from ptero_eggs/minecraft/bedrock/PowerNukkitX/README.md rename to ptero_eggs/game_server/minecraft/bedrock/PowerNukkitX/README.md diff --git a/ptero_eggs/minecraft/bedrock/PowerNukkitX/egg-powernukkitx.json b/ptero_eggs/game_server/minecraft/bedrock/PowerNukkitX/egg-powernukkitx.json similarity index 100% rename from ptero_eggs/minecraft/bedrock/PowerNukkitX/egg-powernukkitx.json rename to ptero_eggs/game_server/minecraft/bedrock/PowerNukkitX/egg-powernukkitx.json diff --git a/ptero_eggs/minecraft/bedrock/PowerNukkitX/nukkit.yml b/ptero_eggs/game_server/minecraft/bedrock/PowerNukkitX/nukkit.yml similarity index 100% rename from ptero_eggs/minecraft/bedrock/PowerNukkitX/nukkit.yml rename to ptero_eggs/game_server/minecraft/bedrock/PowerNukkitX/nukkit.yml diff --git a/ptero_eggs/minecraft/bedrock/PowerNukkitX/server.properties b/ptero_eggs/game_server/minecraft/bedrock/PowerNukkitX/server.properties similarity index 100% rename from ptero_eggs/minecraft/bedrock/PowerNukkitX/server.properties rename to ptero_eggs/game_server/minecraft/bedrock/PowerNukkitX/server.properties diff --git a/ptero_eggs/minecraft/bedrock/README.md b/ptero_eggs/game_server/minecraft/bedrock/README.md similarity index 100% rename from ptero_eggs/minecraft/bedrock/README.md rename to ptero_eggs/game_server/minecraft/bedrock/README.md diff --git a/ptero_eggs/minecraft/bedrock/bedrock/README.md b/ptero_eggs/game_server/minecraft/bedrock/bedrock/README.md similarity index 100% rename from ptero_eggs/minecraft/bedrock/bedrock/README.md rename to ptero_eggs/game_server/minecraft/bedrock/bedrock/README.md diff --git a/ptero_eggs/minecraft/bedrock/bedrock/egg-vanilla-bedrock-ARM64.json b/ptero_eggs/game_server/minecraft/bedrock/bedrock/egg-vanilla-bedrock-ARM64.json similarity index 100% rename from ptero_eggs/minecraft/bedrock/bedrock/egg-vanilla-bedrock-ARM64.json rename to ptero_eggs/game_server/minecraft/bedrock/bedrock/egg-vanilla-bedrock-ARM64.json diff --git a/ptero_eggs/minecraft/bedrock/bedrock/egg-vanilla-bedrock.json b/ptero_eggs/game_server/minecraft/bedrock/bedrock/egg-vanilla-bedrock.json similarity index 100% rename from ptero_eggs/minecraft/bedrock/bedrock/egg-vanilla-bedrock.json rename to ptero_eggs/game_server/minecraft/bedrock/bedrock/egg-vanilla-bedrock.json diff --git a/ptero_eggs/minecraft/bedrock/gomint/README.md b/ptero_eggs/game_server/minecraft/bedrock/gomint/README.md similarity index 100% rename from ptero_eggs/minecraft/bedrock/gomint/README.md rename to ptero_eggs/game_server/minecraft/bedrock/gomint/README.md diff --git a/ptero_eggs/minecraft/bedrock/gomint/egg-go-mint.json b/ptero_eggs/game_server/minecraft/bedrock/gomint/egg-go-mint.json similarity index 100% rename from ptero_eggs/minecraft/bedrock/gomint/egg-go-mint.json rename to ptero_eggs/game_server/minecraft/bedrock/gomint/egg-go-mint.json diff --git a/ptero_eggs/minecraft/bedrock/gomint/server.yml b/ptero_eggs/game_server/minecraft/bedrock/gomint/server.yml similarity index 100% rename from ptero_eggs/minecraft/bedrock/gomint/server.yml rename to ptero_eggs/game_server/minecraft/bedrock/gomint/server.yml diff --git a/ptero_eggs/minecraft/bedrock/nukkit/README.md b/ptero_eggs/game_server/minecraft/bedrock/nukkit/README.md similarity index 100% rename from ptero_eggs/minecraft/bedrock/nukkit/README.md rename to ptero_eggs/game_server/minecraft/bedrock/nukkit/README.md diff --git a/ptero_eggs/minecraft/bedrock/nukkit/egg-nukkit.json b/ptero_eggs/game_server/minecraft/bedrock/nukkit/egg-nukkit.json similarity index 100% rename from ptero_eggs/minecraft/bedrock/nukkit/egg-nukkit.json rename to ptero_eggs/game_server/minecraft/bedrock/nukkit/egg-nukkit.json diff --git a/ptero_eggs/minecraft/bedrock/nukkit/nukkit.yml b/ptero_eggs/game_server/minecraft/bedrock/nukkit/nukkit.yml similarity index 100% rename from ptero_eggs/minecraft/bedrock/nukkit/nukkit.yml rename to ptero_eggs/game_server/minecraft/bedrock/nukkit/nukkit.yml diff --git a/ptero_eggs/minecraft/bedrock/nukkit/server.properties b/ptero_eggs/game_server/minecraft/bedrock/nukkit/server.properties similarity index 100% rename from ptero_eggs/minecraft/bedrock/nukkit/server.properties rename to ptero_eggs/game_server/minecraft/bedrock/nukkit/server.properties diff --git a/ptero_eggs/minecraft/bedrock/pocketmine_mp/README.md b/ptero_eggs/game_server/minecraft/bedrock/pocketmine_mp/README.md similarity index 100% rename from ptero_eggs/minecraft/bedrock/pocketmine_mp/README.md rename to ptero_eggs/game_server/minecraft/bedrock/pocketmine_mp/README.md diff --git a/ptero_eggs/minecraft/bedrock/pocketmine_mp/egg-pocketmine-m-p.json b/ptero_eggs/game_server/minecraft/bedrock/pocketmine_mp/egg-pocketmine-m-p.json similarity index 100% rename from ptero_eggs/minecraft/bedrock/pocketmine_mp/egg-pocketmine-m-p.json rename to ptero_eggs/game_server/minecraft/bedrock/pocketmine_mp/egg-pocketmine-m-p.json diff --git a/ptero_eggs/minecraft/bedrock/pocketmine_mp/server.properties b/ptero_eggs/game_server/minecraft/bedrock/pocketmine_mp/server.properties similarity index 100% rename from ptero_eggs/minecraft/bedrock/pocketmine_mp/server.properties rename to ptero_eggs/game_server/minecraft/bedrock/pocketmine_mp/server.properties diff --git a/ptero_eggs/minecraft/crossplay/purpur-geysermc-floodgate/README.md b/ptero_eggs/game_server/minecraft/crossplay/purpur-geysermc-floodgate/README.md similarity index 100% rename from ptero_eggs/minecraft/crossplay/purpur-geysermc-floodgate/README.md rename to ptero_eggs/game_server/minecraft/crossplay/purpur-geysermc-floodgate/README.md diff --git a/ptero_eggs/minecraft/crossplay/purpur-geysermc-floodgate/egg-purpur-geyser-floodgate.json b/ptero_eggs/game_server/minecraft/crossplay/purpur-geysermc-floodgate/egg-purpur-geyser-floodgate.json similarity index 100% rename from ptero_eggs/minecraft/crossplay/purpur-geysermc-floodgate/egg-purpur-geyser-floodgate.json rename to ptero_eggs/game_server/minecraft/crossplay/purpur-geysermc-floodgate/egg-purpur-geyser-floodgate.json diff --git a/ptero_eggs/minecraft/java/README.md b/ptero_eggs/game_server/minecraft/java/README.md similarity index 100% rename from ptero_eggs/minecraft/java/README.md rename to ptero_eggs/game_server/minecraft/java/README.md diff --git a/ptero_eggs/minecraft/java/arclight/README.md b/ptero_eggs/game_server/minecraft/java/arclight/README.md similarity index 100% rename from ptero_eggs/minecraft/java/arclight/README.md rename to ptero_eggs/game_server/minecraft/java/arclight/README.md diff --git a/ptero_eggs/minecraft/java/arclight/egg-arclight.json b/ptero_eggs/game_server/minecraft/java/arclight/egg-arclight.json similarity index 100% rename from ptero_eggs/minecraft/java/arclight/egg-arclight.json rename to ptero_eggs/game_server/minecraft/java/arclight/egg-arclight.json diff --git a/ptero_eggs/minecraft/java/canvas-mc/README.md b/ptero_eggs/game_server/minecraft/java/canvas-mc/README.md similarity index 100% rename from ptero_eggs/minecraft/java/canvas-mc/README.md rename to ptero_eggs/game_server/minecraft/java/canvas-mc/README.md diff --git a/ptero_eggs/minecraft/java/canvas-mc/egg-canvas-mc.json b/ptero_eggs/game_server/minecraft/java/canvas-mc/egg-canvas-mc.json similarity index 100% rename from ptero_eggs/minecraft/java/canvas-mc/egg-canvas-mc.json rename to ptero_eggs/game_server/minecraft/java/canvas-mc/egg-canvas-mc.json diff --git a/ptero_eggs/minecraft/java/cuberite/README.md b/ptero_eggs/game_server/minecraft/java/cuberite/README.md similarity index 100% rename from ptero_eggs/minecraft/java/cuberite/README.md rename to ptero_eggs/game_server/minecraft/java/cuberite/README.md diff --git a/ptero_eggs/minecraft/java/cuberite/egg-cuberite.json b/ptero_eggs/game_server/minecraft/java/cuberite/egg-cuberite.json similarity index 100% rename from ptero_eggs/minecraft/java/cuberite/egg-cuberite.json rename to ptero_eggs/game_server/minecraft/java/cuberite/egg-cuberite.json diff --git a/ptero_eggs/minecraft/java/cuberite/settings.ini b/ptero_eggs/game_server/minecraft/java/cuberite/settings.ini similarity index 100% rename from ptero_eggs/minecraft/java/cuberite/settings.ini rename to ptero_eggs/game_server/minecraft/java/cuberite/settings.ini diff --git a/ptero_eggs/minecraft/java/cuberite/webadmin.ini b/ptero_eggs/game_server/minecraft/java/cuberite/webadmin.ini similarity index 100% rename from ptero_eggs/minecraft/java/cuberite/webadmin.ini rename to ptero_eggs/game_server/minecraft/java/cuberite/webadmin.ini diff --git a/ptero_eggs/minecraft/java/curseforge/README.md b/ptero_eggs/game_server/minecraft/java/curseforge/README.md similarity index 100% rename from ptero_eggs/minecraft/java/curseforge/README.md rename to ptero_eggs/game_server/minecraft/java/curseforge/README.md diff --git a/ptero_eggs/minecraft/java/curseforge/egg-curse-forge-generic.json b/ptero_eggs/game_server/minecraft/java/curseforge/egg-curse-forge-generic.json similarity index 100% rename from ptero_eggs/minecraft/java/curseforge/egg-curse-forge-generic.json rename to ptero_eggs/game_server/minecraft/java/curseforge/egg-curse-forge-generic.json diff --git a/ptero_eggs/minecraft/java/fabric/README.md b/ptero_eggs/game_server/minecraft/java/fabric/README.md similarity index 100% rename from ptero_eggs/minecraft/java/fabric/README.md rename to ptero_eggs/game_server/minecraft/java/fabric/README.md diff --git a/ptero_eggs/minecraft/java/fabric/egg-fabric.json b/ptero_eggs/game_server/minecraft/java/fabric/egg-fabric.json similarity index 100% rename from ptero_eggs/minecraft/java/fabric/egg-fabric.json rename to ptero_eggs/game_server/minecraft/java/fabric/egg-fabric.json diff --git a/ptero_eggs/minecraft/java/folia/README.md b/ptero_eggs/game_server/minecraft/java/folia/README.md similarity index 100% rename from ptero_eggs/minecraft/java/folia/README.md rename to ptero_eggs/game_server/minecraft/java/folia/README.md diff --git a/ptero_eggs/minecraft/java/folia/egg-folia.json b/ptero_eggs/game_server/minecraft/java/folia/egg-folia.json similarity index 100% rename from ptero_eggs/minecraft/java/folia/egg-folia.json rename to ptero_eggs/game_server/minecraft/java/folia/egg-folia.json diff --git a/ptero_eggs/minecraft/java/forge/forge/README.md b/ptero_eggs/game_server/minecraft/java/forge/forge/README.md similarity index 100% rename from ptero_eggs/minecraft/java/forge/forge/README.md rename to ptero_eggs/game_server/minecraft/java/forge/forge/README.md diff --git a/ptero_eggs/minecraft/java/forge/forge/egg-forge-enhanced.json b/ptero_eggs/game_server/minecraft/java/forge/forge/egg-forge-enhanced.json similarity index 100% rename from ptero_eggs/minecraft/java/forge/forge/egg-forge-enhanced.json rename to ptero_eggs/game_server/minecraft/java/forge/forge/egg-forge-enhanced.json diff --git a/ptero_eggs/minecraft/java/ftb/README.md b/ptero_eggs/game_server/minecraft/java/ftb/README.md similarity index 100% rename from ptero_eggs/minecraft/java/ftb/README.md rename to ptero_eggs/game_server/minecraft/java/ftb/README.md diff --git a/ptero_eggs/minecraft/java/ftb/egg-ftb-installer.json b/ptero_eggs/game_server/minecraft/java/ftb/egg-ftb-installer.json similarity index 100% rename from ptero_eggs/minecraft/java/ftb/egg-ftb-installer.json rename to ptero_eggs/game_server/minecraft/java/ftb/egg-ftb-installer.json diff --git a/ptero_eggs/minecraft/java/glowstone/README.md b/ptero_eggs/game_server/minecraft/java/glowstone/README.md similarity index 100% rename from ptero_eggs/minecraft/java/glowstone/README.md rename to ptero_eggs/game_server/minecraft/java/glowstone/README.md diff --git a/ptero_eggs/minecraft/java/glowstone/egg-glowstone.json b/ptero_eggs/game_server/minecraft/java/glowstone/egg-glowstone.json similarity index 100% rename from ptero_eggs/minecraft/java/glowstone/egg-glowstone.json rename to ptero_eggs/game_server/minecraft/java/glowstone/egg-glowstone.json diff --git a/ptero_eggs/minecraft/java/krypton/README.md b/ptero_eggs/game_server/minecraft/java/krypton/README.md similarity index 100% rename from ptero_eggs/minecraft/java/krypton/README.md rename to ptero_eggs/game_server/minecraft/java/krypton/README.md diff --git a/ptero_eggs/minecraft/java/krypton/config.conf b/ptero_eggs/game_server/minecraft/java/krypton/config.conf similarity index 100% rename from ptero_eggs/minecraft/java/krypton/config.conf rename to ptero_eggs/game_server/minecraft/java/krypton/config.conf diff --git a/ptero_eggs/minecraft/java/krypton/egg-krypton.json b/ptero_eggs/game_server/minecraft/java/krypton/egg-krypton.json similarity index 100% rename from ptero_eggs/minecraft/java/krypton/egg-krypton.json rename to ptero_eggs/game_server/minecraft/java/krypton/egg-krypton.json diff --git a/ptero_eggs/minecraft/java/limbo/README.md b/ptero_eggs/game_server/minecraft/java/limbo/README.md similarity index 100% rename from ptero_eggs/minecraft/java/limbo/README.md rename to ptero_eggs/game_server/minecraft/java/limbo/README.md diff --git a/ptero_eggs/minecraft/java/limbo/egg-limbo.json b/ptero_eggs/game_server/minecraft/java/limbo/egg-limbo.json similarity index 100% rename from ptero_eggs/minecraft/java/limbo/egg-limbo.json rename to ptero_eggs/game_server/minecraft/java/limbo/egg-limbo.json diff --git a/ptero_eggs/minecraft/java/magma/README.md b/ptero_eggs/game_server/minecraft/java/magma/README.md similarity index 100% rename from ptero_eggs/minecraft/java/magma/README.md rename to ptero_eggs/game_server/minecraft/java/magma/README.md diff --git a/ptero_eggs/minecraft/java/magma/egg-magma.json b/ptero_eggs/game_server/minecraft/java/magma/egg-magma.json similarity index 100% rename from ptero_eggs/minecraft/java/magma/egg-magma.json rename to ptero_eggs/game_server/minecraft/java/magma/egg-magma.json diff --git a/ptero_eggs/minecraft/java/modrinth/README.md b/ptero_eggs/game_server/minecraft/java/modrinth/README.md similarity index 100% rename from ptero_eggs/minecraft/java/modrinth/README.md rename to ptero_eggs/game_server/minecraft/java/modrinth/README.md diff --git a/ptero_eggs/minecraft/java/modrinth/egg-modrinth-generic.json b/ptero_eggs/game_server/minecraft/java/modrinth/egg-modrinth-generic.json similarity index 100% rename from ptero_eggs/minecraft/java/modrinth/egg-modrinth-generic.json rename to ptero_eggs/game_server/minecraft/java/modrinth/egg-modrinth-generic.json diff --git a/ptero_eggs/minecraft/java/mohist/README.md b/ptero_eggs/game_server/minecraft/java/mohist/README.md similarity index 100% rename from ptero_eggs/minecraft/java/mohist/README.md rename to ptero_eggs/game_server/minecraft/java/mohist/README.md diff --git a/ptero_eggs/minecraft/java/mohist/egg-mohist.json b/ptero_eggs/game_server/minecraft/java/mohist/egg-mohist.json similarity index 100% rename from ptero_eggs/minecraft/java/mohist/egg-mohist.json rename to ptero_eggs/game_server/minecraft/java/mohist/egg-mohist.json diff --git a/ptero_eggs/minecraft/java/nanolimbo/README.md b/ptero_eggs/game_server/minecraft/java/nanolimbo/README.md similarity index 100% rename from ptero_eggs/minecraft/java/nanolimbo/README.md rename to ptero_eggs/game_server/minecraft/java/nanolimbo/README.md diff --git a/ptero_eggs/minecraft/java/nanolimbo/egg-nano-limbo.json b/ptero_eggs/game_server/minecraft/java/nanolimbo/egg-nano-limbo.json similarity index 100% rename from ptero_eggs/minecraft/java/nanolimbo/egg-nano-limbo.json rename to ptero_eggs/game_server/minecraft/java/nanolimbo/egg-nano-limbo.json diff --git a/ptero_eggs/minecraft/java/nanolimbo/settings.yml b/ptero_eggs/game_server/minecraft/java/nanolimbo/settings.yml similarity index 100% rename from ptero_eggs/minecraft/java/nanolimbo/settings.yml rename to ptero_eggs/game_server/minecraft/java/nanolimbo/settings.yml diff --git a/ptero_eggs/minecraft/java/neoforge/README.md b/ptero_eggs/game_server/minecraft/java/neoforge/README.md similarity index 100% rename from ptero_eggs/minecraft/java/neoforge/README.md rename to ptero_eggs/game_server/minecraft/java/neoforge/README.md diff --git a/ptero_eggs/minecraft/java/neoforge/egg-neoforge.json b/ptero_eggs/game_server/minecraft/java/neoforge/egg-neoforge.json similarity index 100% rename from ptero_eggs/minecraft/java/neoforge/egg-neoforge.json rename to ptero_eggs/game_server/minecraft/java/neoforge/egg-neoforge.json diff --git a/ptero_eggs/minecraft/java/paper/README.md b/ptero_eggs/game_server/minecraft/java/paper/README.md similarity index 100% rename from ptero_eggs/minecraft/java/paper/README.md rename to ptero_eggs/game_server/minecraft/java/paper/README.md diff --git a/ptero_eggs/minecraft/java/paper/egg-paper.json b/ptero_eggs/game_server/minecraft/java/paper/egg-paper.json similarity index 100% rename from ptero_eggs/minecraft/java/paper/egg-paper.json rename to ptero_eggs/game_server/minecraft/java/paper/egg-paper.json diff --git a/ptero_eggs/minecraft/java/purpur/README.md b/ptero_eggs/game_server/minecraft/java/purpur/README.md similarity index 100% rename from ptero_eggs/minecraft/java/purpur/README.md rename to ptero_eggs/game_server/minecraft/java/purpur/README.md diff --git a/ptero_eggs/minecraft/java/purpur/egg-purpur.json b/ptero_eggs/game_server/minecraft/java/purpur/egg-purpur.json similarity index 100% rename from ptero_eggs/minecraft/java/purpur/egg-purpur.json rename to ptero_eggs/game_server/minecraft/java/purpur/egg-purpur.json diff --git a/ptero_eggs/minecraft/java/quilt/README.md b/ptero_eggs/game_server/minecraft/java/quilt/README.md similarity index 100% rename from ptero_eggs/minecraft/java/quilt/README.md rename to ptero_eggs/game_server/minecraft/java/quilt/README.md diff --git a/ptero_eggs/minecraft/java/quilt/egg-quilt.json b/ptero_eggs/game_server/minecraft/java/quilt/egg-quilt.json similarity index 100% rename from ptero_eggs/minecraft/java/quilt/egg-quilt.json rename to ptero_eggs/game_server/minecraft/java/quilt/egg-quilt.json diff --git a/ptero_eggs/minecraft/java/server.properties b/ptero_eggs/game_server/minecraft/java/server.properties similarity index 100% rename from ptero_eggs/minecraft/java/server.properties rename to ptero_eggs/game_server/minecraft/java/server.properties diff --git a/ptero_eggs/minecraft/java/spigot/README.md b/ptero_eggs/game_server/minecraft/java/spigot/README.md similarity index 100% rename from ptero_eggs/minecraft/java/spigot/README.md rename to ptero_eggs/game_server/minecraft/java/spigot/README.md diff --git a/ptero_eggs/minecraft/java/spigot/egg-spigot.json b/ptero_eggs/game_server/minecraft/java/spigot/egg-spigot.json similarity index 100% rename from ptero_eggs/minecraft/java/spigot/egg-spigot.json rename to ptero_eggs/game_server/minecraft/java/spigot/egg-spigot.json diff --git a/ptero_eggs/minecraft/java/spongeforge/README.md b/ptero_eggs/game_server/minecraft/java/spongeforge/README.md similarity index 100% rename from ptero_eggs/minecraft/java/spongeforge/README.md rename to ptero_eggs/game_server/minecraft/java/spongeforge/README.md diff --git a/ptero_eggs/minecraft/java/spongeforge/egg-sponge-forge.json b/ptero_eggs/game_server/minecraft/java/spongeforge/egg-sponge-forge.json similarity index 100% rename from ptero_eggs/minecraft/java/spongeforge/egg-sponge-forge.json rename to ptero_eggs/game_server/minecraft/java/spongeforge/egg-sponge-forge.json diff --git a/ptero_eggs/minecraft/java/spongevanilla/README.md b/ptero_eggs/game_server/minecraft/java/spongevanilla/README.md similarity index 100% rename from ptero_eggs/minecraft/java/spongevanilla/README.md rename to ptero_eggs/game_server/minecraft/java/spongevanilla/README.md diff --git a/ptero_eggs/minecraft/java/spongevanilla/egg-sponge-vanilla.json b/ptero_eggs/game_server/minecraft/java/spongevanilla/egg-sponge-vanilla.json similarity index 100% rename from ptero_eggs/minecraft/java/spongevanilla/egg-sponge-vanilla.json rename to ptero_eggs/game_server/minecraft/java/spongevanilla/egg-sponge-vanilla.json diff --git a/ptero_eggs/minecraft/java/technic/README.md b/ptero_eggs/game_server/minecraft/java/technic/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/README.md rename to ptero_eggs/game_server/minecraft/java/technic/README.md diff --git a/ptero_eggs/minecraft/java/technic/Tekkit-2/README.md b/ptero_eggs/game_server/minecraft/java/technic/Tekkit-2/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/Tekkit-2/README.md rename to ptero_eggs/game_server/minecraft/java/technic/Tekkit-2/README.md diff --git a/ptero_eggs/minecraft/java/technic/Tekkit-2/egg-tekkit2.json b/ptero_eggs/game_server/minecraft/java/technic/Tekkit-2/egg-tekkit2.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/Tekkit-2/egg-tekkit2.json rename to ptero_eggs/game_server/minecraft/java/technic/Tekkit-2/egg-tekkit2.json diff --git a/ptero_eggs/minecraft/java/technic/Tekkit/README.md b/ptero_eggs/game_server/minecraft/java/technic/Tekkit/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/Tekkit/README.md rename to ptero_eggs/game_server/minecraft/java/technic/Tekkit/README.md diff --git a/ptero_eggs/minecraft/java/technic/Tekkit/egg-tekkit.json b/ptero_eggs/game_server/minecraft/java/technic/Tekkit/egg-tekkit.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/Tekkit/egg-tekkit.json rename to ptero_eggs/game_server/minecraft/java/technic/Tekkit/egg-tekkit.json diff --git a/ptero_eggs/minecraft/java/technic/attack-of-the-bteam/README.md b/ptero_eggs/game_server/minecraft/java/technic/attack-of-the-bteam/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/attack-of-the-bteam/README.md rename to ptero_eggs/game_server/minecraft/java/technic/attack-of-the-bteam/README.md diff --git a/ptero_eggs/minecraft/java/technic/attack-of-the-bteam/egg-attack-of-the-b--team.json b/ptero_eggs/game_server/minecraft/java/technic/attack-of-the-bteam/egg-attack-of-the-b--team.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/attack-of-the-bteam/egg-attack-of-the-b--team.json rename to ptero_eggs/game_server/minecraft/java/technic/attack-of-the-bteam/egg-attack-of-the-b--team.json diff --git a/ptero_eggs/minecraft/java/technic/blightfall/README.md b/ptero_eggs/game_server/minecraft/java/technic/blightfall/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/blightfall/README.md rename to ptero_eggs/game_server/minecraft/java/technic/blightfall/README.md diff --git a/ptero_eggs/minecraft/java/technic/blightfall/egg-blightfall.json b/ptero_eggs/game_server/minecraft/java/technic/blightfall/egg-blightfall.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/blightfall/egg-blightfall.json rename to ptero_eggs/game_server/minecraft/java/technic/blightfall/egg-blightfall.json diff --git a/ptero_eggs/minecraft/java/technic/hexxit/README.md b/ptero_eggs/game_server/minecraft/java/technic/hexxit/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/hexxit/README.md rename to ptero_eggs/game_server/minecraft/java/technic/hexxit/README.md diff --git a/ptero_eggs/minecraft/java/technic/hexxit/egg-hexxit.json b/ptero_eggs/game_server/minecraft/java/technic/hexxit/egg-hexxit.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/hexxit/egg-hexxit.json rename to ptero_eggs/game_server/minecraft/java/technic/hexxit/egg-hexxit.json diff --git a/ptero_eggs/minecraft/java/technic/tekkit-classic/README.md b/ptero_eggs/game_server/minecraft/java/technic/tekkit-classic/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/tekkit-classic/README.md rename to ptero_eggs/game_server/minecraft/java/technic/tekkit-classic/README.md diff --git a/ptero_eggs/minecraft/java/technic/tekkit-classic/egg-tekkit-classic.json b/ptero_eggs/game_server/minecraft/java/technic/tekkit-classic/egg-tekkit-classic.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/tekkit-classic/egg-tekkit-classic.json rename to ptero_eggs/game_server/minecraft/java/technic/tekkit-classic/egg-tekkit-classic.json diff --git a/ptero_eggs/minecraft/java/technic/tekkit-legends/README.md b/ptero_eggs/game_server/minecraft/java/technic/tekkit-legends/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/tekkit-legends/README.md rename to ptero_eggs/game_server/minecraft/java/technic/tekkit-legends/README.md diff --git a/ptero_eggs/minecraft/java/technic/tekkit-legends/egg-tekkit-legends.json b/ptero_eggs/game_server/minecraft/java/technic/tekkit-legends/egg-tekkit-legends.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/tekkit-legends/egg-tekkit-legends.json rename to ptero_eggs/game_server/minecraft/java/technic/tekkit-legends/egg-tekkit-legends.json diff --git a/ptero_eggs/minecraft/java/technic/tekkit-smp/README.md b/ptero_eggs/game_server/minecraft/java/technic/tekkit-smp/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/tekkit-smp/README.md rename to ptero_eggs/game_server/minecraft/java/technic/tekkit-smp/README.md diff --git a/ptero_eggs/minecraft/java/technic/tekkit-smp/egg-tekkit-smp.json b/ptero_eggs/game_server/minecraft/java/technic/tekkit-smp/egg-tekkit-smp.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/tekkit-smp/egg-tekkit-smp.json rename to ptero_eggs/game_server/minecraft/java/technic/tekkit-smp/egg-tekkit-smp.json diff --git a/ptero_eggs/minecraft/java/technic/the-1-12-2-pack/README.md b/ptero_eggs/game_server/minecraft/java/technic/the-1-12-2-pack/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/the-1-12-2-pack/README.md rename to ptero_eggs/game_server/minecraft/java/technic/the-1-12-2-pack/README.md diff --git a/ptero_eggs/minecraft/java/technic/the-1-12-2-pack/egg-the1-12-2-pack.json b/ptero_eggs/game_server/minecraft/java/technic/the-1-12-2-pack/egg-the1-12-2-pack.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/the-1-12-2-pack/egg-the1-12-2-pack.json rename to ptero_eggs/game_server/minecraft/java/technic/the-1-12-2-pack/egg-the1-12-2-pack.json diff --git a/ptero_eggs/minecraft/java/technic/the-1-7-10-pack/README.md b/ptero_eggs/game_server/minecraft/java/technic/the-1-7-10-pack/README.md similarity index 100% rename from ptero_eggs/minecraft/java/technic/the-1-7-10-pack/README.md rename to ptero_eggs/game_server/minecraft/java/technic/the-1-7-10-pack/README.md diff --git a/ptero_eggs/minecraft/java/technic/the-1-7-10-pack/egg-the1-7-10-pack.json b/ptero_eggs/game_server/minecraft/java/technic/the-1-7-10-pack/egg-the1-7-10-pack.json similarity index 100% rename from ptero_eggs/minecraft/java/technic/the-1-7-10-pack/egg-the1-7-10-pack.json rename to ptero_eggs/game_server/minecraft/java/technic/the-1-7-10-pack/egg-the1-7-10-pack.json diff --git a/ptero_eggs/minecraft/java/vanillacord/README.md b/ptero_eggs/game_server/minecraft/java/vanillacord/README.md similarity index 100% rename from ptero_eggs/minecraft/java/vanillacord/README.md rename to ptero_eggs/game_server/minecraft/java/vanillacord/README.md diff --git a/ptero_eggs/minecraft/java/vanillacord/egg-vanilla-cord.json b/ptero_eggs/game_server/minecraft/java/vanillacord/egg-vanilla-cord.json similarity index 100% rename from ptero_eggs/minecraft/java/vanillacord/egg-vanilla-cord.json rename to ptero_eggs/game_server/minecraft/java/vanillacord/egg-vanilla-cord.json diff --git a/ptero_eggs/minecraft/proxy/README.md b/ptero_eggs/game_server/minecraft/proxy/README.md similarity index 100% rename from ptero_eggs/minecraft/proxy/README.md rename to ptero_eggs/game_server/minecraft/proxy/README.md diff --git a/ptero_eggs/minecraft/proxy/bedrock/README.md b/ptero_eggs/game_server/minecraft/proxy/bedrock/README.md similarity index 100% rename from ptero_eggs/minecraft/proxy/bedrock/README.md rename to ptero_eggs/game_server/minecraft/proxy/bedrock/README.md diff --git a/ptero_eggs/minecraft/proxy/bedrock/waterdog_pe/README.md b/ptero_eggs/game_server/minecraft/proxy/bedrock/waterdog_pe/README.md similarity index 100% rename from ptero_eggs/minecraft/proxy/bedrock/waterdog_pe/README.md rename to ptero_eggs/game_server/minecraft/proxy/bedrock/waterdog_pe/README.md diff --git a/ptero_eggs/minecraft/proxy/bedrock/waterdog_pe/config.yml b/ptero_eggs/game_server/minecraft/proxy/bedrock/waterdog_pe/config.yml similarity index 100% rename from ptero_eggs/minecraft/proxy/bedrock/waterdog_pe/config.yml rename to ptero_eggs/game_server/minecraft/proxy/bedrock/waterdog_pe/config.yml diff --git a/ptero_eggs/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-p-e.json b/ptero_eggs/game_server/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-p-e.json similarity index 100% rename from ptero_eggs/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-p-e.json rename to ptero_eggs/game_server/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-p-e.json diff --git a/ptero_eggs/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-pe.json b/ptero_eggs/game_server/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-pe.json similarity index 100% rename from ptero_eggs/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-pe.json rename to ptero_eggs/game_server/minecraft/proxy/bedrock/waterdog_pe/egg-waterdog-pe.json diff --git a/ptero_eggs/minecraft/proxy/java/README.md b/ptero_eggs/game_server/minecraft/proxy/java/README.md similarity index 100% rename from ptero_eggs/minecraft/proxy/java/README.md rename to ptero_eggs/game_server/minecraft/proxy/java/README.md diff --git a/ptero_eggs/minecraft/proxy/java/travertine/README.md b/ptero_eggs/game_server/minecraft/proxy/java/travertine/README.md similarity index 100% rename from ptero_eggs/minecraft/proxy/java/travertine/README.md rename to ptero_eggs/game_server/minecraft/proxy/java/travertine/README.md diff --git a/ptero_eggs/minecraft/proxy/java/travertine/egg-travertine.json b/ptero_eggs/game_server/minecraft/proxy/java/travertine/egg-travertine.json similarity index 100% rename from ptero_eggs/minecraft/proxy/java/travertine/egg-travertine.json rename to ptero_eggs/game_server/minecraft/proxy/java/travertine/egg-travertine.json diff --git a/ptero_eggs/minecraft/proxy/java/velocity/README.md b/ptero_eggs/game_server/minecraft/proxy/java/velocity/README.md similarity index 100% rename from ptero_eggs/minecraft/proxy/java/velocity/README.md rename to ptero_eggs/game_server/minecraft/proxy/java/velocity/README.md diff --git a/ptero_eggs/minecraft/proxy/java/velocity/egg-velocity.json b/ptero_eggs/game_server/minecraft/proxy/java/velocity/egg-velocity.json similarity index 100% rename from ptero_eggs/minecraft/proxy/java/velocity/egg-velocity.json rename to ptero_eggs/game_server/minecraft/proxy/java/velocity/egg-velocity.json diff --git a/ptero_eggs/minecraft/proxy/java/velocity/velocity.toml b/ptero_eggs/game_server/minecraft/proxy/java/velocity/velocity.toml similarity index 100% rename from ptero_eggs/minecraft/proxy/java/velocity/velocity.toml rename to ptero_eggs/game_server/minecraft/proxy/java/velocity/velocity.toml diff --git a/ptero_eggs/minecraft/proxy/java/viaaas/README.md b/ptero_eggs/game_server/minecraft/proxy/java/viaaas/README.md similarity index 100% rename from ptero_eggs/minecraft/proxy/java/viaaas/README.md rename to ptero_eggs/game_server/minecraft/proxy/java/viaaas/README.md diff --git a/ptero_eggs/minecraft/proxy/java/viaaas/egg-v-i-aaa-s.json b/ptero_eggs/game_server/minecraft/proxy/java/viaaas/egg-v-i-aaa-s.json similarity index 100% rename from ptero_eggs/minecraft/proxy/java/viaaas/egg-v-i-aaa-s.json rename to ptero_eggs/game_server/minecraft/proxy/java/viaaas/egg-v-i-aaa-s.json diff --git a/ptero_eggs/minecraft/proxy/java/waterfall/README.md b/ptero_eggs/game_server/minecraft/proxy/java/waterfall/README.md similarity index 100% rename from ptero_eggs/minecraft/proxy/java/waterfall/README.md rename to ptero_eggs/game_server/minecraft/proxy/java/waterfall/README.md diff --git a/ptero_eggs/minecraft/proxy/java/waterfall/config.yml b/ptero_eggs/game_server/minecraft/proxy/java/waterfall/config.yml similarity index 100% rename from ptero_eggs/minecraft/proxy/java/waterfall/config.yml rename to ptero_eggs/game_server/minecraft/proxy/java/waterfall/config.yml diff --git a/ptero_eggs/minecraft/proxy/java/waterfall/egg-waterfall.json b/ptero_eggs/game_server/minecraft/proxy/java/waterfall/egg-waterfall.json similarity index 100% rename from ptero_eggs/minecraft/proxy/java/waterfall/egg-waterfall.json rename to ptero_eggs/game_server/minecraft/proxy/java/waterfall/egg-waterfall.json