Quickstart

How to download, install and run in any environment.

Prerequisites

Before we get started, let’s make sure you meet these following requirements:

  • Counter-Strike 2 Server:
  • Panel: one of the options below
    • - Linux VPS
    • - Pterodactyl Panel and Wings installed

Downloading the plugin

First, you need to install and configuring the plugin on your cs2 servers.
You can download the plugin from the following link
Place the plugin in the game/csgo/addons/counterstrikesharp/plugins folder
Navigate to your addons/counterstrikesharp/configs/plugins/CSS-Panel directory and edit the CSS-Panel.json file with the following settings

Downloading & Installing the panel

Choose the best way to run the panel on your server, you can choose between running the panel on Docker, linux machine with node.js, or Vercel (for free).
Why not web hosting?
Since the panel is made with next.js and uses server-side rendering and also a fully functional back-end along with the panel, it's not possible to run the panel on web hosting, as web hosting only supports static websites (.html, .css, .js, etc. files)

- Option 1: Running the panel on Easypanel (Recommended)

This is the most recommended way to run the panel, as it's the easiest and fastest way to get the panel up and running without much effort, and also connect it to a domain or subdomain with ssl easily.

Requirements:
- Linux VPS with Easypanel installed.

1. Create a new Project on Easypanel.
2. Create a new App (App service), name it whatever you want.
3. In the "Source" tab, set the following settings:
- Owner: ShiNxz
- Repository: CSS-Panel
- Branch: main
- Build path: /
(note that you should use this configuration in order to keep your panel up to date and follow our updates)

4. Hit Save.
5. In the "Build" section, select "Nixpacks" and hit "Save".
6. Head over to the "Environment" tab and add the following environment variables, and edit them accordingly.
7. Head over to "Domains" and add your domain or subdomain.
8. Hit "Deploy" and wait for the deployment to finish.

Important Notes:
- On every new release, please click on "Deploy" to update the panel to the latest version.
- You can also add a custom domain or subdomain with SSL easily from the "Domains" tab.

- Option 2: Running the panel on Vercel (Free)

This is also a recommended way to run the panel, as it's very easy and also free, and also connect it to a domain or subdomain with ssl easily.

Requirements:
- Account on Vercel

1. Head over to the import page on Vercel.
2. Click on the "Import Third-Party Git Repository →" option below the repository list.
3. Enter the following repository URL: 

$ https://github.com/ShiNxz/CSS-Panel

4. Hit "Continue" and choose the name for your project and repository.
5. Wait for the deployment to finish.
6. The deployment will fail and thats ok, head over to the dashboard and click on the project.
7. Click on "Add Domain" and add your domain or subdomain.
8. Head over to the "Environment Variables" tab and add the following environment variables one by one, and edit them accordingly.
8. Head over to the "Project" tab, click on "Build Logs", click on the 3 dots (options) and click on "Redeploy".

Important Notes:
- Vercel will fork the repository to your account as a new repository, it means that you will have to keep the panel up to date manually by pulling the latest changes from the original repository, and Vercel will deploy it automatically.

- Option 3: Installing the panel (Manual)

* Make sure you have node.js installed on your server / pc.
* Make sure you have pnpm installed on your server / pc.

1. After downloading the panel, navigate to the panel directory and install the dependencies using the following command:

$ pnpm install


2. Edit the .env.example file and add your database credentials and Steam API key, then rename it to .env
3. Build the panel using the following command:
$ pnpm build


4. Start the panel using the following command:
$ pnpm start


The panel should now be running on http://localhost:3000
- note that localhost is your pc/linux ip, if you want to run the panel on your server, you should use your server ip instead of localhost.

Notes

* The panel should log into your db and create the necessary tables on the first run, if it didn't, make sure your db credentials are correct.
* The panel should pull all the admin users from your SimpleAdmin db, you can login into the panel using steam if you're an admin,
and you can also add more admins from the panel.

Next Steps

Configuration