Welcome to Amara’s documentation!

Contents:

• Running Amara
• Reporting bugs
• API Documentation
  • Overview
    • Authentication
    • Data Formats
    • Paginated Responses
    • Browser Friendly Endpoints
    • Value Formats
    • Use HTTPS
    • API interaction overview
    • API Changes / Versioning
  • Languages
    • Languages Resource
  • Videos
    • Videos Resource
    • Video URL Resource
  • Subtitles
    • Subtitle Language Resource
    • Subtitles Resource
    • Subtitle Actions Resource
    • Subtitle Notes Resource
  • Users
    • Users Resource
    • User Identifiers
    • User fields
  • Activity
    • Video Activity Resource
    • Team Activity Resource
    • User Activity Resource
    • Activity Types
    • Legacy Activity Resource
  • Messages
    • Message Resource
  • Teams
    • Team Resource
    • Members Resource
    • Projects Resource
    • Tasks Resource
    • Notifications Resource
    • Applications Resource
    • Preferred Languages Resource
    • Blacklisted Languages Resource
  • Subtitle Request Resource
    • Listing Requests
    • Request Details
    • Creating Requests
    • Updating Requests
    • Deleting Requests
    • Examples:
    • Endorsing Subtitles
  • Subtitle Request Resource (Multiple Teams)
    • Team Terminology
    • Request Status Fields
    • Listing Requests
    • Request Details
    • Creating Requests
    • Updating Requests
    • Deleting Requests
• Supported languages
• HTTP Callbacks for Teams
  • Notification Details
    • Video notifications
    • Team member notifications
• Babelsubs
  • Storage
  • Formatting
• Syncing and Importing
  • Youtube
    • User Accounts
    • Team Accounts
  • Kaltura
  • Brightcove
• Static Media
  • Settings
    • Example
    • MEDIA_BUNDLES
    • STATIC_MEDIA_COMPRESSED
    • STATIC_MEDIA_USES_S3
  • Compilation & Minification
  • Media Directory Structure
  • Development, Media Bundles, and Caching
  • In Templates
• Amara embedder
  • Usage
  • embedder-iframe.js
  • embedder.js
  • Dependencies
• Developer’s Guide
  • Development Workflow
    • Creating issues
    • Branches / Repositories
    • Git Submodules
    • Testing
    • Exception Logging
    • Code Review
    • Workflow
  • Testing
    • Running tests
    • GUI Tests
    • Javascript Tests
    • Writing unit tests
    • Writing GUI tests
    • Testers
  • Database Migrations
  • Caching
    • Varnish
    • Caching App
  • Tasks
  • Teams
    • Team Workflows
  • The Subtitle Editor
    • The Experimental Editor
  • Subtitle Workflows
    • Overriding workflows
    • Workflow Classes
    • Behavior Functions
    • Editor Notes
    • Work Modes
    • Actions
  • The permission system
    • Overview
    • Checking for required permissions
    • Workflows
  • Optional Apps
  • Internationalization (i18n)
    • Guidelines
    • Updating Django
    • Partners
  • Behaviors
  • CSS style guide
    • Overview
    • Terminology
    • Naming
    • Exceptions
    • Styleguide
    • Legacy code

Contributing

The source code to Amara is available on Github. Feel free to fork the project and open a pull request.

Before working on a sizeable feature, please do run it by us in our IRC channel. We don’t want you to waste your time working on something we don’t really want. We are at #amara on freenode.

License

Amara is freely available under the terms of the GNU Affero General Public License. You can find the full text of the license here.

Indices and tables

• Index
• Module Index
• Search Page