https://github.com/douxxtech/marechan
Marechan is a 100% selfhosted AI that replies to your mails
https://github.com/douxxtech/marechan
Last synced: 8 months ago
JSON representation
Marechan is a 100% selfhosted AI that replies to your mails
- Host: GitHub
- URL: https://github.com/douxxtech/marechan
- Owner: douxxtech
- License: gpl-3.0
- Created: 2025-03-23T15:42:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-09T05:23:00.000Z (about 1 year ago)
- Last Synced: 2025-08-19T13:57:20.250Z (10 months ago)
- Language: Python
- Size: 35.2 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chat with Marechan !
To directly try marechan, send an email to [marechan@mc.theserver.life](mailto:marechan@mc.theserver.life)
## 1. How to setup
1. To setup marechan, first clone this repository.
> Note: DKIM is not set up, so maybe Gmail outlook etc clients won't get our mails
```
git clone https://github.com/douxxtech/marechan
```
2. Navigate to the cloned project and then install the requirements. Make sure you have python3 and pip3 installed.
```
cd marechan
pip3 install -r requirements.txt
```
3. Edit the configuration file and the assistant file
- config.conf: You can here edit some specific things, and setup the logs via discord webhook
- assistants.json: here you can edit all your assistants, with their prompts. Prompt enhancments are provided by [utils/prompt_enhancer.py](utils/prompt_enhancer.py)
4. Make the marechan file executable:
On linux:
```
chmod +x marechan.py
```
5. Transport the mail to marechan, the mail imput should go in the STDIN of the file.
> It depends on the mail server you are using, so no specific tutorial here.
## 2. Need help ?
Configurating can be a bit hard, so please open an issue if you need any help.
## LICENSE
Licensed under GPL-3.0