Files Structure

File structure

We have a very easy file structuring. It was designed to have an easy access. Unlike the typical MVP approach we followed somewhat inspired by Wordpress.

So when you download ClipBucket you will the structure as follow.

Root
- do_not_upload
- upload

/do_not_upload directory

This directory has just one file - in case you lose your password as admin, you can upload this file to recover it.

/upload directory

Where all the source code is present, the name is somewhat confusing, its because it was written in the days when you simply upload the files, so we created a folder named 'upload' so that users understands which content are required to upload.

Its the ROOT of our software...actually.

Folders in the upload directory are as follows

- actions
- admin_area
- ajax
- api
- cache
- cb_install
- files
- images
- includes
- js
- player
- plugins
- styles

/actions

It has basic files which are called when file upload request is made and when conversion request is asked for. For Vodlix, It has a different purpose

/admin_area

This has all the files related to Administration panel, it's authentication is done by including the config file. It loads PHP file and then renders a template from style within this directory

/ajax

it has the PHP files for Ajax Requests

/api

It has an absolutely nonsense Api files, please avoid it, we will write them in future.

/cache

Smarty Template engine Cache, by default its off

/cb_install

ClopBucket Installation instructions are written here

/files

uploaded videos files are stored here

/images

uploaded images that is not related to the videos are uploaded here

/includes

all the methods & classes are written in this folder so this is where you are going to spend most of your time

/js

javascript libraries and code

/player

Comes with video Js, this holds folders of each player, new player can be added and later selected through admin area

/upload/plugins

Plugins directory

/styles

Themes and template directory

PHP & .htaccess files

/.htaccess

the magic file for apache

/403.php

loaded when permission is denied via htaccess

/404.php

when a wrong URL is hit

/LICENSE

file that you alwasy ignore, it simply tells you about our attribute assurances license and whos the daddy

/activations.php

for User activation

/add_group_videos.php

When videos are added to the group, this page is loaded

/ajax.php

for user ajax requests, yes we also have a folder that holds a group of ajax files, we didnt have teh API written so we went for the cheap mode

/captcha.php

for load the captcha, not really good but ... works

/channels.php

list user profiles, we call them channels

/collections.php

List Collections, that are basically advance playlists. you can even create sub collections

/contact.php

Loads a contact page with a contact form..yep.

/create_group.php

To create a new group

/download.php

for downloading a video file

/download_photo.php

for downloading a photo

/edit_account.php

for editing user profile details from front end

/edit_group.php

to edit group details

/edit_photo.php

to edit photo information

/edit_video.php

to edit video information

/favicon.ico

favicon

/forgot.php

to recover forget password and username

/groups.php

list groups

/index.php

the main file

/invite_group.php

for adding members via invitiation

/logout.php

logout

/manage_collections.php

to manage a collection for user

/manage_contacts.php

manage conctacts for user

/manage_groups.php

manage groups for user

/manage_photos.php

manage photos for user

/manage_playlists.php

manage playlists for user

/manage_videos.php

user videos manager

/module.php

load a module, thats used via Plugin

/myaccount.php

load my account details for user

/opensearch.php

for SEO open search

/package.json

package json thats never used

/photo_upload.php

to upload photos

/photos.php

list photos

/privacy.php

loads privacy policy page

/private_message.php

for messaging

/readme

ignore

/rss.php

for RSS feed, MRSS supported

/search_result.php

search results

/signup.php

for creating new accounts for end users

/sitemap.php

sitemap

/upload.php

to upload a video

/upload_thumb.php

to upload a thumb for a video

/user_collections.php

list user collections

/user_contacts.php

list user contacts

/user_photos.php

list user photos

/user_videos.php

list user videos

/videos.php

list all videos

/view_channel.php

Basically a user profile lis

/view_collection.php

view collection details

/view_group.php

show group details

/view_group_members.php

list group members

/view_group_videos.php

View group videos

/view_item.php

View group items

/view_page.php

list a page with details created through backend

/view_playlist.php

view a playlist

/view_topic.php

view a group topic

/watch_video.php

view video details