erin

Erin

Feed TikTok auto-hospedado para seus clipes
Crie um feed do TikTok com seus próprios vídeos

Introdução

Erin é um serviço simples e auto-hospedado que permite que você visualize seus próprios clipes usando o conhecido feed de deslizamento vertical do TikTok. Foi feito um pedido no Reddit para um aplicativo auto-hospedável que pudesse mostrar vídeos filtrados usando a interface do TikTok, então eu fiz isso.

Características

Erin tem todos esses recursos implementados:

• Exiba seus próprios vídeos usando o feed deslizante do TikTok
• Mascare os vídeos que você não quer ver no seu feed*
• Escolha qual feed (playlist) você deseja reproduzir**
• Reproduza automaticamente seu feed sem precisar deslizar
• Procure avançar e retroceder usando o teclado ou com toques duplos
• Entre / saia da tela cheia com um toque duplo no centro
• Mostre metadados de vídeo usando a UI do TikTok***
• Mecanismo simples de carregamento lento para seus vídeos
• Nomeação automática de clipes com base no nome do arquivo
• Segurança simples e opcional usando uma senha mestra
• Suporte para HTTP e HTTPS
• Suporte para implantação de Docker/proxy

Além disso, observe que Erin é apenas um aplicativo React desenvolvido inteiramente pela Caddy. Caddy cuida da autenticação, servindo arquivos estáticos e servindo o aplicativo React, tudo de uma vez.

*: Você pode mascarar vídeos para ocultá-los do seu feed. Caso queira ver quais vídeos foram mascarados, e até mesmo desmascará-los, você pode manter pressionado o botão Mask e o gerenciador será aberto.

**: Por padrão, Erin criará um feed aleatório de todos os vídeos da sua pasta e seus subdiretórios. No entanto, se desejar criar feeds personalizados (listas de reprodução), você pode criar subdiretórios e organizar seus vídeos de acordo. Por exemplo: https://my-server.tld/directory-a criará um feed a partir dos vídeos localizados no /directory-a e funcionará com qualquer caminho (portanto, pastas aninhadas são suportadas).

***: Você pode mostrar um canal (com avatar e nome), uma legenda e um link para todos os seus vídeos usando um arquivo de metadados. O arquivo de metadados pode estar localizado em qualquer lugar dentro da pasta de vídeos e deve corresponder ao nome do arquivo do vídeo associado, substituindo a extensão por JSON. Por exemplo: my-video.mp4 pode ter seus metadados em my-video.json . O formato dos metadados é mostrado aqui e observe que você pode usar HTML bruto na legenda para estilos e efeitos personalizados.

Para obter mais informações, leia sobre Configuração.

Implantação e exemplos

Antes de continuar, independentemente do Docker, do Docker Compose ou de uma implantação autônoma, certifique-se de ter criado um diretório videos contendo todos os seus arquivos de vídeo. Posteriormente, este diretório será disponibilizado para sua instância de Erin (vinculando um volume ao seu contêiner Docker ou colocando o diretório próximo ao seu Caddyfile).

Implantar com Docker

Você pode executar Erin com Docker na linha de comando muito rapidamente.

Você pode usar os seguintes comandos:

 # Create a .env file
touch .env

# Edit .env file ...

# Option 1 : Run Erin attached to the terminal (useful for debugging)
docker run --env-file .env -p < YOUR-PORT-MAPPING > -v ./videos:/srv/videos:ro mosswill/erin

# Option 2 : Run Erin as a daemon
docker run -d --env-file .env -p < YOUR-PORT-MAPPING > -v ./videos:/srv/videos:ro mosswill/erin

Nota: Um arquivo sample.env está localizado na raiz do repositório para ajudá-lo a começar

Nota: Ao usar docker run --env-file , certifique-se de remover as aspas em torno de AUTH_ENABLED e AUTH_SECRET , caso contrário seu contêiner poderá travar devido à interpolação inesperada e conversões de tipo operadas pelo Docker nos bastidores.

Implantar com Docker Compose

Para ajudá-lo a começar rapidamente, alguns exemplos de arquivos docker-compose estão localizados no diretório "examples/".

Aqui está uma descrição de cada exemplo:

• docker-compose.simple.yml : Execute Erin como um serviço frontal na porta 443, com variáveis ​​de ambiente fornecidas diretamente no arquivo docker-compose .

• docker-compose.proxy.yml : Uma configuração com Erin rodando na porta 80, atrás de um proxy escutando na porta 443.

Quando seu arquivo docker-compose estiver correto, você pode usar os seguintes comandos:

 # Run Erin in the current terminal (useful for debugging)
docker-compose up

# Run Erin in a detached terminal (most common)
docker-compose up -d

# Show the logs written by Erin (useful for debugging)
docker logs < NAME-OF-YOUR-CONTAINER > 

Configuração

Para executar Erin, você precisará definir as seguintes variáveis ​​de ambiente em um arquivo .env :

Nota: variáveis ​​de ambiente regulares fornecidas na linha de comando também funcionam

Nota: Um arquivo sample.env está localizado na raiz do repositório para ajudá-lo a começar

Parâmetro	Tipo	Descrição	Padrão
PUBLIC_URL	boolean	A URL pública usada para acessar remotamente sua instância de Erin. (Inclua HTTP/HTTPS e a porta se não for o padrão 80 ou 443. Não inclua uma barra final) (Leia a documentação oficial do Caddy)	https://localhost
AUTH_ENABLED	string	Se a autenticação básica deve ser habilitada. (Este parâmetro diferencia maiúsculas de minúsculas) (Valores possíveis: verdadeiro, falso)	verdadeiro
AUTH_SECRET	string	O hash seguro da senha usada para proteger sua instância de Erin.	Hash de secure-password
APP_TITLE	string	O título personalizado que você gostaria de exibir na guia do navegador. (Dica: você pode usar [VIDEO_TITLE] aqui se quiser que Erin exiba dinamicamente o título do vídeo atual.)	Erin - feed do TikTok para seus próprios clipes
AUTOPLAY_ENABLED	boolean	Se a reprodução automática deve ser ativada. (Este parâmetro diferencia maiúsculas de minúsculas) (Valores possíveis: verdadeiro, falso)	falso
PROGRESS_BAR_POSITION	string	Onde a barra de progresso deve estar localizada na tela. (Este parâmetro diferencia maiúsculas de minúsculas) (Valores possíveis: inferior, superior)	fundo

Dica: Para gerar um hash seguro para sua instância, use o seguinte comando:

docker run caddy caddy hash-password --plaintext " your-new-password "

Nota: Ao usar variáveis ​​de ambiente docker-compose.yml , se o hash da sua senha contiver cifrões: dobre todos eles, caso contrário o aplicativo irá travar. Por exemplo: $ab$cd$efxyz torna-se $$ab$$cd$$efxyz . Isso se deve a advertências com o sistema de interpolação de strings docker-compose .

Solucionar problemas

Se você encontrar algum problema ao executar o Erin, consulte os seguintes problemas comuns que podem ocorrer.

Se nada disso corresponder ao seu caso, sinta-se à vontade para abrir um problema.

Erin está inacessível por HTTP/HTTPS

Erin fica no topo de um servidor web Caddy.

Como resultado :

• Você pode solucionar melhor o problema lendo os logs do contêiner.
• Você pode verificar a documentação oficial do Caddy sobre endereços.
• Você pode verificar a documentação oficial do Caddy sobre HTTPS.

Fora isso, certifique-se de que os seguintes requisitos sejam atendidos:

