Enigmamachine 技术文档

1. 安装指南

Enigmamachine 是一个基于 Ruby 语言和 Sinatra 框架开发的 RESTful 视频处理工具。以下是安装步骤：

• 确保系统中已安装 Ruby、rubygems 和 ffmpeg。

• 使用以下命令安装必需的依赖项（以 root 用户身份）：

  apt-get install rubygems ruby1.8-dev libopenssl-ruby build-essential libsqlite3-dev ffmpeg
  

• 将以下路径添加到 ~/.bashrc 文件中：

  export PATH=/var/lib/gems/1.8/bin:$PATH
  

• 使用 gem 命令安装 Enigmamachine：

  gem install enigmamachine
  

• 确保 ffmpeg 已安装并可在路径中访问。

2. 项目的使用说明

安装完成后，可以通过以下步骤使用 Enigmamachine：

• 创建一个新目录并进入：

  mkdir enigma
  cd enigma
  

• 启动 Enigmamachine 服务：

  enigmamachine start  # 使用 `-d` 选项以守护进程模式运行
  

• 在浏览器中访问 http://localhost:2002，可以配置 Enigmamachine 并检查其状态。

3. 项目API使用文档

Enigmamachine 提供了一个 RESTful API，以下是一个简单的使用示例：

• 发送 POST 请求以添加视频到编码队列：

  POST http://localhost:2002/videos
  

  请求参数包括：

  • video[file]: 本地文件系统中视频文件的完整路径。
  • video[callback_url]: 可选的回调 URL。
  • encoder_id: 在 Enigmamachine 数据库中定义的编码器 ID。

• 使用 Ruby 编写客户端代码：

  require 'rubygems'
  require 'httparty'
  
  class EnigmaClient
    include HTTParty
    base_uri "localhost:2002"
  
    def initialize(u, p)
      @auth = encode_credentials(u, p)
    end
  
    def post(path_to_video, encoder_id, callback_url)
      self.class.post("/videos", {
        body: {
          video: {
            file: path_to_video,
            callback_url: callback_url
          },
          encoder_id: encoder_id
        },
        basic_auth: @auth
      })
    end
  
    private
  
    def encode_credentials(username, password)
      { username: username, password: password }
    end
  end
  

• 使用 wget 工具（不推荐，存在安全风险）：

  wget http://admin:admin@localhost:2002/videos --post-data 'video[file]=/path/to/your/video.mp4&video[callback_url]=http://example.org/call/back/id&encoder_id=1'
  

4. 项目安装方式

Enigmamachine 可以通过以下方式安装：

• 使用 Ruby 的 gem 命令：

  gem install enigmamachine
  

• 确保系统中已安装所有必需的依赖项，如 Ruby、rubygems、ffmpeg 等。

• 按照上述安装指南完成安装过程。

通过以上步骤，您可以成功安装并使用 Enigmamachine。请确保在安全的环境中使用，并遵循最佳实践以避免潜在的安全风险。