less swearing and first public push

1 files changed, 76 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..43cee6d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# Helper-EmailProxy
+
+Welcome to Emailproxy-UI! The extra helping hand of scuffed code that hopefully makes your EmailProxy experience less of a dumpster fire.
+
+For now only able to do Office 365 Accounts and that uhm just barely but feel free to have a go at making it do other 2FA terribleness E-Mail services work too.
+
+## Project "Structure"
+(I've included this section because that's what "professionals" do, but we both know this is barely structured chaos)
+
+### The Core Confusion
+- `emailproxy-ui.py`: A Python script that pretends to know what it's doing with authentication processes
+- `emailproxy-ui.php`: The PHP frontend because I love making myself suffer with PHP 
+- `config/`: Where configuration files go to hide from responsibility
+- `logs/`: Divided into three categories of depression:
+  - `python/`: Where Python screams into the void
+  - `php/`: PHP's personal diary of failures
+  - `nginx/`: Nginx complaining about both of the above
+
+### Helpers
+- `helpers/`: Contains useful scripts that will probably break something
+  - `update-paths.sh`: Updates paths so they all point to the wrong places, but consistently
+
+## Getting Started
+Cool, I don't care. What can it do and how do I use it?
+
+This abomination helps you authenticate with Microsoft for EmailProxy without manually going through the hell that is copying/pasting authentication URLs. It gives you a web UI that works most of the time.
+
+### TL;DR
+
+You can use any old crappy email client again with your companies terrible E-Mail provider (Office 365 / Outlook)
+
+### What do you need to get started?
+
+- Install Python and PHP on whatever potato you have lying around
+- Install EmailProxy (how? uhm will make a guide someday TM)
+- Basic understanding of how EmailProxy works (if you want to use something else than MS email stuff)
+
+### Run test instance of it in 69 easy steps (actually just 5)
+1. Update your paths with `cd helpers && ./update-paths.sh` and edit and server IP's etc. `nano config/config.env`
+2. Install emailproxy with pipx `pipx install emailproxy`
+3. Deploy the nginx config somehow and run the backend `./emailproxy-ui.py`
+3. Access the web interface at: `http://your-server:8080/`
+
+And voilà! You now have a test instance to poke arround with.
+
+## Features
+- **Web UI**: ... Do i need to say more ?
+- **MS Pissing off**: Gain ability to use unencrypted mail protocols for the true ms pissing off experience
+- **Log "Management"**: Totally dont rely on them for the code to work
+- **Path Configuration**: Automatically fixes (or breaks) all your paths in one go!
+
+## How it Works (If it does)
+1. User enters their email and password in the web UI
+2. The Python script launches a temporary EmailProxy instance
+3. The PHP code pretends to know what it's doing
+4. Magic happens (or errors occur)
+5. Authentication URL is magically extracted and displayed to the user to authenticate
+6. User gets authenticated after pasting his not spoofed and repurposed Thunderbird return URL and gets displayed the correct configs for mail server
+
+## Contributing
+You can contribute if you want... but I doubt anyone would willingly touch this.
+
+bahahashbdasjhdashjdhj
+
+## License
+This project is licensed under the "I Can't Believe It Actually Runs" License.
+
+Basically:
+- No warranty.
+- No responsibility.
+- I barely know what I'm doing.
+- If this breaks your email, that's on you (in honesty it shouldn't though, most likely will just piss of your E-Mail adminier).
+
+Made with tolerance for Python, love for PHP, and pure disgust for OAuth by T.B ❤️ 🚀
+
+PS: There's minimal commit history because of using questianble language in it which ive ommited. You're welcome.
\ No newline at end of file