Thanks for checking out the documentation of our JustFans product. Here you'll find about everything you need in order to get started with launching your app.

If you are not familiar with the terms or the techstack or if you don't have the time to install and configure the application, we cand handle the installation services for an additional fee.

Server requirements

Before proceeding with the installation, please make sure your instance meets the following criteria.

1. Nginx requires a vhost similar to the default laravel one.
2. The script can ran on pretty much everything, but for hosting, we usually recommend DigitalOcean servers.
3. If having less tech experience, we strongly recommend using a panel-based server. EG: cPanel/Cyberpanel.

Files Setup

Before proceeding with the installation, you need to extract the script contents onto the directory that will serve your domain. This can be done via cPanel’s File Manager, FTP, or command line.

Upload and extract the archive

• 1. If you’re using cPanel, navigate to File Manager and upload your .zip file containing the script.
• 2. Once uploaded, right-click and choose Extract to unpack all contents.
• 3. Copy the contents of the Script folder onto the public_html directory of the domain your are about to use.
• 4. Make sure you also copy any hidden files (e.g., .env, .htaccess).

Configure file permissions

In order for the script to work properly, set the following folders to CHMOD 755: vendor, storage, bootstrap .

Changing the public directory Important

Configure your web server’s document root to point to the public directory of the software. For example, if you uploaded the code into example.com, update the doc root to example.com/public.

If your hosting provider doesn’t allow changing your DocumentRoot, you can temporarily rename .htaccess.sample to .htaccess. Use this only as a temporary solution.

Database Setup

You need a MySQL or MariaDB database ready for the script. If using cPanel, go to MySQL Databases or the MySQL Database Wizard to create a new database and user.

• Create a new database (e.g., myapp_db).
• Create a new user (e.g., myapp_user) with a secure password.
• Assign the user to the database, ensuring it has ALL PRIVILEGES or the privileges required by your script.

Once done, you should have the following info:

• Database Name (e.g., myapp_db)
• Database Username (e.g., myapp_user)
• Database Password (e.g., 123456)
• Database Host (often localhost)

Installer

After preparing your files and database, run the web-based installer by visiting https://your-domain.com/install. This panel will guide you through a simple, 3-step process:

1. Requirements Check: The installer verifies if your server meets the minimum requirements (PHP version, extensions, etc.). If something is missing, you’ll need to fix it before proceeding.
2. Database Setup: Provide the DB name, user, password, and host you created above.
3. Site & Admin Settings: Configure your site’s name, admin login credentials, and license details.

Once you finish, the installer will set up your database tables, and you’ll be ready to log in to your admin panel to customize additional aspects of the platform.

If the web-installer is not available at https://your-domain.com/install, check out the https://your-domain.com/public/install one as well. If that one functions, it means you're DocumentRoot isn't properly set.

Basic configuration

There are many services and features you can configure and enable. However, for a working platform, these services will have to be configured first.

Payments system

Below are instructions for each supported gateway. Follow the relevant steps for the provider(s) you plan to use.

To receive payments, you need to set up at least one payment provider.

Go to Admin > Settings > Payments to configure your general payments settings and configure the chosen provider(s).

# Stripe

• Log in to your Stripe Dashboard.
• From the sidebar, go to Developers > API Keys.
• Copy the Publishable key and Secret key and paste them into Admin > Settings > Payments > Processors > Stripe.
• Next, open Webhooks and click Add endpoint.
• For the Endpoint URL, use the webhook endpoint from Admin > Settings > Payments > Processors > Stripe.
• Select the Version (latest) and choose Select all events under events to listen to.
• Once created, Stripe provides a Webhook secret. Copy that into Admin > Settings > Payments > Stripe Webhooks Secret.
• Enable OXXO with Stripe
  • Complete the general setup steps outlined above.
  • Log in to your Stripe account and navigate to Payment methods. Enable OXXO as a payment method.
  • In the admin panel, go to Settings > Payments > Processors > Stripe and enable OXXO.
  • Update the existing webhook to listen for the following events:
    • checkout.session.async_payment_succeeded
    • checkout.session.async_payment_failed
