🌐 Priconf

⚠️ Work In Progres

Currently a hard coded Firefox Browser Web Extension for having a unified configuration to your alternate Frontends of favourite services. The extension automatically reloads the page of specified Frontend instances and injects consistent settings and themes, ensuring a uniform experience across all hosted instances.

🔥 Motivation

The LibReddit instances I used from LibRedirect used to have different settings for different instances. I wanted all the instances that I use to have same settings. So, here is the basic Web Extension I created over the weekend. Over time, I expanded this functionality to different alternate frontends.

📖 Table of Contents

• ✨ Features
• 🛣️ Roadmap
• 🚀 Installation
• 🔧 Configuration
• 🛠️ Usage
• 🗑️ Uninstall
• 🐛 Bugs or Requests
• 🤝 Contributing
• 📄 License
• 🙏 Acknowledgments

✨ Features

• Uniformity: Injects predefined settings and themes for a consistent user experience for selected fronent instances.
• Automatic Page Reload: Automatically reloads the selected instance page when accessed to inject preferences.
• Multiple Instances: Supports various hosted instances of different FroneEnd services, allowing users to switch seamlessly.
• Currently Supported Frontends:
  • LibReddit
  • SearXNG
  • AnonymousOverflow
  • Piped
  • Nitter
  • LibreMDB
  • Quetre

🛣️ Roadmap

• Add UI
• Take instances input from User
• Allow User to configure settings via UI

🚀 Installation

Curently you will have to hard code your settings and use it in Debugging Mode.

• Clone the repository:

  git clone https://github.com/jollySleeper/priconf.git
  cd priconf

• Adjust your Settings: Hard code your settings for specific instances in priconf.js. See configuration for more details.
• Load the extension in Firefox:
  • Open Firefox and navigate to about:debugging#/runtime/this-firefox.
  • Click on "Load Temporary Add-on".
  • Select the manifest.json file from the cloned repository.

🔧 Configuration

The settings for each alternate frontend can be found in the priconf.js file. Change myInstances variable for each alternate frontend fuction to apply preferences to your select instances.

Example configuration:

function libreddit() {
    const myInstances = [
        "https://libreddit.kavin.rocks",    // Instance 1
        "https://libreddit.pussthecat.org", // Instance 2
    ];

    // Preferred Settings 
}

Above code snippet will apply your preferred configuration to the following instances.

🛠️ Usage

Once the extension is installed, it will automatically reload the instances that you visit which are configured and apply the specified settings.

🗑️ Uninstall

If you decide to uninstall, we're sorry to hear that priconf didn't meet your expectations. We appreciate your feedback. To uninstall, head to about:addons in Firefox Browser and remove the the Priconf add-on installed. Also, delete the Priconf folder using rm -r priconf command.

🐛 Bugs or Requests

If you encounter any problem(s) feel free to open an issue. If you feel the project is missing a feature, please raise an issue with FeatureRequest as heading.

🤝 Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/YourFeature).
3. Make your changes and commit them (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature/YourFeature).
5. Open a pull request.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Thank you for all the contributers, contributing to any of above mentioned projects.