diff --git a/docs/assets/mongodb_atlas/MongoDB_Asset-1.png b/docs/assets/mongodb_atlas/MongoDB_Asset-1.png new file mode 100644 index 0000000..7ac5d47 Binary files /dev/null and b/docs/assets/mongodb_atlas/MongoDB_Asset-1.png differ diff --git a/docs/assets/mongodb_atlas/MongoDB_Asset-2.png b/docs/assets/mongodb_atlas/MongoDB_Asset-2.png new file mode 100644 index 0000000..d5f5fc2 Binary files /dev/null and b/docs/assets/mongodb_atlas/MongoDB_Asset-2.png differ diff --git a/docs/assets/mongodb_atlas/MongoDB_Asset-3.png b/docs/assets/mongodb_atlas/MongoDB_Asset-3.png new file mode 100644 index 0000000..87d0675 Binary files /dev/null and b/docs/assets/mongodb_atlas/MongoDB_Asset-3.png differ diff --git a/docs/assets/mongodb_atlas/MongoDB_Asset-4.png b/docs/assets/mongodb_atlas/MongoDB_Asset-4.png new file mode 100644 index 0000000..c230315 Binary files /dev/null and b/docs/assets/mongodb_atlas/MongoDB_Asset-4.png differ diff --git a/docs/assets/mongodb_atlas/MongoDB_Asset-5.png b/docs/assets/mongodb_atlas/MongoDB_Asset-5.png new file mode 100644 index 0000000..46a44d2 Binary files /dev/null and b/docs/assets/mongodb_atlas/MongoDB_Asset-5.png differ diff --git a/docs/assets/mongodb_atlas/MongoDB_Asset-6.png b/docs/assets/mongodb_atlas/MongoDB_Asset-6.png new file mode 100644 index 0000000..1549190 Binary files /dev/null and b/docs/assets/mongodb_atlas/MongoDB_Asset-6.png differ diff --git a/docs/guides/mongodb_atlas_setup.md b/docs/guides/mongodb_atlas_setup.md new file mode 100644 index 0000000..37debf4 --- /dev/null +++ b/docs/guides/mongodb_atlas_setup.md @@ -0,0 +1,50 @@ +This guide will show you how to set up a [MongoDB Atlas](https://www.mongodb.com/atlas/database) database for use with TuringBot. The setup for M0 (the free tier) is free of charge. + +# Creating the DB cluster + +1) Head to the [signup page](https://www.mongodb.com/cloud/atlas/register) and fill your details in, agree to the terms and click `Create your Atlas account` + +2) Once logged in, you will get a welcome screen prompting you to deploy the database cluster. Fill it in as you wish and click `Finish`
+ +![image](../assets/mongodb_atlas/MongoDB_Asset-1.png) + +3) You will now be prompted with some more advanced DB info. Make sure to set the server to M0 if you want the Free tier. Click `Create` once you are done.
+ +![image](../assets/mongodb_atlas/MongoDB_Asset-2.png) + +4) You will now be faced with the login setup. Create an user that you will log in with, mark the username and password down.
+ +![image](../assets/mongodb_atlas/MongoDB_Asset-3.png) + + +5) Add your IP address (if it hasn't been added already), if you have a dynamic ip add your whole subnet. Once done, click on `Finish and close` + +![image](../assets/mongodb_atlas/MongoDB_Asset-4.png) + +The cluster is now created and ready for use with Turingbot. + +# Connecting to the DB Cluster + +1) Click on `Connect`
+ +![image](../assets/mongodb_atlas/MongoDB_Asset-5.png) + +2) Click on `Shell`, the third step now contains all necessary information to proceed. Copy the value in the quotation marks exclkuding the protocol (`mongodb+src://`) + +![image](../assets/mongodb_atlas/MongoDB_Asset-6.png) + +3) We are now done with the webpage setup, you can now open the bot config up and fill the info in accordingly: + +```jsonc + "mongodb": { + "protocol": "mongodb+srv://", + "address": "", + "username": "", + "password": "" + }, +``` + +You can now start the bot and use MongoDB normally. + + +[//]: # (All credentials used in this guide have been invalidated before pushing.) diff --git a/package-lock.json b/package-lock.json index 84675ca..05babce 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,5 +1,5 @@ { - "name": "turingbot", + "name": "TuringBot", "version": "0.1.0", "lockfileVersion": 3, "requires": true,