diff --git a/README.md b/README.md index f72a5a75..5387aae8 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,7 @@ If you are reading this it looks like you are looking to add an egg to your serv ## Database Eggs [MariaDB](/database/mariadb/) - +[Redis](/database/redis/) ## Game Eggs [ET Legacy](/enemy_territory/etlegacy/) diff --git a/database/README.md b/database/README.md index 66e60c2b..c040f047 100644 --- a/database/README.md +++ b/database/README.md @@ -2,8 +2,11 @@ ## sql DBs -### [mariadb](/database/mariadb/) +### [mariadb](/mariadb/) https://mariadb.org/ -### [postgres](/database/postgres/) - https://www.postgresql.org/ \ No newline at end of file +### [postgres](/postgres/) + https://www.postgresql.org/ + +### [redis](/redis/) + https://redis.io/ \ No newline at end of file diff --git a/database/redis/README.md b/database/redis/README.md new file mode 100644 index 00000000..4c89fc87 --- /dev/null +++ b/database/redis/README.md @@ -0,0 +1,16 @@ +# 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 https://docs.redislabs.com/latest/rs/administering/designing-production/hardware-requirements/ + + +### Server Ports +Ports required to run the server in a table format. + +| Port | default | +|---------|---------| +| Server | 6379 | diff --git a/database/redis/egg-redis.json b/database/redis/egg-redis.json new file mode 100644 index 00000000..6ac93d66 --- /dev/null +++ b/database/redis/egg-redis.json @@ -0,0 +1,36 @@ +{ + "_comment": "DO NOT EDIT: FILE GENERATED AUTOMATICALLY BY PTERODACTYL PANEL - PTERODACTYL.IO", + "meta": { + "version": "PTDL_v1" + }, + "exported_at": "2020-03-04T11:05:29-05:00", + "name": "Redis", + "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.", + "image": "quay.io\/parkervcp\/pterodactyl-images:db_redis", + "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": "alpine:3.10", + "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": 1, + "user_editable": 1, + "rules": "required|string" + } + ] +} \ No newline at end of file