diff --git a/README.md b/README.md index a41f8b73..0e87aada 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ If you are reading this it looks like you are looking to add an egg to your serv ### noSQL -* [mongoDB](/database/nosql/mongodb) +* [MongoDB](/database/nosql/mongodb) ### SQL Databases diff --git a/database/nosql/mongodb/README.md b/database/nosql/mongodb/README.md index b72a3a7d..4dcf9797 100644 --- a/database/nosql/mongodb/README.md +++ b/database/nosql/mongodb/README.md @@ -1,4 +1,4 @@ -# mongoDB +# MongoDB ## From their [Website](https://www.mongodb.com/) @@ -8,6 +8,36 @@ MongoDB is a general purpose, document-based, distributed database built for mod To disable the message about free monitoring you can run `db.disableFreeMonitoring()`. +## Security + +By default, MongoDB **does not enforce access control**, meaning that even if you set an admin username and password in the settings of your Pterodactyl server, **anyone will be able to connect to the database without authentication**, and perform any operation. + +> :warning: This is why we recommend to expose your MongoDB database only to your local network, if possible + +### Enabling authentication + +To enable authentification, you need to edit the following lines to your `mongod.conf` file: + +```yaml +security: + authorization: "enabled" +``` + +> :closed_lock_with_key: To learn more about MongoDB security, you can read the [MongoDB Security Checklist](https://www.mongodb.com/docs/manual/administration/security-checklist/#security-checklist) + +### Notes specific to the MongoDB 6 egg + +**The [MongoDB 6 egg](./egg-mongo-d-b6.json) enables 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. diff --git a/database/nosql/mongodb/egg-mongo-d-b6.json b/database/nosql/mongodb/egg-mongo-d-b6.json index 388adcc9..96c8e9b7 100644 --- a/database/nosql/mongodb/egg-mongo-d-b6.json +++ b/database/nosql/mongodb/egg-mongo-d-b6.json @@ -4,7 +4,7 @@ "version": "PTDL_v2", "update_url": null }, - "exported_at": "2022-09-27T08:58:45-04:00", + "exported_at": "2022-10-31T17:26:13+00:00", "name": "MongoDB 6", "author": "parker@parkervcp.com", "description": "MongoDB is a general purpose, document-based, distributed database built for modern application developers and for my butt era.", @@ -15,7 +15,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": "{}", + "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"