Skip to main content
Version: 0.8

Additional Configuration

info

Users, folders and filenames have been renamed from "dashboard" ⇒ "controlpanel". Be aware that the provided commands may not fit your installation. Please change the users, folder and filenames for the commands corresponding to your installation.

Misc Configuration

Discord Auth

Go to https://<your.ctrlpanel.gg>/admin/settings#misc

Setting up Auth
How to get CLIENT_ID and CLIENT_SECRET
for the redirect URI, you have to use YOUR_WEBSITE_URL + /auth/callback (example: https://bitsec.dev/auth/callback)

Adding the Discord Bot
If you would like to automatically force new users to join your Discord server after they have verified, you will need to set up a Discord bot. This can be an already existing Discord bot in your server.

Add your Discord...

  1. Bot to your server and give him the appropriate permissions.
  2. Bot token on the webpage.
  3. Guild ID on the webpage.
  4. Then press the "Submit" button.

That's it! The Dashboard can now use your bot to make API calls to Discord to place new users into your Discord server. Your bot will not come online as we only use it to make API calls when someone verifies, you can still use your bot as you normally would :)

Custom Role Reward
If you would like to give your users a custom role automatically when they verify their Discord account, you have to copy the ID of an existing role from your Discord server and place it on the webpage as well.

reCAPTCHA v2

Go to https://<your.ctrlpanel.gg>/admin/settings#misc

Controlpanel uses visible reCAPTCHA to secure the login page from brute-force attacks. If the login attempt is considered suspicious, users may be required to perform a reCAPTCHA challenge.

You can generate your own keys in the admin console

To add your keys, you need to add them on the webpage.

Manual Mail Configuration

To send out notifications and mails, you will need to configure your mail variables correctly. You can use a free mail server; for example, from Mailjet. You can also install your own mail server using, for example, mailcow

Go to https://<your.ctrlpanel.gg>/admin/settings#misc and enter your mail credentials.

Ensure you clear the config cache and restart the queue workers when making changes to the email details.
php artisan config:clear and php artisan queue:restart

To test the mail configuration, you can go to the users tab and click the notify button top right. Select a user and choose to send via email, write some text and click submit.

Payment Configuration

PayPal

To use the PayPal payment gateway, you have to set up an application at the PayPal developer dashboard https://developer.paypal.com/developer/accounts/.

Go to "My Apps & Credentials" and choose either "Live" for production use or "Sandbox" for testing use of PayPal.

Create an App, give it any name you want, and copy the Client ID and the Secret into the Settings of Controlpanel.

The only "App feature option" that Controlpanel needs is "Accept Payments".

Stripe

To use the Stripe payment gateway, you have to create a "company" at the Stripe dashboard and activate it https://dashboard.stripe.com/account/onboarding/business-structure.

Go to the developer page and click on API-Keys. You only need the Secret key in order to use Stripe at your Controlpanel. Copy it to the Payment Settings.

You will need to add a Webhook for Stripe in order to accept payments that are not 100% instantly confirmed by stripe (Klarna, Bank-Transfer etc.). Click on Webhooks and add an endpoint. Enter the Endpoint route: https://<your.ctrlpanel.gg>/payment/StripeWebhooks. Choose the "payment_intent.succeded" event to be sent to your WebhookRoute. After the webhook creation, you need to add the endpoint secret (Signing secret) to your Controlpanel settings. It can be found at the webhooks overview.

At the Controlpanel settings, you need to provide a comma separated list of payment methods you want to support via Stripe. Check which payment method is available for your currency: https://stripe.com/docs/payments/payment-methods/integration-options.

You can change the mode between Test and Live, just like PayPal.