README.en.md

🛠️ Marreta

Marreta is a tool that breaks access barriers and elements that hinder reading!

Public instance at marreta.pcdomanual.com!

✨ What's Cool?

• Automatically cleans and corrects URLs
• Removes annoying tracking parameters
• Forces HTTPS to keep everything secure
• Changes user agent to avoid blocking
• Leaves HTML clean and optimized
• Fixes relative URLs on its own
• Allows you to add your own styles and scripts
• Removes unwanted elements
• Caching, caching!
• Blocks domains you don't want
• Allows configuring headers and cookies your way
• PHP-FPM and OPcache

🐳 Installing with Docker

Install Docker and Docker Compose

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

Now modify with your preferences:

nano docker-compose.yml

services:
  marreta:
    container_name: marreta
    image: ghcr.io/manualdousuario/marreta:latest
    ports:
      - "80:80"
    environment:
      - SITE_NAME=
      - SITE_DESCRIPTION=
      - SITE_URL=
      - LANGUAGE=

• SITE_NAME: Name of your Marreta
• SITE_DESCRIPTION: Explain what it's for
• SITE_URL: Where it will run, full address with https://. If you change the port in docker-compose (e.g., 8080:80), you must also include the port in SITE_URL (e.g., https://yoursite:8080)
• SELENIUM_HOST: Server:PORT of Selenium host (e.g., selenium-hub:4444)
• LANGUAGE: pt-br (Brazilian Portuguese), en (English), es (Spanish), de-de (German), ru-ru (Russian)

Now just run docker compose up -d

More configurations:

• Selenium: https://github.com/manualdousuario/marreta/wiki/%F0%9F%92%BB-Selenium-Hub-(Chrome-and-Firefox)
• S3 Cache: https://github.com/manualdousuario/marreta/wiki/%F0%9F%97%83%EF%B8%8F-Cache-S3
• Maintenance: https://github.com/manualdousuario/marreta/wiki/%F0%9F%9B%A0%EF%B8%8F-Maintenance

🚀 Integrations

• 🤖 Telegram: Official Bot
• 🦊 Firefox: Extension by Clarissa Mendes - Download | Source Code
• 🌀 Chrome: Extension by Clarissa Mendes - Download | Source Code
• 🦋 Bluesky: Bot by Joselito - Profile | Source Code
• 🍎 Apple: Integration with Shortcuts

---

Made with ❤️! If you have questions or suggestions, open an issue and we'll help! 😉

Special thanks to the projects Burlesco and Hover which served as the basis for many rules!

Star History