• Se Erin for executado como um aplicativo independente sem proxy:

  • Certifique-se de que seu servidor/firewall aceita conexões de entrada na porta de Erin.
  • Certifique-se de que sua configuração de DNS esteja correta. (Normalmente, esse registro deve ser suficiente: A erin XXX.XXX.XXX.XXX para https://erin.your-server-tld )
  • Certifique-se de que seu arquivo .env esteja bem configurado de acordo com a seção Configuração.

• Se Erin for executado dentro do Docker/atrás de um proxy:

  • Execute primeiro as verificações anteriores (autônomas).
  • Certifique-se de que PUBLIC_URL esteja bem definido em .env .
  • Verifique suas regras de encaminhamento de proxy.
  • Verifique a configuração da rede Docker.

Em qualquer caso, a parte crucial é a configuração e a leitura da documentação oficial do Caddy.

Erin diz que nenhum vídeo foi encontrado no meu servidor

Para que Erin forneça seus arquivos de vídeo, eles devem respeitar os seguintes requisitos:

• A extensão do arquivo é .mp4 , .ogg , .webm . (Existem as únicas extensões suportadas por navegadores da web.)
• Os arquivos estão localizados em /srv/videos no seu contêiner Docker usando um volume.

Para ter certeza de que seus vídeos estão dentro do contêiner Docker e no lugar certo, você pode:

• Execute docker exec -it <NAME-OF-YOUR-CONTAINER> sh
• Dentro do shell recém-aberto, execute: ls /srv/videos
• Você deve ver seus arquivos de vídeo aqui. Caso contrário, verifique sua ligação de volume.

Se Erin ainda não conseguir encontrar seus vídeos apesar de tudo estar bem configurado, abra um problema incluindo a saída do console Javascript do seu navegador e da guia de rede quando a solicitação for para /media/ . Pode ter a ver com cache do navegador, configuração inválida ou credenciais inválidas.

Como posso adicionar novos vídeos ao meu feed?

Por enquanto, você deve apenas colocar seus novos arquivos de vídeo no diretório de vídeos montado com Docker. Erin coletará automaticamente esses novos arquivos e, quando você atualizar o navegador, você os verá.

Como devo nomear meus arquivos de vídeo?

Erin traduzirá automaticamente o nome do seu arquivo em um título para exibir na interface.

A conversão operada é a seguinte:

• - torna-se
• __ se torna -

Aqui estão alguns exemplos para ajudá-lo a nomear seus arquivos:

• Vegas-trip__Clip-1.mp4 torna-se Vegas trip - Clip 1
• Spanish-language__Lesson-1.mp4 torna-se Spanish language - Lesson 1
• Spiderman-1.ogg torna-se Spiderman 1

Em que ordem meus arquivos aparecerão no feed?

Erin embaralha aleatoriamente seus arquivos de vídeo a cada atualização do navegador.

Como resultado, não há uma ordem específica para seus vídeos aparecerem.

Alguns dos meus vídeos parecem estar faltando ou nem carregados

Por enquanto, Erin tentará apenas recuperar os vídeos que possuem uma extensão compatível.

As extensões suportadas são: .webm , .mp4 e .ogg .

No entanto, observe que o Safari não parece suportar .ogg , portanto, esses vídeos serão ignorados para usuários do Safari.

Se você tiver algum conselho ou ideia para oferecer suporte a mais extensões (especialmente para usuários do Safari), sinta-se à vontade para abrir um problema.

Minha senha personalizada não funciona

Parece haver algumas ressalvas ao usar o Docker/Docker Compose com hashes de senha gerados pelo Caddy.

Estas são as regras que você deve seguir:

• Se você implantou Erin usando o Docker CLI, por meio do comando docker run ... --env-file .env ... , então seu AUTH_SECRET não deverá ter nenhuma cotação e todos os cifrões deverão permanecer como estão, sem escape ou duplicando
• Se você implantou Erin usando Docker Compose, por meio de um arquivo docker-compose.yml , seu AUTH_SECRET deverá ter seus cifrões duplicados. Exemplo: i$am$groot torna-se i$$am$$groot .

Dito isto, lembre-se que o hash da sua senha deve ser gerado com o seguinte comando:

docker run caddy caddy hash-password --plaintext " your-new-password " 

Outra coisa

Sinta-se à vontade para abrir um problema, explicando o que acontece e descrevendo seu ambiente.

Créditos

Ei, ei! É sempre uma boa ideia agradecer e mencionar as pessoas e projetos que nos ajudam a seguir em frente.

Muito obrigado aos indivíduos/equipes por trás desses projetos:

• tik-tok-clone: ​​para a interface básica do TikTok e interação suave.
• Caddy: Para o servidor web leve e poderoso.
• Os inúmeros outros!

E não esqueça de mencionar a Erin se você gostou ou se isso te ajuda de alguma forma!