Skip to content

Commit 91e2306

Browse files
committed
docs: READMEs
1 parent d5b0e0c commit 91e2306

File tree

3 files changed

+40
-34
lines changed

3 files changed

+40
-34
lines changed

README.md

Lines changed: 5 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,11 @@
11
# Codinglab.gg
22

3-
### Basically codinglab gaming related projects.
3+
### codinglab gaming related projects.
4+
5+
Primarely made to be integrated with [codinglab dokploy panel](dock.codinglab.io).
46

57
**What to find here ?**
68

9+
- A website (using NextJS) with a list of all the game servers.
710
- A pterodactyl dashboard panel to manage all game-servers.
8-
- Game servers docker images that we use to play.
9-
- Custom plugins and configurations for games we play.
10-
11-
## How to setup the pterodactyl panel
12-
13-
Fork this repo.
14-
Open your github repo secrets and add the following:
15-
16-
- `CODINGLABGG_SSH_KEY` : The private key to connect to the server
17-
- `CODINGLABGG_SSH_USER` : The user used to connect to the server (`pterodactyl`)
18-
- `CODINGLABGG_SSH_HOST` : The host/ip of the serve that run the panel (`codinglab.gg`)
19-
- `CODINGLABGG_SSH_CERT` : The public certificate of the server (`ssh-keyscan codinglab.gg`)
20-
21-
Make sure your server is setup with docker and docker compose plugin, and your user can run docker commands.
22-
23-
Then push to the repository, [the github `panel-deployment.yml` action](./.github/workflows/panel-deployment.yml) will deploy the panel to the server.
24-
25-
Now you should be able to access the panel at your desired domain, under https.
26-
27-
You still have to create your first user (admin) tho.
28-
To do so, go into your github repo > actions > panel-create-user.yml > run workflow > and fill this form :
29-
![image](docs/pterodactyl/panel-create-user-workflow.png)
30-
31-
## How to setup a fresh game server
32-
33-
First you need to create a Location, then a Node in the panel.
34-
35-
Click on `Nodes` > `Create New` > Fill the form with the server's informations.
36-
37-
Then you need to copy the Node Configuration `config.yml` from the panel.
38-
39-
To setup a fresh game server, you need to run the wings agent on the server.
40-
The wings agent is the software that connects the game server to the panel.
11+
- Docker images for game servers along with our mods / config.
-66.2 KB
Binary file not shown.

pterodactyl/README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Pterodactyl
2+
3+
Configuration files to deploy a pterodactyl panel and game servers.
4+
5+
## How to setup the pterodactyl panel
6+
7+
Open your github repo secrets and add the following:
8+
9+
Make sure your server is setup with docker and docker compose plugin, and your user can run docker commands.
10+
11+
run `docker-compose up -d` to start the panel.
12+
13+
You have to create your first user (admin) tho.
14+
To do so, go into your github repo > actions > panel-create-user.yml > run workflow > and fill this form :
15+
![image](docs/pterodactyl/panel-create-user-workflow.png)
16+
17+
## How to setup a fresh game server
18+
19+
First you need to create a Location, then a Node in the panel.
20+
21+
Click on `Nodes` > `Create New` > Fill the form with the server's informations.
22+
23+
Then you need to copy the Node Configuration `config.yml` from the panel.
24+
25+
To setup a fresh game server, you need to run the wings agent on the server.
26+
The wings agent is the software that connects the game server to the panel.
27+
28+
```bash
29+
cd wings;
30+
cp .env.template .env;
31+
# edit the .env file with your informations
32+
docker compose up -d
33+
```
34+
35+
Then you need to edit the `config.yml` file and replace the `token` with the one you got from the panel.

0 commit comments

Comments
 (0)