• Enable iDEAL, Blik, Bancontact, EPS, Giropay, and Przelewy24 with Stripe
  • Complete the general setup steps outlined above. Enabling OXXO is optional.
  • Log in to your Stripe account and navigate to Payment methods. Enable the desired payment methods.
  • In the admin panel, go to Settings > Payments > Processors > Stripe and enable the desired payment methods so they appear on the Stripe checkout page.

# PayPal

• Log in via the PayPal Developer Dashboard .
• Go to My apps & credentials , set Live, and click Create App to make a new PayPal app.
• Copy the ClientID & Secret Key and add them into Settings > Payments in your admin panel.
• Back in the PayPal dashboard, select your newly created app (under Live).
• Scroll down to Production Webhooks and click Add Webhook.
• For Webhook URL, use the endpoint from Admin > Settings > Payments.
• Under Event types, select All Events and click Save.

# Coinbase

• Log in to Coinbase Commerce.
• Go to the Settings section.
• Under API keys, click Create an API key and copy it. Paste it into Settings > Payments in your admin panel.
• For Webhook subscriptions, click Add an endpoint. The webhook URL is in Admin > Settings > Payments.
• Click Show shared secret and add it into the admin panel as well.

# NowPayments

• Log in at NowPayments.
• Go to Store settings and add a new API Key.
• Copy the key and paste it into Settings > Payments as NowPayments Api Key.
• Generate an IPN secret key there and add it into Admin > Settings > Payments > NowPayments IPN Secret Key.
• Add crypto wallets in your NowPayments account. We recommend adding many to lower conversion rates.
• We recommend setting a payment covering percentage so that slightly underpaid transactions can still count as completed. Example: If set to 5%, a $100 invoice will be treated as paid in full if $95 is received.

# CCBill

• Log in via CCBill sign in.
• Go to FlexForms Systems and note your Flex ID.
• Add the FlexForm Id in Settings > Payments > Processors > CCBill.
• Add your CCBill Account Number in admin settings.
• Go to Account Info > Sub Account Admin, under Basic to set your approval & denial URLs (from Admin > Settings > Payments).
• In Webhooks, add your admin CCBill Webhook URL (format: JSON).
• For recurring payments, repeat steps for your recurring sub account.
• Request your Salt key from CCBill and fill it in the admin panel.
• To automatically cancel subscriptions, set up a DataLink API user:
  • In your CCBill recurring sub account, go to Account info > DataLink Services Suite.
  • Click Add user, fill in a username and password, enable Subsystem checkboxes, and add your server IP to Valid Ips.
  • Click Store user and add these credentials in Settings > Payments > Processors > CCBill as CCBill DataLink Username / Password.

# Paystack

• Log in at Paystack dashboard .
• Go to Settings > Developer .
• Under API Keys & Webhooks, copy the Secret key and paste it into Settings > Payments > Processors > Paystack.
• Copy your Webhook & Callback URLs from the admin panel and add them to Paystack’s Settings > Developer as well.

# MercadoPago

• Log in to your MercadoPago developer account at MercadoPago Developer Portal.
• Navigate to Your Applications.
• Click Create Application.
• Choose a name for your application.
• Under What type of payment solution will you integrate?, select Online payments.
• For Are you using an e-commerce platform?, select No.
• Under Which product are you integrating?, select CheckoutPro.
• The Integration model field is optional, so you can leave it empty.
• After successfully creating the application, go to the Production Credentials section.
• Copy the Access Token and add it into the admin panel under Settings > Payments > Processors > Mercado.

# Offline Payments

• You can set up the offline payments by going to Admin > Settings > Payments > Processors, and select Offline payments under the Payment provider field.
• In there, you can setup your bank account details or additional details, which users can use to send you manual payments.
• After a user deposited via manual payments, you will be able to preview his request over Admin > Money > Payment Request.
• If you confirm the money have been received, you can approve the user request. He will then be notified that the request has been approved or not.

Withdrawals

Withdrawals can be done either manually, EG: you send the money yourself to the creator via selected/allowed payment providers, or automatically, via Stripe Connect, where users go through Stripe onboarding flow.

