MBuchalik / b1gmail

📫 Host your own email service.

b1gMail

Warning This project is work-in-progress. You should not use it in a production environment. There will be breaking changes.

Local development installation

To run a local development version, you first need a local web server. The recommended way is to use our Docker setup. Simply perform the following steps to start your local, Docker-powered development instance:

1. Clone the repository
2. Go to /dev/ and follow the instructions on how to run the Docker development server.
3. Open localhost:5000 in your web browser. The UI will guide you through the rest of the setup process.

After the installation, if you want to see detailed debug information like php errors and similar, open /src/config/config.php and add the following to it:

define('DEBUG', true);

Often, when developing locally, you don't want to actually send emails (and even deal with properly configuring email sending). Simply add the following to your config.php to replace the actual email sending with a mock that won't actually send the email:

define('DEV_MOCK_MAIL_SENDING', true);

Migrating from one major release version to another

See UPGRADE.md.