From 01ee7388b67f28bdf3f6e44c6fa222db51f64284 Mon Sep 17 00:00:00 2001 From: vxrpenter Date: Mon, 9 Dec 2024 13:12:53 +0100 Subject: [PATCH 1/9] Fixed switched pages --- docs/errorhandling/index.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/errorhandling/index.md b/docs/errorhandling/index.md index 58e8fc7..39d24b5 100644 --- a/docs/errorhandling/index.md +++ b/docs/errorhandling/index.md @@ -8,5 +8,6 @@ has_children: true # Error Handling {: .fs-9 } -CedMod has many features that need some explanation on how to use them -{: .fs-6 .fw-300 } \ No newline at end of file +Sometimes problems can arise when using cedmod. +The following pages explain how to handle known errors and how to report unknown ones +{: .fs-6 .fw-300 } From feed3e255171fe0c22a661013689fb38c2d3a7a0 Mon Sep 17 00:00:00 2001 From: vxrpenter Date: Mon, 9 Dec 2024 13:12:53 +0100 Subject: [PATCH 2/9] Fixed switched pages --- docs/usage/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/usage/index.md b/docs/usage/index.md index 46624fb..9bfe158 100644 --- a/docs/usage/index.md +++ b/docs/usage/index.md @@ -1,12 +1,12 @@ --- title: Usage layout: default -nav_order: 3 +nav_order: 4 has_children: true --- -# Error Handling +# Usage {: .fs-9 } -Sometimes problems can arise when using cedmod. The following pages explain how to handle known errors and how to report unknown ones +CedMod has many features that need some explanation on how to use them {: .fs-6 .fw-300 } \ No newline at end of file From 2b8c9071fdcc05bf4c4a2fde5399cd322d8f715a Mon Sep 17 00:00:00 2001 From: vxrpenter Date: Mon, 9 Dec 2024 13:15:43 +0100 Subject: [PATCH 3/9] Account page --- docs/account/index.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/account/index.md diff --git a/docs/account/index.md b/docs/account/index.md new file mode 100644 index 0000000..d489e23 --- /dev/null +++ b/docs/account/index.md @@ -0,0 +1,12 @@ +--- +title: Account +layout: default +nav_order: 3 +has_children: true +--- + +# Account Management +{: .fs-9 } + +The following guides explain how to create/manage a CedMod account +{: .fs-6 .fw-300 } \ No newline at end of file From 3df2a53237ab7cdbaaa90111c35f46c473801be4 Mon Sep 17 00:00:00 2001 From: vxrpenter Date: Mon, 9 Dec 2024 13:21:09 +0100 Subject: [PATCH 4/9] Account create pages --- docs/account/create/create.md | 6 ++++++ docs/account/create/index.md | 6 ++++++ 2 files changed, 12 insertions(+) create mode 100644 docs/account/create/create.md create mode 100644 docs/account/create/index.md diff --git a/docs/account/create/create.md b/docs/account/create/create.md new file mode 100644 index 0000000..5698fb2 --- /dev/null +++ b/docs/account/create/create.md @@ -0,0 +1,6 @@ +--- +title: Create Account +parent: Create +grand_parent: Account +layout: default +--- diff --git a/docs/account/create/index.md b/docs/account/create/index.md new file mode 100644 index 0000000..84877f2 --- /dev/null +++ b/docs/account/create/index.md @@ -0,0 +1,6 @@ +--- +title: Create +parent: Account +layout: default +has_children: true +--- \ No newline at end of file From 8ff132a19d5e8766fa195de5ab1dd7fbde43298d Mon Sep 17 00:00:00 2001 From: vxrpenter Date: Mon, 9 Dec 2024 13:47:42 +0100 Subject: [PATCH 5/9] Little fix --- docs/account/create/discord.md | 7 +++++++ docs/account/create/{create.md => normal.md} | 1 + 2 files changed, 8 insertions(+) create mode 100644 docs/account/create/discord.md rename docs/account/create/{create.md => normal.md} (86%) diff --git a/docs/account/create/discord.md b/docs/account/create/discord.md new file mode 100644 index 0000000..5f7ff87 --- /dev/null +++ b/docs/account/create/discord.md @@ -0,0 +1,7 @@ +--- +title: Discord Account +parent: Create +grand_parent: Account +nav_order: 1 +layout: default +--- diff --git a/docs/account/create/create.md b/docs/account/create/normal.md similarity index 86% rename from docs/account/create/create.md rename to docs/account/create/normal.md index 5698fb2..839c1c3 100644 --- a/docs/account/create/create.md +++ b/docs/account/create/normal.md @@ -2,5 +2,6 @@ title: Create Account parent: Create grand_parent: Account +nav_order: 2 layout: default --- From 9e68962caa59441852e5ae71c809c33d985d430e Mon Sep 17 00:00:00 2001 From: vxrpenter Date: Mon, 9 Dec 2024 13:49:21 +0100 Subject: [PATCH 6/9] Fixed links --- index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/index.md b/index.md index 2f310d9..8a1a927 100644 --- a/index.md +++ b/index.md @@ -31,11 +31,11 @@ To get started with CedMod, either install the exiled or nwapi version from the [release tab](https://github.com/CedModV2/CedMod/releases) {: .note } -For a more complete and comprehensive installation guide, follow the [setup guide](https://docs.cedmod.nl/docs/Setup/) +For a more complete and comprehensive installation guide, follow the [setup guide](https://docs.cedmod.nl/docs/setup/) After installation, you have to create an instance on the [panel](https://cedmod.nl/Servers/Create). If you want to view a more complete installation guide, -go to [the instance creation guide](https://docs.cedmod.nl/docs/Setup/Instance/) +go to [the instance creation guide](https://docs.cedmod.nl/docs/setup/instance/) ## About CedMod CedMod, All Rights Reserved by [ced777ric](https://github.com/ced777ric) From 361e530c922f19a8e9b3760821b36dcd9f7fb9e4 Mon Sep 17 00:00:00 2001 From: vxrpenter Date: Mon, 9 Dec 2024 15:03:39 +0100 Subject: [PATCH 7/9] Create instance page --- docs/setup/instance/create.md | 107 +++++++++++++++++++++++++++++++++- 1 file changed, 106 insertions(+), 1 deletion(-) diff --git a/docs/setup/instance/create.md b/docs/setup/instance/create.md index 2c06b45..c5eca0d 100644 --- a/docs/setup/instance/create.md +++ b/docs/setup/instance/create.md @@ -2,7 +2,112 @@ title: Create Instance parent: Instance grand_parent: Setup +nav_order: 1 layout: default --- -Create \ No newline at end of file +# Create Instance +{: .no_toc } + +--- + +## Table of Contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +{: .attention} +You need to create an account before creating a CedMod instance. Following the [account creation guide](), if you haven't already + +## Choose Server + +When creating, a CedMod instance, you have to choose a linking discord server. +Only servers that have the CedMod bot on it will be shown, +add it +using [this link](https://discord.com/oauth2/authorize?client_id=749684016550248490&permissions=536870912&scope=bot). +After adding the bot, you can then select the server on the panel and proceed with the instance creation. + +{: .note} +After adding the bot to your server, it can take a few minutes until the server shows up on the panel + +## Set Panel Location + +After selecting your server, you will be prompted with an option to choose a panel location. +Here you should choose the location that is the nearest to your server's location/your playerbase. + +You have the choice between **Germany** and **Canada**. +We would encourage you to use the following location, +depending on your server location: + +
+
Europe
+
Germany Panel
+
America
+
Canada Panel
+
Asia
+
Germany Panel
+
+ +## Basic Setup + +Now you need to choose your top domain. +Currently, CedMod only supports the `yourinstance.cmod.app` domain. +If you want to use a custom domain, contact CedMod support. + +After defining the top domain, you need to name your instance. +This name will replace the `yourinstance` part in the top domain and be displayed on the instance's panel page as well. + +Then you'll be asked to set the default admin role. +Make sure that you select the correct role as panel administrator access is really powerful. + +At last, you can disable/enable certain features. +You can activate them later after the setup if you change your mind. + +- [x] Enable AntiVPN? +- [x] Disable IP Bans for Ip addresses used for Cloud Gaming +- [x] Log Panel Actions + +### AntiVPN +The AntiVpn will prevent anyone who is not allowlisted from it from joining your server. +The AntiVpn can protect against people trying to evade bans using Alt accounts and VPNS. +Players who get kicked for using Cloud gaming +or have to use a vpn for legitimate reasons can request a whitelist using the link in the kick message. + +### Disable IP Bans for Cloud gaming +When this option is enabled, +Players that use Cloud gaming will not get kicked when there is an Ip ban on the ip of that cloud gaming server. +As cloud gaming Ip addresses are shared, commonly players may get kicked if ip bans are enabled for cloud gaming. +It is recommended to leave this option on for the best player experience. + +### Log Panel Actions +If enabled, Bans, Mutes and Warns will be logged to the webhooks defined below. + +## Webhook Setup + +Here you can define the channels specific types of logs are sent to. +The options are explained below the category, +you can also set all logs to a single channel + +| Webhook | Definition | +|:----------------------|:--------------------------------------------------------------------------------------------------| +| `WebhookGeneralUse` | All logs that do not belong to a specific category will be sent here, e.g., important information | +| `WebhookBans` | All analogs will be sent here | +| `WebhookBanJoinKicks` | All ban join kicks will be sent here (players that are banned trying to join the server) | +| `WebhookUnbans` | All unbans will be sent here | +| `WebhookWarns` | All warns will be sent here | +| `WebhookMutes` | All mutes will be sent here | +| `WebhookUnmutes` | All unmutes will be sent here | +| `WebhookAntiVpn` | All AntiVPN kicks will be sent here (if feature is enabled) | + +## Link Instance to Server + +{: .attention} +DO NOT share your activation key with anyone + +After creating the instance, you need to paste a command similar to this into your server console. +Make sure to replace `` with your key + +```console +$~ setupcedmod +``` \ No newline at end of file From 5b2d867d8934d3eba67e93b43d34822e397b9df1 Mon Sep 17 00:00:00 2001 From: vxrpenter Date: Mon, 9 Dec 2024 15:15:55 +0100 Subject: [PATCH 8/9] Register pages --- docs/account/create/discord.md | 17 +++++++++++++++++ docs/account/create/normal.md | 7 ------- docs/account/create/register.md | 31 +++++++++++++++++++++++++++++++ 3 files changed, 48 insertions(+), 7 deletions(-) delete mode 100644 docs/account/create/normal.md create mode 100644 docs/account/create/register.md diff --git a/docs/account/create/discord.md b/docs/account/create/discord.md index 5f7ff87..7ce90c4 100644 --- a/docs/account/create/discord.md +++ b/docs/account/create/discord.md @@ -5,3 +5,20 @@ grand_parent: Account nav_order: 1 layout: default --- + +# Sign in with Discord +{: .no_toc } + +[Create Cedmod Account](https://accounts.cedmod.nl/Auth/Register){: .btn .btn-primary .fs-5 .mr-2 } + +--- + +## Table of Contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +## Register +Click on the `Sign in with Discord` button on the register page. +After that, follow the instructions and you're done \ No newline at end of file diff --git a/docs/account/create/normal.md b/docs/account/create/normal.md deleted file mode 100644 index 839c1c3..0000000 --- a/docs/account/create/normal.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Create Account -parent: Create -grand_parent: Account -nav_order: 2 -layout: default ---- diff --git a/docs/account/create/register.md b/docs/account/create/register.md new file mode 100644 index 0000000..f29701f --- /dev/null +++ b/docs/account/create/register.md @@ -0,0 +1,31 @@ +--- +title: Create Account +parent: Create +grand_parent: Account +nav_order: 2 +layout: default +--- + +# Create Account +{: .no_toc } + +[Create Cedmod Account](https://accounts.cedmod.nl/Auth/Register){: .btn .btn-primary .fs-5 .mr-2 } + +--- + +## Table of Contents +{: .no_toc .text-delta } + +1. TOC +{:toc} + +## Register + +To register, you have to enter the following information: + +- Username - `Good username that follows Terms of Service` +- Password - `Secure password to protect your account` + +{: .attention } +CedMod does not support E-MAIL accounts and won't be in the future. +To secure your account, you can activate 2FA Authentication in your account settings. \ No newline at end of file From 426bea5dc64b57a2ee363af2947b6b56fa1c2bd6 Mon Sep 17 00:00:00 2001 From: vxrpenter Date: Mon, 9 Dec 2024 17:13:40 +0100 Subject: [PATCH 9/9] Custom domain update --- docs/setup/instance/create.md | 13 +++++++++++++ docs/setup/instance/sync.md | 8 -------- 2 files changed, 13 insertions(+), 8 deletions(-) delete mode 100644 docs/setup/instance/sync.md diff --git a/docs/setup/instance/create.md b/docs/setup/instance/create.md index c5eca0d..49f7314 100644 --- a/docs/setup/instance/create.md +++ b/docs/setup/instance/create.md @@ -53,8 +53,21 @@ depending on your server location: Now you need to choose your top domain. Currently, CedMod only supports the `yourinstance.cmod.app` domain. + +--- + +Deprecated +{: .label .label-red } + If you want to use a custom domain, contact CedMod support. +New +{: .label .label-green } + +You are now able to go to the custom domains page after creating your instance to use a custom domain + +--- + After defining the top domain, you need to name your instance. This name will replace the `yourinstance` part in the top domain and be displayed on the instance's panel page as well. diff --git a/docs/setup/instance/sync.md b/docs/setup/instance/sync.md deleted file mode 100644 index 7c3315d..0000000 --- a/docs/setup/instance/sync.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Sync Instance -parent: Instance -grand_parent: Setup -layout: default ---- - -Sync \ No newline at end of file