Skip to content

Commit f2cf001

Browse files
ced777ricced777ric
authored
Merge pull request #15 from Vxrpenter/main
Instance creation + Account creation
2 parents 0ca30d8 + 426bea5 commit f2cf001

File tree

9 files changed

+200
-16
lines changed

9 files changed

+200
-16
lines changed

‎docs/account/create/discord.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Discord Account
3+
parent: Create
4+
grand_parent: Account
5+
nav_order: 1
6+
layout: default
7+
---
8+
9+
# Sign in with Discord
10+
{: .no_toc }
11+
12+
[Create Cedmod Account](https://accounts.cedmod.nl/Auth/Register){: .btn .btn-primary .fs-5 .mr-2 }
13+
14+
---
15+
16+
## Table of Contents
17+
{: .no_toc .text-delta }
18+
19+
1. TOC
20+
{:toc}
21+
22+
## Register
23+
Click on the `Sign in with Discord` button on the register page.
24+
After that, follow the instructions and you're done

‎docs/account/create/index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Create
3+
parent: Account
4+
layout: default
5+
has_children: true
6+
---

‎docs/account/create/register.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Create Account
3+
parent: Create
4+
grand_parent: Account
5+
nav_order: 2
6+
layout: default
7+
---
8+
9+
# Create Account
10+
{: .no_toc }
11+
12+
[Create Cedmod Account](https://accounts.cedmod.nl/Auth/Register){: .btn .btn-primary .fs-5 .mr-2 }
13+
14+
---
15+
16+
## Table of Contents
17+
{: .no_toc .text-delta }
18+
19+
1. TOC
20+
{:toc}
21+
22+
## Register
23+
24+
To register, you have to enter the following information:
25+
26+
- Username - `Good username that follows Terms of Service`
27+
- Password - `Secure password to protect your account`
28+
29+
{: .attention }
30+
CedMod does not support E-MAIL accounts and won't be in the future.
31+
To secure your account, you can activate 2FA Authentication in your account settings.

‎docs/account/index.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Account
3+
layout: default
4+
nav_order: 3
5+
has_children: true
6+
---
7+
8+
# Account Management
9+
{: .fs-9 }
10+
11+
The following guides explain how to create/manage a CedMod account
12+
{: .fs-6 .fw-300 }

‎docs/errorhandling/index.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ has_children: true
88
# Error Handling
99
{: .fs-9 }
1010

11-
CedMod has many features that need some explanation on how to use them
12-
{: .fs-6 .fw-300 }
11+
Sometimes problems can arise when using cedmod.
12+
The following pages explain how to handle known errors and how to report unknown ones
13+
{: .fs-6 .fw-300 }

‎docs/setup/instance/create.md‎

Lines changed: 119 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,125 @@
22
title: Create Instance
33
parent: Instance
44
grand_parent: Setup
5+
nav_order: 1
56
layout: default
67
---
78

8-
Create
9+
# Create Instance
10+
{: .no_toc }
11+
12+
---
13+
14+
## Table of Contents
15+
{: .no_toc .text-delta }
16+
17+
1. TOC
18+
{:toc}
19+
20+
{: .attention}
21+
You need to create an account before creating a CedMod instance. Following the [account creation guide](), if you haven't already
22+
23+
## Choose Server
24+
25+
When creating, a CedMod instance, you have to choose a linking discord server.
26+
Only servers that have the CedMod bot on it will be shown,
27+
add it
28+
using [this link](https://discord.com/oauth2/authorize?client_id=749684016550248490&permissions=536870912&scope=bot).
29+
After adding the bot, you can then select the server on the panel and proceed with the instance creation.
30+
31+
{: .note}
32+
After adding the bot to your server, it can take a few minutes until the server shows up on the panel
33+
34+
## Set Panel Location
35+
36+
After selecting your server, you will be prompted with an option to choose a panel location.
37+
Here you should choose the location that is the nearest to your server's location/your playerbase.
38+
39+
You have the choice between **Germany** and **Canada**.
40+
We would encourage you to use the following location,
41+
depending on your server location:
42+
43+
<dl>
44+
<dt>Europe</dt>
45+
<dd>Germany Panel</dd>
46+
<dt>America</dt>
47+
<dd>Canada Panel</dd>
48+
<dt>Asia</dt>
49+
<dd>Germany Panel</dd>
50+
</dl>
51+
52+
## Basic Setup
53+
54+
Now you need to choose your top domain.
55+
Currently, CedMod only supports the `yourinstance.cmod.app` domain.
56+
57+
---
58+
59+
Deprecated
60+
{: .label .label-red }
61+
62+
If you want to use a custom domain, contact CedMod support.
63+
64+
New
65+
{: .label .label-green }
66+
67+
You are now able to go to the custom domains page after creating your instance to use a custom domain
68+
69+
---
70+
71+
After defining the top domain, you need to name your instance.
72+
This name will replace the `yourinstance` part in the top domain and be displayed on the instance's panel page as well.
73+
74+
Then you'll be asked to set the default admin role.
75+
Make sure that you select the correct role as panel administrator access is really powerful.
76+
77+
At last, you can disable/enable certain features.
78+
You can activate them later after the setup if you change your mind.
79+
80+
- [x] Enable AntiVPN?
81+
- [x] Disable IP Bans for Ip addresses used for Cloud Gaming
82+
- [x] Log Panel Actions
83+
84+
### AntiVPN
85+
The AntiVpn will prevent anyone who is not allowlisted from it from joining your server.
86+
The AntiVpn can protect against people trying to evade bans using Alt accounts and VPNS.
87+
Players who get kicked for using Cloud gaming
88+
or have to use a vpn for legitimate reasons can request a whitelist using the link in the kick message.
89+
90+
### Disable IP Bans for Cloud gaming
91+
When this option is enabled,
92+
Players that use Cloud gaming will not get kicked when there is an Ip ban on the ip of that cloud gaming server.
93+
As cloud gaming Ip addresses are shared, commonly players may get kicked if ip bans are enabled for cloud gaming.
94+
It is recommended to leave this option on for the best player experience.
95+
96+
### Log Panel Actions
97+
If enabled, Bans, Mutes and Warns will be logged to the webhooks defined below.
98+
99+
## Webhook Setup
100+
101+
Here you can define the channels specific types of logs are sent to.
102+
The options are explained below the category,
103+
you can also set all logs to a single channel
104+
105+
| Webhook | Definition |
106+
|:----------------------|:--------------------------------------------------------------------------------------------------|
107+
| `WebhookGeneralUse` | All logs that do not belong to a specific category will be sent here, e.g., important information |
108+
| `WebhookBans` | All analogs will be sent here |
109+
| `WebhookBanJoinKicks` | All ban join kicks will be sent here (players that are banned trying to join the server) |
110+
| `WebhookUnbans` | All unbans will be sent here |
111+
| `WebhookWarns` | All warns will be sent here |
112+
| `WebhookMutes` | All mutes will be sent here |
113+
| `WebhookUnmutes` | All unmutes will be sent here |
114+
| `WebhookAntiVpn` | All AntiVPN kicks will be sent here (if feature is enabled) |
115+
116+
## Link Instance to Server
117+
118+
{: .attention}
119+
DO NOT share your activation key with anyone
120+
121+
After creating the instance, you need to paste a command similar to this into your server console.
122+
Make sure to replace `<cedmod_activation_key>` with your key
123+
124+
```console
125+
$~ setupcedmod <cedmod_activation_key>
126+
```

‎docs/setup/instance/sync.md‎

Lines changed: 0 additions & 8 deletions
This file was deleted.

‎docs/usage/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: Usage
33
layout: default
4-
nav_order: 3
4+
nav_order: 4
55
has_children: true
66
---
77

8-
# Error Handling
8+
# Usage
99
{: .fs-9 }
1010

11-
Sometimes problems can arise when using cedmod. The following pages explain how to handle known errors and how to report unknown ones
11+
CedMod has many features that need some explanation on how to use them
1212
{: .fs-6 .fw-300 }

‎index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ To get started with CedMod,
3131
either install the exiled or nwapi version from the [release tab](https://github.com/CedModV2/CedMod/releases)
3232

3333
{: .note }
34-
For a more complete and comprehensive installation guide, follow the [setup guide](https://docs.cedmod.nl/docs/Setup/)
34+
For a more complete and comprehensive installation guide, follow the [setup guide](https://docs.cedmod.nl/docs/setup/)
3535

3636
After installation, you have to create an instance on the [panel](https://cedmod.nl/Servers/Create).
3737
If you want to view a more complete installation guide,
38-
go to [the instance creation guide](https://docs.cedmod.nl/docs/Setup/Instance/)
38+
go to [the instance creation guide](https://docs.cedmod.nl/docs/setup/instance/)
3939

4040
## About CedMod
4141
CedMod, All Rights Reserved by [ced777ric](https://github.com/ced777ric)

0 commit comments

Comments
 (0)