# Manual Withdrawals

• Navigate to Admin > Settings > Payments > Withdrawal to enable the available manual payout methods and other details.
• Users can create new withdrawal requests over User menu > Wallet > Withdrawals, filling in the required data based on the provider (e.g., PayPal, Bank Account, etc.).
• You can preview the request in the admin panel, over at Admin > Money > Withdrawals, process the payout, and approve or disapprove the request. You will also receive an email notification when a withdrawal request is made.
• Users will be notified when their request is approved or disapproved.

# Stripe Connect Withdrawals

• If you haven't already, create a Stripe account and add all required details.
• Log in to your Stripe account and navigate to the Stripe Dashboard.
• Go to Settings > Connect settings and enable Stripe Connect by agreeing to the terms and conditions.
• Set up your branding, including logos and colors, to customize the onboarding experience.
• Navigate to the Payout settings page:
  • External Accounts Tab:
    • Require at least one bank account? -> Recommended: Yes
    • Allow debit cards? -> Optional
    • Under Stripe-hosted onboarding for Custom accounts, set Collect external account information for Custom accounts to Yes.
  • Payout Schedules Tab:
    • Disable Allow accounts to manage their payout schedule, as payouts are created manually.
  • Alternative Currency Payouts Tab:
    • Enable Allow accounts to receive payouts in alternative currencies for users with accounts in different currencies.
• Set up a webhook endpoint:
  • Go to Developers > Webhooks.
  • Configure the following settings:
    • Endpoint URL: Found in Admin > Settings > Payments > Withdrawals.
    • Listen to: Events on Connected accounts.
    • Events to listen: account.updated, payout.canceled, payout.failed, payout.paid.
  • Click Add endpoint and copy the Signing secret into the admin panel under Settings > Payments > Withdrawals > Stripe Connect Webhooks Secret.
• Enable Stripe Connect for withdrawals in the admin panel by toggling Enable Stripe Connect for withdrawals.

Cron Setup

In order for the platform to function fully, including payment processing, emails, offers, and more, you need to set up the following cron job.

You can get the exact cron command path out of Admin > Settings > Payments area.

* * * * * cd /path-to-your-project && php artisan schedule:run >> /dev/null 2>&1 

Some hosting panels might require the cron command in a different format. If needed, you can run it with absolute paths or specific PHP versions:

* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1

Other hosting panels with have you set the task interval out of their own UI, so you might end up using a command that doesn't include the * * * * * prefix.

Ensure Cron Jobs Are Running

Cron jobs are crucial for payments, emails, and other scheduled tasks.

• Ensure they’re not returning any errors by manually running cd /path-to-your-project && php artisan schedule:run via CLI.
• Check that storage/logs/cronjobs.log exists within 24h since the task has been setup.

Emails

You can choose among three main email drivers—Mailgun (via API), SMTP, or PHP’s mail() function, if available. There’s also a logging driver option for debugging.

All email-related settings are located under Admin > Settings > Emails. Below is a quick summary:

1. Mail from name: The display name used when sending emails.
2. Mail from address: The sending address (e.g., no-reply@domain.com).

# Log Driver

The Log driver is mostly used for debugging. Any outgoing emails are recorded in storage/logs/laravel.log instead of being sent.

# Sendmail Driver

This driver relies on the PHP mail() function being active. Many cPanel-based shared hosting providers enable it by default.

# Mailgun Driver

Mailgun is an API-based service. To use it, you’ll need:

1. Mailgun domain – The custom domain/subdomain you set up on Mailgun, along with valid DNS records.
2. Mailgun secret – Domain API key
3. Mailgun endpoint – Typically api.mailgun.net for US or api.eu.mailgun.net for EU.

# SMTP Driver

Using SMTP requires the following:

1. SMTP Host – e.g., your mail server’s hostname or IP
2. SMTP Port – 587 (TLS) or 465 (SSL), depending on provider
3. SMTP Encryption – TLS or SSL
4. SMTP Username
5. SMTP Password

Websockets

