https://github.com/mbuchalik/b1gmail

📫 Host your own email service.
https://github.com/mbuchalik/b1gmail

Last synced: 5 days ago
JSON representation

📫 Host your own email service.

• Host: GitHub
• URL: https://github.com/mbuchalik/b1gmail
• Owner: MBuchalik
• License: gpl-2.0
• Created: 2021-12-03T12:45:32.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-03T11:58:22.000Z (11 months ago)
• Last Synced: 2024-04-18T06:19:12.626Z (9 months ago)
• Language: PHP
• Homepage:
• Size: 7.89 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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:

```php

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:

```php

define('DEV_MOCK_MAIL_SENDING', true);

```

## Migrating from one major release version to another

See [UPGRADE.md](UPGRADE.md).