Overview

Thank you very much for purchasing Onyx Files. This documentation will help you get started and go into detail about what this plugin can do for you.
If you need more assistance, please e-mail me at jaskokoyn@gmail.com

Installation

Installing a WordPress plugin only takes 3 steps

1. Login to your WordPress site and navigate to Plugins > Add New > Upload

2. Along with this documentation, you will find a onyxfiles.zip file. Upload this file.

3. WordPress will now take care of installing Onyx Files. You can now activate Onyx Files and starting using it! That's it!

Updating

If you already have Onyx Files and you'd like to upgrade to the latest version, then follow this part of the documentation.

1. Login to your WordPress site and navigate to Plugins > Installed Plugins

2. Deactivate Onyx Files. DO NOT UNINSTALL.

3. Use an FTP client to access your WordPress installation and navigate to wp-content > plugins.

4. Delete the folder Onyx Files. Don't worry, your files and configuration settings will be saved.

5. Open up the onyxfiles.zip file and reupload the onyxfiles folder using FTP.

6. Go back to your WordPress dashboard and reactivate Onyx Files. That's it!

Quick Start

If you're looking to get started quickly without all the nitty gritty details, then this part of the documentation is for you.

1. Login to your WordPress dashboard and navigate to Onyx Files > Add New

2. Onyx Files will already set up most of the default settings for you. All you have to do is upload your files by dragging and dropping into the file center. You also need to give your file a title.

3. Press "Publish" and your file is now ready for downloading. You'll find a short code in the Onyx Files > All Onyx Files page. Onyx Files will also create a page for this download.

File Settings

Let's talk about what each setting does in Onyx files

Basic Settings

  • Button Label - The text that will appear in your button.
  • Download Limit - The amount of times this file is allowed to be downloaded.
  • Download Limit Per User -The amount of times this file is allowed to be downloaded per user.
  • View Count - The amount of times this file has been viewed. This value will automatically increment each time this file is viewed.
  • Download Count - The amount of times this file has been downloaded. This value will automatically increment each time this file is downloaded
  • Individual File Downloads - If you have multiple files in one package, then you can allow users to download each file separately or all together.
  • Access Level - Limit what usergroup can download this file.
  • Download Available On - Set when this file is available to download.
  • Download Expires On - Set an expiration date when this file is no longer available.

Lock Settings

In order to use some of these locks, you will have to create API keys. Please look at the configuration section of this documentation for more details and help.

  • No Locks - By having no locks, the user will be able to download this file directly.
  • LinkedIn Share - The user will have to enter a password in order to download this file.
  • Facebook Share - The user will have to share this file in order to download.
  • Facebook Like - The user will have to like this file in order to download.
  • Twitter Follow - The user will have to follow you on twitter in order to download this file.
  • Tweet - This user will have tweet a message in order to download this file.
  • Google +1 - This user will have +1 this file on Google+ in order to download this file.
  • E-mail - This user will have to submit their e-mail in order to download this file.

Button Settings

These settings will alternate the appearance of your button.

  • Color - The background color of your button.
  • Size - The size of your button.
  • Effects - A hover effect for your button.
  • Enhancements - An enhancement for your button.
  • Shape - The shape of your button.
  • Button Styles - The style of your button.
  • Icon - An icon for your button. This will only appear for certain button styles.

Uploading

You have various options for uploading files. Here's what you can do.

  • Drag & Drop - You can drag and drop files.
  • Import from URL - You can upload a file by URL. This will not always work depending on the URL you provide. Some sites disallow this feature and so you should not rely on this import option 100%
  • Import from file browser - You can view your server files by using this option. This will select and create a copy of this file ready for download..
  • Import from Dropbox - You can upload files from your dropbox. You will have to create an API key before using this feature though. Please look at the configuration part of the documenation for more details.
  • Direct or Magnet URL - This option will not upload a file. Instead, you can directly link to a file or page using this option

E-mail Subscribers

If you use the e-mail lock, then you can view the list of e-mails in your dashboard. Navigate to Onyx Files > Email Subscribers. Here are some of the options available.

  • Delete Selected - This option will delete the emails you select in the email table.
  • Export Selected - This option will export the emails you select in the email table.
  • Export All - This option will export ALL the emails submitted.
  • Export Unique - This option will export ALL UNIQUE emails submitted.

Configuration

This part of the documentation will help you set up Onyx Files.

Social Settings

Facebook

  • Sign into Facebook and visit https://developers.facebook.com/
  • Navigate to Apps > Add New App. Click on Website. You can now name your app anything and press Create.
  • Now, you should be able to navigate to Apps > YOUR APP NAME. You'll find your App ID on this page. Copy and paste this into Onyx Files configuration page.
  • Go to settings and make sure to fill out a app domains, contact email and site URL. Click Save Changes.
  • Go to Status & Review and turn on your app for public. After doing all this, you should now be able to use the Facebook locks.

LinkedIn

  • Sign into Linked and visit https://developers.facebook.com/
  • Under your name on the top right corner. Click API keys, then click Add New Application.
  • You can fill in these in these fields however you like, but the following fields are important
    • Website URL - Your site URL
    • Live Status - Set to Live
    • Default Scope - Check r_basicprofile & w_messages
    • JavaScript API Domains - Paste your site URL once again.
  • Submit and you should now be given an API key. Insert this API key into Onyx File's configuration page. You can now use the LinkedIn Lockers

Twitter

No special API keys are needed to use the Twitter Lockers. Just input your twitter username and you're all set to go!

Paypal Settings

  • Login to your Business Pappal Account. Navigate to Profile > My Selling Tools > Instant Payment Notification
  • You should be given the option to Enable IPN. The notification URL should be the URL of your site.
  • Submit the changes and you can now start using the Paypal Lock.

Blocking Settings

You will have the option of blocking certain emails and emails from certian domain names.

Message Settings

You can customize the messages outputted to the user here.

Storage Settings

Dropbox App Key

  • Login to your Dropbox account and navigate to https://www.dropbox.com/developers
  • Navigate to App Console > Create App. Select Drop-ins API and name your app anything.
  • You should now be given an API key. Insert this into the Onyx Files configuration page. You can now upload files using Dropbox.

Change log

Version 1.1

  • Improve documentation
  • Bug fixes and minor changes
  • Dropbox Support Added
  • Direct & Magnet URLs added
  • Individual File Downloads Available
  • Improved Download Interface
  • Security Update
  • Files now have their own download pages
  • Top Downloads & Recently Uploaded Widgets Available

Version 1.0

  • Onyx Files Launches.