The platform utilizes Websockets to provide real-time capabilities, such as instant messaging and live notifications. Follow the respective driver setup instructions below to configure Websockets for your platform.

# Pusher Websockets

Pusher is a managed Websockets service, offering simplicity and reliability. To set it up:

1. Log in to the Pusher Dashboard and navigate to the Channels category.
2. Click Create app, then provide a Name and choose a Cluster Region based on your preference.
3. Access your app details, or visit Apps and select your app.
4. Copy the App ID, Key, Secret, and Cluster values from Pusher, then save them to the admin panel under Admin > Settings > Websockets.

# Soketi Websockets

Soketi is a self-hosted alternative to Pusher, offering cost-effectiveness and greater control. To configure Soketi:

1. Change the Websockets driver to Soketi in the admin panel.
2. Add your configured Host, Port, App ID, App Key, and App Secret.
3. If your Soketi instance uses TLS, enable the Use TLS for Soketi toggle in the admin panel and set the port to 443.

If you don't want to be using the default local storage system, you can use wide range of scalable storage providers for storing your user-uploaded files, improving site I/O load, response time and security.

# Amazon's S3

Use our AWS S3 implementation (including CloudFront and CloudFront Signed URLs) for faster and more secure delivery via pre-signed URLs.

S3 Storage

Follow these steps to upload your data to Amazon S3:

1. Create an S3 Bucket:
   1. Go to AWS Console and log in or create an account.
   2. Search for S3 in the Search for services bar.
   3. Click Buckets > Create bucket.
   4. Specify the Bucket name and Region.
   5. Enable ACLs.
   6. Disable Block all public access.
   7. Acknowledge the warning by enabling: I acknowledge that the current settings might result in this bucket and the objects within becoming public.
   8. Click Create bucket.
2. Create an IAM User with S3 Permissions:
   1. Go to IAM > Access management > Users.
   2. Click Add users and set a Username.
   3. Under Permissions, choose Attach policies directly and search for AmazonS3FullAccess.
   4. Click Next, review the settings, and click Create user.
   5. Once created, click the username to view details.
   6. Go to Security credentials and click Create access key.
   7. Choose an appropriate use case (e.g., Other) and click Create access key.
   8. Save the AWS Access Key ID and Secret access key. You won’t be able to view the secret key again.
3. Configure S3 in the Admin Panel:
   1. Go to Admin > Settings > Storage.
   2. Enter the Bucket name, AWS Access Key ID, and AWS Secret Access Key.

S3 + CloudFront

Use CloudFront to distribute your content globally:

1. Search for CloudFront in the AWS Console and go to Distributions > Create distribution.
2. Copy the Distribution domain name (e.g., abc123.cloudfront.net) and configure it in Admin > Settings > Storage under Aws CloudFront Domain Name.
3. Update the S3 bucket policy to allow CloudFront access while retaining IAM user write permissions:

   {
       "Version": "2008-10-17",
       "Statement": [
           {
               "Sid": "AllowCloudFrontAccess",
               "Effect": "Allow",
               "Principal": {"Service": "cloudfront.amazonaws.com"},
               "Action": "s3:GetObject",
               "Resource": "arn:aws:s3:::your-bucket-name/*",
               "Condition": {
                   "StringEquals": {
                       "AWS:SourceArn": "arn:aws:cloudfront::your-account-id:distribution/your-cdn-distribution-id"
                   }
               }
           },
           {
               "Sid": "AllowIAMUserWrite",
               "Effect": "Allow",
               "Principal": {"AWS": "arn:aws:iam::your-account-id:user/your-iam-user-name"},
               "Action": "s3:PutObject",
               "Resource": "arn:aws:s3:::your-bucket-name/*"
           }
       ]
   }

4. Adjust Bucket Access Settings:
   • Disable Block all public access.
   • Manually select options to allow write access for IAM users while restricting object access to CloudFront.
     Disable Block all public access and enable all the options manually except Block public access to buckets and objects granted through new access control lists (ACLs)

S3 + CloudFront + Signed URLs

Follow these steps to use signed URLs for secure access:

1. Create a key pair (e.g., via OpenSSL):
   The steps below use OpenSSL as an example. There are other methods as well.
   • Generate a private key: openssl genrsa -out private_key.pem 2048
   • Extract the public key: openssl rsa -pubout -in private_key.pem -out public_key.pem
2. Upload the public key to CloudFront:
   • Log into CloudFront console .
   • Go to Key management > Public keys > Create public key.
   • Paste the contents of public_key.pem and save.
   • Copy the Public Key ID after adding. This is your Key-Pair-Id (and corresponds to Aws CloudFront Key Pair Id in the admin panel).
3. Create a key group:
   • Go to Key management > Key groups > Create key group.
   • Add the uploaded public key to the group and save.
4. Link the key group to your distribution:
   • Open your distribution settings and edit the behavior for the desired path.
   • Enable Restrict Viewer Access and select the trusted key group.
5. Navigate to Admin > Settings > Storage in your admin panel.
• Add the following:
• Key-Pair-Id: Your CloudFront Public Key ID.
• Path to private_key.pem: The file path where your private key is stored (e.g., private_key.pem if it’s in the root directory).
• Enable CloudFront PreSigned URLs.

For more information, refer to the official AWS documentation on private content with signed URLs .

# Wasabi

If you prefer using Wasabi, change the driver in Admin > Settings > Storage > Driver. Then add your Wasabi credentials (found on their website).

You must also add the following policy to your Wasabi bucket:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "AllowPublicRead",
      "Effect": "Allow",
      "Principal": {
        "AWS": "*"
      },
      "Action": "s3:GetObject",
      "Resource": "arn:aws:s3:::your-bucket-name/*"
    }
  ]
}

# DigitalOcean Spaces

If you want to use DigitalOcean Spaces, select it under Admin > Settings > Storage > Driver. Then follow these steps:

1. Create a new Spaces access key and save the key/secret.
2. In Admin > Settings > Storage, add your new DO Access Key and DO Secret Key.
3. Go to Spaces and create a new space. Defaults should be fine.
4. Once created, you’ll see a URL like https://{bucket-name}.{region}.digitaloceanspaces.com.
5. For DO Bucket, use {bucket-name}, and for DO Region, use {region}.

# Minio

If you have a self-hosted Minio instance, you can switch the driver to Minio in Admin > Settings > Storage > Driver. Then:

1. Create a new set of keys in Minio and copy them.
2. In Admin > Settings > Storage, fill in Minio Access Key and Minio Secret Key.
3. Create a new bucket and set it in Admin > Settings > Storage > Minio bucket.
4. For Minio Region, specify the region your instance uses.
5. For Minio Endpoint, specify your Minio server endpoint.

# PushrCDN

If you have a PushrCDN account, you can switch the driver to PushrCDN under Admin > Settings > Storage > Driver. Then:

1. Go to the CDN page and create a Push zone.
2. Set a label and for Sonic Storage Type, choose AWS S3-compatible.
3. Open Storage and Hostnames, then fill in your keys, bucketname, S3 endpoint, and CDN Hostname.

Video Transcoding

Video transcoding is essential for allowing users to upload and play videos in various formats. If no video transcoding service is not available, the platform will restrict uploads to .mp4 files only.

If no video transcoding service is not available, the platform will restrict uploads to .mp4 files only.

Video transcoding drivers can be selected at Admin > Settings > Media > Videos > Transcoding driver.

# FFMpeg Driver

FFMpeg is an open-source tool used for processing multimedia content. With FFMpeg installed on your server, users can upload videos in multiple formats, which will then be converted to playable formats.

1. Testing FFMpeg Installation

   After installing FFMpeg, you can verify the installation using the following commands:

   ffmpeg -version # To test installation
   which ffmpeg && which ffprobe # To get full executable paths

2. Configuring FFMpeg in Admin

   Copy the full paths of the bin/ffmpeg and bin/ffprobe executables and add them in the admin panel under Admin > Settings > Media > Videos, select Transcoding Driver to FFMpeg, then fill in the FFmpeg path and FFProbe Path.

# Coconut Driver

