Finally updated docs after a 3 months

content/Ellie/Guides/docker-guide.md

@@ -0,0 +1,100 @@
++++
+title = "Docker Guide"
+description = "How to set up EllieBot with Docker"
+weight = 6
++++
+
+
+### Prerequisites
+
+- [Docker Core Engine](https://docs.docker.com/engine/install/)
+- [Docker Compose](https://docs.docker.com/compose/install/) (optional, but recommended)
+
+## Installing EllieBot with Docker
+
+When deploying EllieBot with Docker, you have two options: using Docker or Docker Compose. The following sections provide step-by-step instructions for both methods.
+{{<tabs title="Guides.">}}
+{{% tab title="Docker" %}}
+### Deploying EllieBot with Docker
+
+1. Move to a directory where you want your Elliebot's data folder to be (data folder will keep the database and config files) and create a data folder there.
+    ``` sh
+    cd ~ && mkdir ellie && cd ellie && mkdir data
+    ```
+2. Mount the newly created empty data folder as a volume while starting your docker container. Replace YOUR_TOKEN_HERE with the bot token obtained from the creds guide above.
+    ``` sh
+    docker run -d --name ellie toastielab.dev/elliebotdevs/elliebot:v6 -e bot_token=YOUR_TOKEN_HERE -v "./data:/app/data" && docker logs -f --tail 500 ellie
+    ```
+3. Enjoy! 🎉
+
+### Updating your bot
+
+If you want to update elliebot to the latest version, all you have to do is pull the latest image and re-run.
+
+1. Pull the latest image
+    ``` sh
+    docker pull toastielab.dev/elliebotdevs/elliebot:v6
+    ```
+2. Re-run your bot the same way you did before
+    ``` sh
+    docker run -d --name ellie toastielab.dev/elliebotdevs/elliebot:v6 -e bot_token=YOUR_TOKEN_HERE -v "./data:/app/data" && docker logs -f --tail 500 ellie
+    ```
+3. Done! 🎉
+{{% /tab %}}
+{{% tab title="Docker Compose" %}}
+1. **Choose Your Workspace:** Select a directory where you'll set up your EllieBot stack. Use your terminal to navigate to this directory. For the purpose of this guide, we'll use `/opt/stacks/ellie/` as an example, but you can choose any directory that suits your needs.
+2. **Create a Docker Compose File:** In this directory, create a Docker Compose file named `docker-compose.yml`. You can use any text editor for this task. For instance, to use the `nano` editor, type `nano docker-compose.yml`.
+3. **Configure Your Docker Compose File:** Populate your Docker Compose file with the following configuration:
+    ``` yml
+    services:
+      ellie:
+        image: toastielab.dev/elliebotdevs/elliebot:v6
+        container_name: ellie
+        restart: unless-stopped
+        environment:
+          TZ: Europe/Rome # Modify this to your timezone
+          bot_token: YOUR_TOKEN_HERE
+        volumes:
+          - /opt/stacks/ellie/data:/app/data
+    networks: {}
+    ```
+
+1. **Launch Your Bot:** Now, you're ready to run Docker Compose. Use the following command: `docker compose up -d`.
+2. **Navigate to Your Directory:** Use `cd /opt/stacks/ellie/` to go to the directory containing your Docker Compose file.
+3. **Pull the Latest Images:** Use `docker compose pull` to fetch the latest images.
+4. **Restart Your Containers:** Use `docker compose up -d` to restart the containers.
+{{% /tab %}}
+{{</tabs>}}
+
+## Creating your own Discord bot
+
+This guide will show you how to create your own discord bot, invite it to your server, and obtain the credentials needed to run it.
+
+1. Go to [the Discord developer application page][Discord].
+2. Log in with your Discord account.
+3. Click **New Application**.
+4. Fill out the `Name` field however you like, accept the terms, and confirm.
+5. Go to the **Bot** tab on the left sidebar.
+6. Click on the `Add a Bot` button and confirm that you do want to add a bot to this app.
+7. **Optional:** Add bot's avatar and description.
+8. Copy your Token to `creds.yml` as shown above.
+9. Scroll down to the **`Privileged Gateway Intents`** section
+    - You MUST enable the following:
+        - **PRESENCE INTENT**
+        - **SERVER MEMBERS INTENT**
+        - **MESSAGE CONTENT INTENT**
+
+### Inviting your bot to your server
+
+![Invite the bot to your server](https://cdn.elliebot.net/bot-invite-guide.gif)
+
+- On the **General Information** tab, copy your `Application ID` from your [applications page][Discord].
+- Replace the `YOUR_CLIENT_ID_HERE` in this link:
+  `https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=66186303` with your `Client ID`
+- The link should now look something like this:
+  `https://discord.com/oauth2/authorize?client_id=123123123123&scope=bot&permissions=66186303`
+- Access that newly created link, pick your Discord server, click `Authorize` and confirm with the captcha at the end
+- The bot should now be in your server
+
+
+[Discord]: https://discord.com/developers/applications/me

content/Ellie/Guides/linux-guide.md

@@ -6,6 +6,12 @@ weight = 4
 
 # Setting up EllieBot on Linux
 
+{{% notice style="note" title="Notice on linux installer" %}}
+~~There is an easier way in the works but this will take time to make, sorry about that. - Toastie~~
+
+This way of installing and using Ellie is nearly ready so keep and eye out for that part of the guide. - Toastie
+{{% /notice %}}
+
 | Table of Contents                                   |
 | :-------------------------------------------------- |
 | [Linux From Source]                                 |
@@ -35,7 +41,7 @@ weight = 4
 
 Follow the following few steps only if you're migrating from v3. If not, skip to installation instructions.
 
-Use the new installer script:  `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v5/linuxAIO.sh && bash linuxAIO.sh`
+Use the new installer script:  `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v6/linuxAIO.sh && bash linuxAIO.sh`
 > - Install prerequisites (type `1` and press `enter`)
 > - Download (type `2` and press `enter`)
 > - Run (type `3` and press `enter`)
@@ -45,7 +51,7 @@ Use the new installer script:  `cd ~ && wget -N https://toastielab.dev/EllieBotD
 
 Open Terminal (if you're on an installation with a window manager) and navigate to the location where you want to install the bot (for example `cd ~`)
 
-1. Download and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v5/linuxAIO.sh && bash linuxAIO.sh`
+1. Download and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v6/linuxAIO.sh && bash linuxAIO.sh`
 2. Install prerequisites (type `1` and press enter)
 3. Download the bot (type `2` and press enter)
 4. Exit the installer (type `6` and press enter)
@@ -57,13 +63,13 @@ Open Terminal (if you're on an installation with a window manager) and navigate
        - `CTRL` + `X`
        - `Y`
        - `Enter`
-8. Run the installer script again `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v5/linuxAIO.sh && bash linuxAIO.sh`
+8. Run the installer script again `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v6/linuxAIO.sh && bash linuxAIO.sh`
 9. Run the bot (type `3` and press enter)
 
 ##### Source Update Instructions
 
 1. ⚠ Stop the bot ⚠
-2. Update and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v5/linuxAIO.sh && bash linuxAIO.sh`
+2. Update and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v6/linuxAIO.sh && bash linuxAIO.sh`
 3. Update the bot (type `2` and press enter)
 4. Run the bot (type `3` and press enter)
 5. 🎉
@@ -368,6 +374,39 @@ If you are running your droplet for the first time, it will most likely ask you
 
 After that, your droplet should be ready for use. [Follow the guide from the beginning](#linux-from-source) to set Ellie up on your newly created VPS.
 
+## Creating your own Discord bot
+
+This guide will show you how to create your own discord bot, invite it to your server, and obtain the credentials needed to run it.
+
+1. Go to [the Discord developer application page][Discord].
+2. Log in with your Discord account.
+3. Click **New Application**.
+4. Fill out the `Name` field however you like, accept the terms, and confirm.
+5. Go to the **Bot** tab on the left sidebar.
+6. Click on the `Add a Bot` button and confirm that you do want to add a bot to this app.
+7. **Optional:** Add bot's avatar and description.
+8. Copy your Token to `creds.yml` as shown above.
+9. Scroll down to the **`Privileged Gateway Intents`** section
+    - You MUST enable the following:
+        - **PRESENCE INTENT**
+        - **SERVER MEMBERS INTENT**
+        - **MESSAGE CONTENT INTENT**
+
+### Inviting your bot to your server
+
+![Invite the bot to your server](https://cdn.elliebot.net/bot-invite-guide.gif)
+
+- On the **General Information** tab, copy your `Application ID` from your [applications page][Discord].
+- Replace the `YOUR_CLIENT_ID_HERE` in this link:
+  `https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=66186303` with your `Client ID`
+- The link should now look something like this:
+  `https://discord.com/oauth2/authorize?client_id=123123123123&scope=bot&permissions=66186303`
+- Access that newly created link, pick your Discord server, click `Authorize` and confirm with the captcha at the end
+- The bot should now be in your server
+
+
+[Discord]: https://discord.com/developers/applications/me
+
 [Linux From Source]: #linux-from-source
 [Source Update Instructions]: #source-update-instructions
 [Linux Release]: #linux-release

content/Ellie/Guides/macos-guide.md

@@ -4,6 +4,12 @@ description = "How to set up EllieBot on MacOS"
 weight = 5
 +++
 
+{{% notice style="note" title="Notice on macOS installer" %}}
+~~There is an easier way in the works but this will take time to make, sorry about that. - Toastie~~
+
+This way of installing and using Ellie is nearly ready so keep and eye out for that part of the guide. - Toastie
+{{% /notice %}}
+
 ## MacOS From Source
 
 Open Terminal (if you don't know how to, click on the magnifying glass on the top right corner of your screen and type **Terminal** on the window that pops up) and navigate to the location where you want to install the bot (for example `cd ~`)
@@ -37,7 +43,7 @@ sudo ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
 
 ##### Installation Instructions
 
-1. Download and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v5/linuxAIO.sh && bash linuxAIO.sh`
+1. Download and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v6/linuxAIO.sh && bash linuxAIO.sh`
 2. Install prerequisites (type `1` and press enter)
 3. Download the bot (type `2` and press enter)
 4. Exit the installer in order to set up your `creds.yml`
@@ -55,7 +61,7 @@ sudo ln -s /usr/local/opt/openssl/lib/libssl.1.0.0.dylib /usr/local/lib/
 ##### Update Instructions
 
 1. ⚠ Stop the bot
-2. Update and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v5/linuxAIO.sh && bash linuxAIO.sh`
+2. Update and run the **new** installer script `cd ~ && wget -N https://toastielab.dev/EllieBotDevs/ellie-bash-installer/raw/branch/v6/linuxAIO.sh && bash linuxAIO.sh`
 3. Update the bot (type `2` and press enter)
 4. Run the bot (type `3` and press enter)
 5. 🎉

content/Ellie/Guides/windows-guide.md

@@ -10,6 +10,39 @@ weight = 3
 This way of installing and using Ellie is nearly ready so keep and eye out for that part of the guide. - Toastie
 {{% /notice %}}
 
+## Creating your own Discord bot
+
+This guide will show you how to create your own discord bot, invite it to your server, and obtain the credentials needed to run it.
+
+1. Go to [the Discord developer application page][Discord].
+2. Log in with your Discord account.
+3. Click **New Application**.
+4. Fill out the `Name` field however you like, accept the terms, and confirm.
+5. Go to the **Bot** tab on the left sidebar.
+6. Click on the `Add a Bot` button and confirm that you do want to add a bot to this app.
+7. **Optional:** Add bot's avatar and description.
+8. Copy your Token to `creds.yml` as shown above.
+9. Scroll down to the **`Privileged Gateway Intents`** section
+    - You MUST enable the following:
+        - **PRESENCE INTENT**
+        - **SERVER MEMBERS INTENT**
+        - **MESSAGE CONTENT INTENT**
+
+### Inviting your bot to your server
+
+![Invite the bot to your server](https://cdn.elliebot.net/bot-invite-guide.gif)
+
+- On the **General Information** tab, copy your `Application ID` from your [applications page][Discord].
+- Replace the `YOUR_CLIENT_ID_HERE` in this link:
+  `https://discord.com/oauth2/authorize?client_id=YOUR_CLIENT_ID_HERE&scope=bot&permissions=66186303` with your `Client ID`
+- The link should now look something like this:
+  `https://discord.com/oauth2/authorize?client_id=123123123123&scope=bot&permissions=66186303`
+- Access that newly created link, pick your Discord server, click `Authorize` and confirm with the captcha at the end
+- The bot should now be in your server
+
+
+[Discord]: https://discord.com/developers/applications/me
+
 ### Windows From Source
 
 ##### Prerequisites
@@ -23,7 +56,7 @@ This way of installing and using Ellie is nearly ready so keep and eye out for t
 
 Open PowerShell (press windows button on your keyboard and type powershell, it should show up; alternatively, right click the start menu and select Windows PowerShell), and navigate to the location where you want to install the bot (for example `cd ~/Desktop/`)
 
-1. `git clone https://toastielab.dev/EllieBotDevs/elliebot -b v5 --depth 1`
+1. `git clone https://toastielab.dev/EllieBotDevs/elliebot -b v6 --depth 1`
 2. `cd EllieBot`
 3. `dotnet publish -c Release -o output/ src/EllieBot/`
 4. `cd output`
@@ -41,11 +74,11 @@ Open PowerShell as described above and run the following commands:
   - ⚠️ Make sure you don't have your database, credentials or any other EllieBot folder open in some application, this might prevent some of the steps from executing succesfully
 2. Navigate to your bot's folder, example:
     - `cd ~/Desktop/EllieBot`
-3. Pull the new version, and make sure you're on the v5 branch
+3. Pull the new version, and make sure you're on the v6 branch
-    - *⚠️ the first 3 lines can be omitted if you're already on v5. If you're updating from v4, you must run them*
+    - *⚠️ the first 3 lines can be omitted if you're already on v6. If you're updating from v5, you must run them*
         - `git remote set-branches origin '*'`
         - `git fetch -v --depth=1`
-        - `git checkout v5`
+        - `git checkout v6`
     - `git pull`
     - ⚠️ If this fails, you may want to stash or remove your code changes if you don't know how to resolve merge conflicts
 4. **Backup** old output in case your data is overwritten

content/Ellie/donate.md

@@ -0,0 +1,39 @@
++++
+title = "Ellie Donation Guide"
+description = "Steps on donating to the Ellie bot project"
+weight = 5
++++
+
+# Donate
+
+Ellie is an [open-source project][toastielab], and we rely on your help to develop the bot, pay hosting fees, maintain our website and more.
+Donations go a long way in helping us keep the project alive, and we appreciate every single one of them.
+
+## Perks
+
+Donating to us also gives you the following benefits:
+
+- A hoisted **Patron** role in [Ellie Discord server][discord-server]
+- Access to exclusive **#noticed** text and voice channels
+- **3000 flowers** on the public bot per dollar donated (after fees)
+
+## Patreon
+
+You can set up a monthly pledge on [Patreon][patreon] and support the project's growth, and also get flower rewards for every month you donate!
+
+!!! Note
+    Connect your Discord account on Patreon to receive your flowers automatically
+
+## PayPal
+
+You can also donate to us through [PayPal][paypal] for one-time donations using the button below, or by donating to `toastie@dragonschildstudios.com`.
+
+!!! Note
+    Mention your Discord username or user id in the payment note to receive flower rewards.
+
+[toastielab]: https://toastielab.dev/EllieBotDevs/elliebot
+[discord-server]: https://discord.elliebot.net/
+[patreon]: https://www.patreon.com/elliebot
+[patreon-button]: https://cdn.elliebot.net/patreon.png
+[paypal]: https://paypal.me/toastie_t0ast
+[paypal-button]: https://cdn.elliebot.net/paypal.png

go.mod

@@ -2,4 +2,4 @@ module toastielab.dev/EllieBotDevs/EllieBot-docs
 
 go 1.22.2
 
-require github.com/McShelby/hugo-theme-relearn v0.0.0-20241209175307-bd1f3d343263 // indirect
+require github.com/McShelby/hugo-theme-relearn v0.0.0-20250309220028-9a020e7eadb7 // indirect

go.sum

@@ -2,3 +2,5 @@ github.com/McShelby/hugo-theme-relearn v0.0.0-20240605212028-6f24d34f4442 h1:1Rt
 github.com/McShelby/hugo-theme-relearn v0.0.0-20240605212028-6f24d34f4442/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
 github.com/McShelby/hugo-theme-relearn v0.0.0-20241209175307-bd1f3d343263 h1:sa/39uZBgVjQABKBJY2KySKgCxn6uek3mV2e3vmPxkw=
 github.com/McShelby/hugo-theme-relearn v0.0.0-20241209175307-bd1f3d343263/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20250309220028-9a020e7eadb7 h1:vQ1zyB0rnRdO/hk/A3Pxx4V9Bo7BNcOkzflg68W2SdU=
+github.com/McShelby/hugo-theme-relearn v0.0.0-20250309220028-9a020e7eadb7/go.mod h1:mKQQdxZNIlLvAj8X3tMq+RzntIJSr9z7XdzuMomt0IM=

hugo.toml

@@ -4,8 +4,6 @@ title = 'The documentation site for EllieBot'
 
 [markup]
   [markup.tableOfContents]
-    # Some relatively important headers, like cc triggers, are on level 4;
-    # we want to have those in our table of contents, so we need to set this to 4.
     endLevel = 10
   [markup.goldmark]
     [markup.goldmark.renderer]

layouts/partials/menu-footer.html

@@ -6,7 +6,7 @@
   </style>
 
 <p class="menu-footer">
-  © 2018 - 2024 EllieBotDevs
+  © 2018 - 2025 EllieBotDevs
 </p>
 
   <p class="menu-footer">