ChiliVideos Plugin - A "private Youtube" for ChiliProject (or Redmine) installations
DESCRIPTION:
ChiliProject/Redmine plugin which integrates with Transload.it to offer a private "YouTube-like" setup to your project site.
NOTABLE ITEMS TO CONSIDER
- This plugin is distributed as a gem, but does ship with migrations and asset files (stylesheets, etc). Therefore, the installation procedure is not the standard process.
- The processing of "Assemblies" from the Transload.it service is
handled in the background (via
delayed_job
), so there is an additional daemon process which you will have to monitor and/or manage with your installation.
FEATURES:
- Makes it dead simple upload, store, and embed videos to your own
ChiliProject/Redmine (CP/RM) installation.
- Note: Videos are stored wherever you have Transload.it send them, Amazon's S3 service being a popular option.
- Allows you to link videos to specific "versions" in the CP/RM project
- Adds a "video" wiki macro which can be used to embed any video in
wiki's, news items, et cetera. (taken from the
redmine_video_embed
plugin)
SCREENSHOTS:
You can find a few screenshots here.
PROBLEMS:
- Does not support authenticated requests to Transload.it yet. You probably don't want to use this on "public" CP/RM installations quite yet. This will be implementd soon...
- If users click the "submit" button multiple times on the upload form, they may get duplicate video transcodings.
- There is not currently support for a default "still" thumbnail image to be displayed when the video has not been started yet. All videos are just a "black box" until you click "play" at this point.
SYNOPSIS:
- Install the plugin
- Fire up the delayed_job daemon
- Add your Transload.it account credentials & template ID on the 'ChiliVideos' plugin settings page.
- Enable the "Videos" module in a project
A "Videos" tab will show up in your project. Click the "Add Video" link in the contextual menu and use the form to send a video through the Transload.it workflow you specified in your plugin settings. The delayed_job daemon will grab the information about your video when it is done being processed an the video will show up on the "Videos" tab.
REQUIREMENTS:
- A Transload.it API key and workflow template ID
- Gems:
- httparty (v0.7.4)
- daemon-spawn (v0.4.2)
- delayed_job (v2.0.4)
- friendly_id (v3.2.1.1)
- hashie (v1.0.0)
INSTALL:
gem install chili_videos
Manual steps after gem installation
In your 'Gemfile', add:
gem 'chili_videos'
Execute bundle install
(or bundle update chili_videos
if you had a previous version installed).
Next, in your 'Rakefile', add:
require 'tasks/chili_videos_tasks'
Run the installation rake task (runs migrations & installs assets)
RAILS_ENV=production rake chili_videos:install
Cycle your application server (mongrel, unicorn, etc)
Start the delayed_job daemon
RAILS_ENV=production rake "chili_videos:delayed_job[start]"
UNINSTALL:
Stop the delayed_job daemon
RAILS_ENV=production rake "chili_videos:delayed_job[stop]"
Run the uninstall rake task (reverts migrations & uninstalls assets)
RAILS_ENV=production rake chili_videos:uninstall
In your 'Rakefile', remove:
require 'tasks/chili_videos_tasks'
In your 'Gemfile', remove:
gem 'chili_videos'
Cycle your application server (mongrel, unicorn, whatevs)...
Then, uninstall the chili_videos gem:
gem uninstall chili_videos
Done.
CONTRIBUTING AND/OR SUPPORT:
Found a bug? Have a feature request?
Please file a ticket on the 'Issues' page of the Github project site
You can also drop me a message on Twitter @tomkersten.
Want to contribute?
(Better instructions coming soon)
- Fork the project
- Create a feature branch and implement your idea (preferably with tests)
- Update the History.txt file in the 'Next Release' section (at the top)
- Send a pull request
LICENSE:
Refer to the LICENSE file
Contributors (sorted alphabetically)
- Roy Kolak