refactor: rename github workflow for panel

codinglab-io · Sep 23, 2024 · 486fa15 · 486fa15
1 parent 59544a7
commit 486fa15
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 37 deletions.
diff --git a/.github/workflows/create-user.yml → .github/workflows/panel-create-user.yml b/.github/workflows/create-user.yml → .github/workflows/panel-create-user.yml
@@ -49,7 +49,6 @@ jobs:
           ssh_cert: ${{ secrets.CODINGLABGG_SSH_CERT }}
 
       - name: '`docker compose run php artisan p:user:mak` on the production server'
-        working-directory: .
         run: docker --context prod-server compose run --rm panel php artisan p:user:make \
         --username=${{ github.event.inputs.username }} \
         --password=${{ github.event.inputs.password }} \

diff --git a/.github/workflows/deployment.yml → .github/workflows/panel-deployment.yml b/.github/workflows/deployment.yml → .github/workflows/panel-deployment.yml
@@ -12,7 +12,7 @@ jobs:
         working-directory: ./pterodactyl/panel
 
     environment:
-      name: production
+      name: panel-prod
       url: https://codinglab.gg
 
     steps:

diff --git a/.github/workflows/remove-user.yml b/.github/workflows/remove-user.yml
diff --git a/README.md b/README.md
@@ -4,5 +4,23 @@
 
 **What to find here ?**
 
-- A pterodactyl dashboard panel to manage all game-servers
-- Game servers docker images that we use to play
+- A pterodactyl dashboard panel to manage all game-servers.
+- Game servers docker images that we use to play.
+- Custom plugins and configurations for games we play.
+
+## How to setup the pterodactyl panel
+
+Open your github secrets and add the following:
+
+- `CODINGLABGG_SSH_KEY` : The private key to connect to the server
+- `CODINGLABGG_SSH_USER` : The user used to connect to the server (`pterodactyl`)
+- `CODINGLABGG_SSH_HOST` : The host/ip of the server (`codinglab.gg`)
+- `CODINGLABGG_SSH_CERT` : The public certificate of the server (`ssh-keyscan codinglab.gg`)
+
+Then push to the repository, [the github `panel-deployment.yml` action](./.github/workflows/panel-deployment.yml) will deploy the panel to the server.
+
+## How to setup a fresh game server
+
+The panel and the game server are different entities. The panel is the dashboard to manage the game servers. The game servers are the actual servers where the games are running.
+
+To setup a fresh game server, you need to run the wings agent on the server. The wings agent is the software that connects the game server to the panel.