Assistant-OverMail is an open-source Django application designed to simplify your workflow by emailing [email protected] (or any domain name if you self-host) and getting a response back from GPT-4.
You can use this to use GPT-4 privately, go around employers' blocks, or simply as a short-cut to deal with emails in the inbox. You can try it at: overmail.ai
For self-hosting. You will need Docker and Docker Compose for easy setup and deployment. The app integrates with Stripe for fiat payments, OpenNode for Bitcoin payments, and any mailing provider such mailgun, sendgrid, or AWS SES.
-
4/15/24: Removed unneccesary tailwinds, allauth dependency & custom Postgres Docker file
-
2/28/24: Example Nginx for self-hosting
-
2/27/24: Response now come back in markdown
-
2/22/24: You can now respond to the Assistant email for follow up on requests
Follow these steps to get Assistant-OverMail up and running:
- Clone the repository:
git clone https://github.com/jonathan-adly/assistant-overmail.git
cd assistant-overmail
- Set up environment variables:
Copy the .example.env
file to .env
or .dev.env
for development settings.
cp .example.env .env
-
Launch with Docker Compose:
- Ensure Docker and Docker Compose are installed on your machine.
- Build and start the containers in detached mode:
docker-compose up -d --build
After installation, configure the application by setting up the required environment variables in your .env
or .dev.env
file. This includes your Stripe API keys, OpenNode API keys, and mailing provider configurations.
With Assistant-OverMail running, access it through your browser or at localhost:8000. For production we recommend an Nginx and SSL configuration.
- Create a Stripe account and obtain your API keys.
- Add your Stripe API keys to your environment file.
- Setup a webhook endpoint
- Sign up for an OpenNode account to handle Bitcoin transactions.
- Configure your OpenNode API keys in the environment file.
- Choose a mailing provider (e.g., SendGrid, Mailgun) and set up an account.
- Configure your mailing provider's API keys and settings in the environment file.
- Setup mail receiving webhooks
We welcome contributions!
License
Assistant-OverMail is MIT licensed.