Coconut is a cloud-based video transcoding solution that provides an alternative to FFMpeg. It enables remote transcoding, making it suitable for platforms that cannot host FFMpeg or require scalable processing.

1. Register an account on Coconut.
2. Navigate to the API section and retrieve your API key.
3. Go to Admin > Settings > Media > Videos and select Coconut for the Transcoding driver and add your API key.
4. Configure the encoding options according to your needs.

Before launching your site, test the video transcoding functionality to ensure everything works as expected. You can preview transcoded videos on the Coconut dashboard.

Live Streaming

To enable live streaming on your platform, you need a PushrCDN account. Once your account is created, follow the steps below to complete the configuration.

Account Verification

After registering for PushrCDN, verify your account by completing the following steps:

1. Fill in your personal information.
2. Provide your payment information.
3. Navigate to Media Platform > Go Live and submit the required verification details.

Configuration Steps

Once your account is verified, set up live streaming by following these steps:

1. Go to CDN > Push Zones and create a new push zone.
2. Copy the CDN Push Zone ID and add it to the Admin > Streaming > Pushr Zone Id field in your admin panel.
3. Retrieve your API key from the Profile > Personal Information section, and add it to the Admin > Streaming > Pushr Key field.
4. For the Admin > Streaming > Pushr Encoder, select one of the available encoders: eu, us, or sg.

Finalizing Setup

After entering your PushrCDN Zone ID and API Key, your platform will be configured to support live streaming. From the admin panel, you can also adjust additional settings, such as VODs, encoders, or bitrates, to optimize your streaming experience.

Captcha

To protect your public forms (e.g., registration, contact, etc.) from spam, you can choose one of the following drivers under Admin > Settings > Security > Captcha:

• Google reCAPTCHA
• Cloudflare Turnstile
• hCaptcha

Each driver typically requires a site key and a secret key. Once these are added, your chosen captcha will be enforced on the designated public forms.

# Google reCAPTCHA

Google’s reCAPTCHA is a popular solution for verifying that form submissions are from real users.

• Go to Google reCAPTCHA Admin to create a new app.
• Choose reCAPTCHA v2 > "I'm not a robot" Checkbox (or whichever suits your needs).
• Copy the provided Site Key and Secret Key.
• In your admin panel, navigate to Admin > Settings > Security > Captcha.
• Select Google reCAPTCHA as the Captcha Driver, then paste your Site Key and Secret Key in the fields provided.

# Cloudflare Turnstile

Cloudflare Turnstile is a user-friendly, privacy-focused captcha alternative.

• Log into Cloudflare Dashboard and create or open your project.
• Go to the Turnstile section to create a new site, then copy the Site Key and Secret Key.
• In Admin > Settings > Security > Captcha, select Turnstile as the Captcha Driver and paste your keys.

# hCaptcha

hCaptcha is another popular captcha solution focused on privacy and security. To set it up:

• Go to hCaptcha’s official site or dashboard and create your account.
• Once your project is created, copy the Site Key and Secret Key.
• In Admin > Settings > Security > Captcha, select hCaptcha as the Captcha Driver.
• Paste your hCaptcha Site Key and Secret Key into the respective fields.

GEO-Blocking

The GEO-Blocking feature allows users to restrict access to their profiles based on geographical locations. This feature can be managed globally from the admin panel.

Enabling GEO-Blocking

To enable GEO-Blocking:

1. Go to Admin > Settings > Security.
2. Enable the Allow users to be able to geoblock their profiles switch.

IP Geolocation API Key

For GEO-Blocking to work, you must set up an IP geolocation API key. Follow these steps:

1. Register an account on Abstract API.
2. Generate your API key from the IP Geolocation API section.
3. Add the API key to Admin > Settings > Security > IP Geolocation API Key.

Social logins

Though each social login provider’s interface may differ, the general steps to enable social logins are:

• Obtain an approved app on the social login provider.
• Copy your Client ID and Client Secret keys.
• Add these keys to Admin > Settings > Social media in your admin panel.
• In Admin > Settings > Social media, copy the Callback URL for each provider.
• Paste this Callback URL into the provider’s settings (e.g., “Authorized redirect URIs” or “Callback URLs” field).

