Skip to content

Commit

Permalink
Merge pull request #15 from Vxrpenter/main
Browse files Browse the repository at this point in the history
Instance creation + Account creation
  • Loading branch information
ced777ric authored Dec 9, 2024
2 parents 0ca30d8 + 426bea5 commit f2cf001
Show file tree
Hide file tree
Showing 9 changed files with 200 additions and 16 deletions.
24 changes: 24 additions & 0 deletions docs/account/create/discord.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Discord Account
parent: Create
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
6 changes: 6 additions & 0 deletions docs/account/create/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Create
parent: Account
layout: default
has_children: true
---
31 changes: 31 additions & 0 deletions docs/account/create/register.md
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 12 additions & 0 deletions docs/account/index.md
Original file line number Diff line number Diff line change
@@ -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 }
5 changes: 3 additions & 2 deletions docs/errorhandling/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 }
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 }
120 changes: 119 additions & 1 deletion docs/setup/instance/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,125 @@
title: Create Instance
parent: Instance
grand_parent: Setup
nav_order: 1
layout: default
---

Create
# 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:

<dl>
<dt>Europe</dt>
<dd>Germany Panel</dd>
<dt>America</dt>
<dd>Canada Panel</dd>
<dt>Asia</dt>
<dd>Germany Panel</dd>
</dl>

## Basic Setup

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.

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 `<cedmod_activation_key>` with your key

```console
$~ setupcedmod <cedmod_activation_key>
```
8 changes: 0 additions & 8 deletions docs/setup/instance/sync.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/usage/index.md
Original file line number Diff line number Diff line change
@@ -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 }
4 changes: 2 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit f2cf001

Please sign in to comment.