Skip to content

Repository files navigation

🛠️ Marreta

en pt-br

PHP 8.4+ Laravel 13

Forks Stars Issues

Marreta é uma ferramenta que quebra barreiras de acesso e elementos que atrapalham a leitura!

Antes e depois do Marreta

Instancia publica em marreta.link!

✨ O que tem de legal?

  • Limpa e corrige URLs automaticamente
  • Remove parâmetros chatos de rastreamento
  • Força HTTPS pra manter tudo seguro
  • Deixa o HTML limpinho e otimizado
  • Conserta URLs relativas sozinho
  • Permite colocar seus próprios estilos e scripts
  • Remove elementos indesejados
  • Cache, cache!
  • Bloqueia domínios que você não quer
  • Proteção DMCA com mensagens personalizadas
  • Permite configurar headers e cookies do seu jeito
  • PHP-FPM e OPcache
  • Suporte a Proxy

🐳 Instalando em Docker

Instale Docker e Docker Compose

curl -o ./compose.yml https://raw.githubusercontent.com/manualdousuario/marreta/main/compose.yml

Agora modifique com suas preferencias:

nano compose.yml

  • APP_NAME: Nome do seu Marreta
  • APP_DESCRIPTION: Conta pra que serve
  • APP_URL: Onde vai rodar, endereço completo com https://. O container serve HTTP na porta 8080 e o compose.yml publica ela em 81 no host; se você mudar isso (ex: 8080:8080), inclua a porta também no APP_URL (ex: https://seusite:8080)
  • APP_LOCALE: pt-br (Português Brasil), en (Inglês), es (Espanhol) ou de-de (Alemão), ru-ru (Russo)
  • APP_KEY: opcional. Se ficar vazio, uma chave é gerada no primeiro boot e guardada no volume
  • DISABLE_CACHE: opcional. O cache de páginas vem ligado por padrão; coloque true para desligar
  • ADMIN_EMAIL: admin@marreta.local
  • ADMIN_PASSWORD: password

Agora só rodar docker compose up -d

⚠️ Breaking changes: migrando da 2.x pra 3.x

A partir da 3.0.0 o Marreta virou uma aplicação Laravel. É uma reescrita completa do zero, então não existe caminho de upgrade "no lugar", o recomendado é subir os containers novos e reconfigurar o essencial.

O que mudou

Variáveis de ambiente

Antes (2.x) Agora (3.x) Observação
SITE_NAME APP_NAME
SITE_DESCRIPTION APP_DESCRIPTION
SITE_URL APP_URL
LANGUAGE APP_LOCALE
DEBUG APP_DEBUG
APP_KEY Novo e obrigatório. Se deixar vazio, é gerada uma chave automaticamente no primeiro boot
SELENIUM_HOST BROWSER_WS_ENDPOINT Agora aponta pro Lightpanda (ws://marreta_browser:9222), não mais pro Selenium
DNS_SERVERS (removido)
CLEANUP_DAYS (removido)
LOG_LEVEL / LOG_DAYS_TO_KEEP (removido)
S3_CACHE_ENABLED / S3_* (removido)
ADMIN_EMAIL / ADMIN_PASSWORD Novo. Credenciais de login do painel /admin

Docker

  • Porta interna do container mudou de 80 pra 8080 (o compose.yml já publica em 81:8080 no host, ajuste se você tinha 80:80 mapeado).
  • Os bind mounts antigos (./app/cache e ./app/logs) deixaram de existir. Agora tudo (banco SQLite + cache) mora num volume nomeado, marreta_storage, montado em /var/www/html/storage/app.

Passo a passo pra migrar

  1. Antes de derrubar os containers antigos, anote as customizações que você tenha feito em app/data/domain_rules.php, app/data/blocked_domains.php e app/data/global_rules.php, e também os domínios cadastrados em app/cache/dmca_domains.json. Nada disso é migrado automaticamente.
  2. Baixe o novo compose.yml, APP_KEY (gere uma em laravel-encryption-key-generator.vercel.app), ADMIN_EMAIL e ADMIN_PASSWORD.
  3. Suba os containers com docker compose up -d. No primeiro boot, as migrations rodam e o banco é populado com o conjunto padrão de regras/domínios bloqueados que vêm com o Marreta.
  4. Acesse SEU_DOMINIO/admin, entre com ADMIN_EMAIL/ADMIN_PASSWORD e recadastre manualmente: suas regras de domínio customizadas, domínios bloqueados extras e domínios com DMCA que você tinha anotado no passo 1.

🚀 Integrações


Feito com ❤️! Se tiver dúvidas ou sugestões, abre uma issue que a gente ajuda! 😉

Agradecimento ao projeto Burlesco e Hover que serviu de base para varias regras!

Star History

Star History Chart

About

Uma ferramenta que quebra barreiras de acesso e elementos que atrapalham a leitura! / Marreta is a tool that removes access barriers and visual distractions!

Topics

Resources

Stars

1.2k stars

Watchers

8 watching

Forks

Releases

Packages

Used by

Contributors

Languages