# Twitter

• Go to https://developer.twitter.com and create a new app.
• Get elevated access to the Twitter API via this link .
• Choose your Application Environment (dev or prod), name your app, and you’ll receive an API Key and API Key secret. Add them to Admin > Settings > Social media.
• Once created, go to app settings > “User authentication settings” > Setup.
• For “App permissions,” select “Read,” and also enable “Request email address from users,” if desired.
• Copy the Callback URL from your admin panel and add it to the “Callback URLs” field in your Twitter app’s settings.

# Google

• Create a new project at https://console.developers.google.com/projectcreate .
• Generate credentials at https://console.developers.google.com/apis/credentials .
• Choose “OAuth client ID > Consent > Web application.”
• Copy your Client ID and Client Secret, then add them to Admin > Settings > Social media.
• Copy the Callback URL from your admin panel and add it to your Google “Authorized redirect URIs.”

# Facebook

• Visit https://developers.facebook.com/apps and create a new app (Consumer). Fill in any required details.
• Go to App settings > Basic, copy the App ID & App secret, and add them to Admin > Settings > Social media.
• Navigate to App > Facebook Login > Settings.
• Copy the admin Callback URL and add it under Valid OAuth Redirect URIs in your Facebook app settings.

OpenAI

The AI-suggestions feature allows users to get smart text suggestions (for posts, bios, or other areas) from OpenAI’s language models. This can save time and help with writer’s block by automatically generating text ideas.

Important: OpenAI’s API is usage-based, meaning costs can accrue if you or your users make many requests. Be sure to monitor your usage in your OpenAI account to avoid unexpected charges.

To configure AI suggestions in this platform:

1. Go to Admin > Settings > AI and enable the “AI suggestions” feature.
2. Create or log in to your account at https://platform.openai.com .
3. In your OpenAI dashboard, find the “API Keys” section. Create a new secret key and copy it. (You won’t be able to see it again later.)
4. Back in the admin panel, under Admin > Settings > AI, paste your new OpenAI API Key into the field provided. Click “Save” to update.

Once configured, users can click a button (or similar UI element) to get text suggestions in your app’s relevant areas. If you see any errors, confirm that your API key is valid and that your OpenAI account has sufficient credits.

# Referrals

The referral system incentivizes users to bring new creators to the platform by offering a commission on the earnings of referred creators. This can be a cost-effective alternative to traditional marketing campaigns, depending on your niche.

How Referrals Work

• When a user refers someone who signs up as a creator and sells content, the referrer earns a percentage of the creator's earnings.
• The referral commission is paid by the platform owner, not the referred creator.
• Users can generate and share their unique referral link from Settings > Referral.

Configuring Referrals

You can configure referral settings in the admin panel, at Admin > Settings > Referrals, being able to set options like:

1. The percentage of earnings that referrers will receive.
2. The time limit for which referral commissions are valid.
3. Any monetary cap for referral payouts.

Localization

To translate your site into another language, make a copy of the default en.json file found in the lang folder and modify it as needed.

• The JSON language file must use an ISO code, e.g. es.json, ro.json, or en.json.
• If you need to overwrite validation messages or other library strings, copy the en folder (and its files) and rename it to your new language code.

If everything went fine, you can access the Admin panel at http://your-domain.com/admin. The initial admin credentials were set during installation/user creation.

After setting up your main admin account, you can manage roles and create other admin users within the admin panel.

If you lose access to your admin account, you can reset the user password or create another user with admin privileges via the following command or SQL query:

• php artisan voyager:admin user@example.com
• UPDATE users SET role_id = 1 WHERE email = 'user@example.com'

Using the admin panel, you can now continue with setting up the rest of settings for your instance, like branding elements, colors, taxes and more.

Whenever new major updates are available, you will be notified via Envato. When notified, head over your Envato Downloads area and download the latest .zip archive. Once downloaded, you can proceed with:

