Admin Guide

Comprehensive guide for platform administrators to manage users, plans, subscriptions, and system settings.

Admin Dashboard

The admin dashboard provides an overview of your platform's performance and key metrics.

Accessing the Admin Panel

To access admin features, you must be logged in with an admin account. Admin accounts are created during installation or can be promoted from the user management page.

Navigate to Admin > Overview to view:

• Total Users: Number of registered users
• Active Subscriptions: Users with active paid plans
• Total Revenue: Sum of all successful transactions
• Total Apps: Number of apps created across all users
• Recent Builds: Latest app builds and their status
• Revenue Chart: Monthly revenue trends
• Popular Plans: Most subscribed plans

User Management

Manage all users on your platform from Admin > Users.

Viewing Users

The users table displays:

• User name and email
• Current subscription plan
• Account status (Active/Inactive)
• Role (Admin/User)
• Registration date
• Available build credits

Search and Filter

Use the search bar to find users by name or email. Filter by:

• Status: Active or Inactive users
• Role: Admins or regular users
• Plan: Users on specific subscription plans

Creating a New User

1. Click Add New User
2. Enter user details (name, email, password)
3. Select a role (Admin or User)
4. Choose a subscription plan
5. Set account status (Active or Inactive)
6. Click Create User

Editing Users

Click the edit icon next to any user to:

• Update personal information
• Change their subscription plan
• Promote to admin or demote to user
• Activate or deactivate their account
• Manually adjust build credits
• Reset their password

Deleting Users

Click the delete icon to remove a user. This will:

• Delete their account permanently
• Remove all their apps and builds
• Cancel their active subscription

Plan Management

Create and manage subscription plans at Admin > Plans.

Default Plans

Appy comes with three default plans:

• Free: Limited features for trial users
• Pro: Full features for individual developers
• Enterprise: Advanced features for agencies

Creating a New Plan

1. Click Create New Plan
2. Enter plan details:
   • Name: Plan name (e.g., "Starter", "Business")
   • Price: Monthly price (0 for free plans)
   • Currency: USD, EUR, etc.
   • Billing Interval: Monthly or Yearly
   • Status: Active or Inactive
3. Configure features:
   • Monthly Build Credits: Number of builds per month
   • Can Use Custom Code: Allow HTML/CSS/JS injection
   • Can Use Appetize: Enable browser preview
   • Monthly Appetize Minutes: Preview time allocation
   • Can Use API: Enable REST API access
   • Allowed Builders: Restrict to specific build servers
4. Add feature list (displayed to users):
   • Enter features one per line
   • Example: "Unlimited apps", "24/7 support"
5. Click Create Plan

Editing Plans

You can edit plan details at any time. Changes affect:

• New subscribers: Immediately
• Existing subscribers: On next billing cycle (unless manually updated)

Setting Default Plan

Mark one plan as default by checking Is Default. New users are automatically assigned to this plan upon registration.

Deactivating Plans

Set status to Inactive to hide a plan from new subscriptions. Existing subscribers keep their plan until they change it.

Subscription Management

Monitor and manage all subscriptions at Admin > Subscriptions.

Subscription Details

View comprehensive subscription information:

• User name and email
• Current plan
• Subscription status (Active, Pending, Expired, Canceled, Past Due)
• Amount and payment method
• Start date and renewal date
• External subscription ID (from payment gateway)

Filtering Subscriptions

Filter by:

• Status: Active, Expired, Canceled, etc.
• Plan: Specific subscription plan
• Payment Method: Stripe, PayPal, Razorpay, etc.

Manually Managing Subscriptions

As an admin, you can:

• Edit Subscription: Change plan, renewal date, or status
• Cancel Subscription: Immediately end a user's subscription
• Extend Subscription: Adjust renewal date to give extra time
• Refund: Issue refunds through your payment gateway dashboard

Transaction History

View all payment transactions at Admin > Transactions. Each transaction includes:

• Transaction ID (internal and external)
• User and subscription information
• Amount and currency
• Payment status (Pending, Completed, Failed, Refunded)
• Payment method
• Transaction date
• Metadata (additional payment gateway data)

Builder Management

Manage distributed build servers at Admin > Builders.

What are Builders?

Builders are remote servers that compile Android APKs. You can set up multiple builders to handle builds in parallel and distribute load.

Builder Information

Each builder shows:

• Name: Builder identifier
• URL and Port: Builder server address
• Platform: Android (iOS coming soon)
• Status: Active, Inactive, or Maintenance
• Max Queue: Maximum concurrent builds
• Current Builds: Number of builds in progress
• Credit Cost: Credits deducted per build on this builder
• Total Builds Processed: Lifetime build count
• Last Triggered: Last build assignment time

Adding a Builder

1. Set up a builder server (see builder documentation)
2. Click Add New Builder
3. Enter:
   • Builder name
   • Server URL (without http/https)
   • Server port (usually 3000)
   • Server key (authentication token)
   • Platform (Android)
   • Max queue size (recommended: 3-5)
   • Credit cost per build
4. Click Create Builder

Builder Status

• Active: Accepting new builds
• Inactive: Not accepting builds
• Maintenance: Temporarily paused for updates

Cron Jobs Setup

Appy uses Laravel's task scheduler for automated tasks. You must add a single cron entry to your server that runs every minute.

Setting Up the Cron Job

Connect to your server via SSH and open the crontab editor:

crontab -e

Add this line at the end of the file (replace the path with your actual installation path):

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

For example, if you installed Appy in /home/username/public_html:

* * * * * cd /home/username/public_html && php artisan schedule:run >> /dev/null 2>&1

Scheduled Tasks

The following tasks run automatically:

Monitoring Cron Jobs

View cron job execution history at Admin > Cron Jobs. This page shows:

• Job Name: The scheduled task that ran
• Status: Success or failed
• Duration: How long the task took
• Last Run: When the task last executed
• Message: Output or error message

Plugin Management

Extend Appy's functionality with plugins at Admin > Plugins.

Plugin Types

• Payment Gateways: Stripe, PayPal, Razorpay, Paystack, Crypto.com Pay, Bank Transfer
• Platforms: Android WebView (more coming soon)
• Bridges: Connect to third-party platforms (future)

Installing Plugins

Default plugins are pre-installed. To add custom plugins:

1. Click Upload Plugin
2. Select a plugin ZIP file
3. Click Install Plugin
4. Configure the plugin settings
5. Activate the plugin

Configuring Plugins

Click Configure on any plugin to set:

• Payment Gateways: API keys, webhook secrets, test mode
• Platforms: Build configuration, default settings

Activating/Deactivating Plugins

Use the toggle switch to enable or disable plugins. Deactivated plugins:

• Don't appear to users
• Can't be selected for new transactions or apps
• Keep existing data intact

Deleting Plugins

Click Delete to remove a plugin permanently. This will:

• Remove the plugin files
• Delete plugin database tables
• Remove plugin configurations

Email Templates

Customize automated emails at Admin > Email Templates.

Available Templates

• Welcome Email: Sent when users register
• Password Reset: Password reset instructions
• Email Verification: Email address confirmation
• Subscription Confirmation: Sent after successful payment
• Subscription Canceled: Sent when subscription is canceled
• Build Completed: Notification when app build finishes
• Build Failed: Notification when build encounters error
• Credits Low: Warning when build credits are running low

Editing Templates

1. Click Edit on any template
2. Modify the subject line
3. Edit the email body (HTML supported)
4. Use variables for dynamic content:
   • {user_name} - User's full name
   • {user_email} - User's email address
   • {site_name} - Your site name
   • {site_url} - Your site URL
   • {app_name} - App name (where applicable)
   • {plan_name} - Subscription plan name
5. Click Save Template

Resetting Templates

If you want to restore the default template, click Reset to Default. This will overwrite your custom changes.

Template Preview

Some templates include a preview feature. Click Preview to see how the email looks with sample data.