Transloadit

Exportar arquivos para servidores SFTP

🤖/sftp/store exporta resultados de codificação para o seu próprio servidor SFTP.

/sftp/store Robot

Exemplo de uso

Exporte arquivos carregados por upload para my_target_folder em um servidor SFTP:

{
  "steps": {
    "exported": {
      "credentials": "YOUR_SFTP_CREDENTIALS",
      "path": "my_target_folder/${unique_prefix}/${file.url_name}",
      "robot": "/sftp/store",
      "use": ":original"
    }
  }
}

Parâmetros

  • interpolate

    boolean | Record<string, boolean>

    Controla se as Assembly Variables são interpoladas em campos individuais de instruções.

    Por padrão, a maioria dos campos de instruções dos Robots interpola Assembly Variables. Defina isso como false para tratar todos os campos de instruções como texto literal, ou defina o caminho de um campo individual como false para tratar apenas esse campo como texto literal. Para campos específicos de um Robot que são literais por padrão, defina isso como true ou defina o caminho desse campo como true para voltar a usar a interpolação.

    Use nomes de campos como path ou caminhos com pontos como ffmpeg.vf para objetos aninhados.

  • output_meta

    Record<string, boolean> | boolean | Array<string>

    Permite especificar um conjunto de metadados cujo cálculo exige mais CPU e que, por isso, vem desativado por padrão para manter o processamento das suas Assemblies rápido.

    Para imagens, você pode adicionar "has_transparency": true neste objeto para extrair se a imagem contém partes transparentes e "dominant_colors": true para extrair um array de códigos de cores hexadecimais da imagem.

    Para imagens, você também pode adicionar "blurhash": true para extrair uma string BlurHash — uma representação compacta de um placeholder da imagem, útil para exibir uma prévia desfocada enquanto a imagem completa carrega.

    Para vídeos, você pode adicionar o parâmetro "colorspace": true para extrair o espaço de cores do vídeo de saída.

    Para vídeos, você também pode adicionar "interlaced": true para detectar se o vídeo é entrelaçado. Isso combina a flag computacionalmente barata field_order do ffprobe com uma passagem de amostragem idet limitada sobre os primeiros quadros da origem, expondo interlaced, field_order e um objeto de diagnóstico interlace_detection em file.meta. Isso é computacionalmente caro e cobrado de acordo.

    Para áudio, você pode adicionar "mean_volume": true para obter um único valor que representa o volume médio do arquivo de áudio.

    Você também pode definir isso como false para pular a extração de metadados e acelerar a transcodificação.

  • user_meta

    Record<string, any>(padrão: {})

    Adiciona metadados JSON personalizados a cada arquivo emitido sem modificar seu conteúdo. Objetos e arrays aninhados são suportados.

    A herança depende do Robot. Os valores são mesclados com o user_meta existente no arquivo de saída; o Step atual substitui as chaves de nível superior com o mesmo nome. Atribua explicitamente as chaves necessárias quando um Robot criar novas saídas.

    Nos Steps de processamento, ${file.*} se refere à primeira entrada e ${result.*} ao arquivo emitido. Os valores são avaliados para cada saída após a execução do Robot, antes da extração subsequente de metadados e do armazenamento temporário. Em :original, os valores são avaliados para cada upload antes da extração de metadados.

    Os Steps subsequentes leem ${file.user_meta.key}. Consulte Metadados personalizados para ver um exemplo completo e as regras de herança.

  • result

    boolean(padrão: false)

    Se os resultados deste Step devem estar presentes no Assembly Status JSON

  • queue

    batch

    Definir a fila como “batch” rebaixa manualmente a prioridade dos Jobs deste Step, para evitar o consumo de vagas prioritárias de Jobs em Jobs que não precisam de tempo zero de espera na fila

  • force_accept

    boolean(padrão: false)

    Forçar um Robot a aceitar um tipo de arquivo que ele teria ignorado.

    Por padrão, os Robots ignoram arquivos que não conhecem. O 🤖/video/encode, por exemplo, ignora tranquilamente imagens de entrada.

    Com o parâmetro force_accept definido como true, você pode forçar os Robots a aceitar todos os arquivos enviados a eles. Isso normalmente leva a erros e só deve ser usado para depuração ou para lidar com casos extremos.

  • ignore_errors

    boolean | Array<meta | execute>(padrão: [])

    Ignorar erros durante fases específicas do processamento.

    Definir isso como ["meta"] fará com que o Robot ignore erros durante a extração de metadados.

    Definir isso como ["execute"] fará com que o Robot ignore erros durante a fase principal de execução.

    Definir isso como true equivale a ["meta", "execute"] e fará com que erros sejam ignorados nas duas fases.

  • use

    string | Array<string> | Array<object> | object

    Especifica quais Steps usar como entrada.

    • Você pode escolher qualquer nome para os Steps, exceto ":original" (reservado para uploads de usuários tratados pela Transloadit)
    • Você pode fornecer vários Steps como entrada usando arrays: 
      {
  "use": [
    ":original",
    "encoded",
    "resized"
  ]
}
    • Você também pode marcar os Steps de entrada com as para transmitir intenção semântica aos Robots: 
      {
  "use": [
    {
      "name": ":original",
      "as": "image"
    },
    {
      "name": ":original",
      "as": "mask"
    }
  ]
}

  • credentials

    string

    Crie suas credenciais de Template associadas na sua conta da Transloadit e use o nome das suas credenciais de Template como valor deste parâmetro. Elas conterão os valores do seu host SFTP, usuário e chave pública personalizada opcional.

    Embora recomendemos sempre usar credenciais de Template, alguns casos de uso exigem credenciais dinâmicas, para as quais o uso de credenciais de Template é pouco prático devido à sua natureza estática. Se você tiver esse requisito, pode usar os seguintes parâmetros em vez delas: "host", "port", "user", "public_key" (opcional).

  • port

    string | number(padrão: 21)

    A porta a ser usada na conexão FTP.

  • path

    string(padrão: "${unique_prefix}/${file.url_name}")

    O caminho no qual o arquivo será armazenado. Pode incluir quaisquer Assembly Variables disponíveis.

  • url_template

    string(padrão: "http://host/path")

    A URL do arquivo no JSON de resultado. Pode incluir qualquer uma das seguintes Assembly Variables compatíveis.

  • ssl_url_template

    string(padrão: "https://{HOST}/{PATH}")

    A URL SSL do arquivo no JSON de resultado. As seguintes Assembly Variables são compatíveis.

  • file_chmod

    string(padrão: "auto")

    Este parâmetro opcional controla como os bits de permissão de um arquivo enviado por upload são definidos. Você pode usar qualquer formato de string aceito pelo comando chmod, como "755". Se você não especificar esta opção, os bits de permissão do arquivo não serão alterados, ou seja, dependerão da configuração do seu servidor (por exemplo, umask).

Demonstrações

Publicações relacionadas no blog