1. Make a backup of the .env config file located on your server.
2. Upload the .zip, onto your server and extract it.
3. Copy over (overwrite) the contents of Script folder into your website folder.
4. Restore your .env config file on your server.
5. Go to https://example.com/update and follow the update wizard.¹

• I have a support inquiry, a question or a problem, how can I contact you?
  You can contact us by sending us a private message over our Codecanyon profile .
• What hosting do you recommend?
  We recommend using DigitalOcean , as they offer great performance and flexibility at an affordable price.
• Is installation included in the price?
  No, installation is not included. We offer installation services for an extra fee, for which you can send us a message.
• My website returns a Not Found message, why?
  Please ensure that you have mod_rewrite enabled on your server.
• # I have uploaded my files but get a 500 error. Why?
  This usually happens due to a couple of reasons:

  • When uploading the script files via FTP, and your operating system is skipping hidden files, including .env. Re-upload that file, plus any other hidden files (like .htaccess), or upload the entire .zip onto the server and extract it there
  • It can also happen when moving files around in cPanel's File Manager. Make sure to go to Settings > Preferences and check Show hidden Files (dotfiles) so that hidden files are selectable.
  • Another cause could be a missing PHP extension. Check storage/logs/laravel.log for the exact error or missing extension.

• # How can I edit my homepage?

  Generally, each page—including the homepage—has the following structure:

  1. Controllers are located in the app/Http/Controllers folder.
  2. Views (the HTML) are located resources/views/page.blade.php path.
  3. Javascript code is located at public/js/pages/page.js path.
  4. CSS code is located at public/css/pages/page.css path.

  So, for the homepage specifically, you might find files like home.css, home.js, home.blade.php, etc. You’ll need to back up and replace any of the modified files after each update

  You can handle most of the branding elements out of the admin, as for the text/strings, you can simply change them out of the translation files.

• # How can I update my custom modified version of the script?

  We recommend the following workflow for maintaining custom versions:

  1. Create your own private repository. Not using a private will get the repo auto-taken down.
  2. Host your custom code changes on a separate branch.
  3. Pull or merge new updates from the main branch.
  4. Resolve any conflicts if necessary.
  5. Release your (custom) updated version of the script.
  6. Use the How to update guide for applying final changes.

• # How can I change the PWA app icons?

  To change your PWA app icon and splash screen assets, replace the existing icons within public/img/pwa.

  After replacing them, clear your browser cache to see the updated icon and splash screen.

• Assets are not uploading or displaying when using local storage. Why?
  First, check whether Admin > Settings > Site url has an invalid value. Next, confirm the storage symlink is active. If not, re-create it by:

  1. rm -rf public/storage
  2. ln -s storage/app/public public/storage
• # I’m getting a 500 error after changing the file storage driver. Why?
  This typically happens if the storage driver credentials are incorrect. If you can’t access the admin panel, reset the driver via a DB query: UPDATE settings SET value='public' WHERE id=95;
• # I am having issues with uploading large files. What can I do?
  This is usually related to server/web-server/PHP limits. You can tweak:
  • Admin > Settings > Media > Max file uploads size
  • Admin > Settings > Media > Chunked uploads
  If you still have issues, these PHP settings might help, but other firewall or server configurations can also affect uploads.
• # I'm having issues with ffmpeg-encoded videos. Why?
  This often stems from the server/web-server or the FFMpeg build. Possible causes range from missing encoders to memory errors. The storage/logs/laravel.log file usually shows the actual error.
  If it's audio-encoder or memory-related, try adjusting:
  • Admin > Settings > Media > FFMpeg video conversion quality preset
  • Admin > Settings > Media > FFMPEG Audio encoder
  If problems persist, you may need to reconfigure server settings or upgrade the FFMpeg build.
• # How do I test payments on the demo website?
  Depending on your chosen payment provider, these test credentials can be used:

  • Stripe:
    Card: 4242 4242 4242 4242
    Date: Any future date
    CVC: 123
  • PayPal:
    Email: sb-mzdi86428457@business.example.com
    Password: Dz1d_EP/
  • CCBill:
    VISA: 4111111111111111
    MasterCard: 5105105105105100
    Discover: 6011111111111117
    CVV: 300