Skip to content

Commit 35c3756

Browse files
committed
Update README.md
1 parent b2beb40 commit 35c3756

File tree

1 file changed

+48
-6
lines changed

1 file changed

+48
-6
lines changed

README.md

Lines changed: 48 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ You can run MailMan in two different modes:
1818
There are two types of users: the admin users and the mail users.
1919

2020
#### Admin features
21-
- TODO Create, edit and delete users (both admins and mail users)
22-
- TODO Create invite tokens/links
23-
- TODO Create mail aliases
24-
- TODO Create blacklists for usernames
25-
- TODO Create muptiple mail domains
21+
- Create, edit and delete users (both admins and mail users)
22+
- Create invite tokens/links
23+
- Create mail aliases
24+
- Create blacklists for usernames
25+
- Create muptiple mail domains
2626

2727
#### User features
28-
- TODO Change own password
28+
- Change own password
2929
- TODO See account details
3030
- TODO Configure aliases
3131

@@ -36,5 +36,47 @@ There are two types of users: the admin users and the mail users.
3636
- Postfix
3737
- Dovecot
3838

39+
## Installation
40+
### General
41+
1. Clone this repository.
42+
2. Set up a webserver with PHP7.2 or above and all the Laravel dependancies.
43+
3. Configure the document root of the webserver to point to the ` public ` directory of this repository.
44+
4. Install the Composer software and run ` composer update ` while being in the root directory of this repository.
45+
5. Copy or rename the ` .env.example ` file to ` .env ` and edit the file to contain your correct database credentials, timezone and so on.
46+
6. Run ` php artisan migrate:fresh ` to create the database structure.
47+
7. Run ` php artisan db:seed ` to create a default admin user.
48+
49+
### Postfix
50+
1. Copy the .cf files from the ` postfix ` directory from this repository into your local postfix configuration directory (e.g. `/etc/postfix/`)
51+
2. Add the following lines to the `main.cf` file of your local Postfix config directory (assuming you are using MySQL or MariaDB):
52+
```
53+
virtual_mailbox_domains = mysql:/etc/postfix/mailman-domains.cf
54+
virtual_mailbox_maps = mysql:/etc/postfix/mailman-users.cf
55+
virtual_alias_maps = mysql:/etc/postfix/mailman-aliases.cf
56+
```
57+
3. Edit each of those three files so that they conatin the correct database credentials.
58+
4. Restart or reload the Postfix service: e.g. ` postfix reload `
59+
60+
### Dovecot
61+
Go to your Dovecot config directory on your system (e.g. ` /etc/dovecot/ `) and add the following lines to the ` dovecot-sql.conf.ext ` file:
62+
```
63+
driver = mysql
64+
connect = host=127.0.0.1 dbname=dbname user=dbusername password=dbpassword
65+
default_pass_scheme = SHA512-CRYPT
66+
password_query = SELECT * FROM (SELECT CONCAT(u.username, '@', d.name) as user, password FROM users u JOIN domains d ON (u.domain_id=d.id)) x WHERE user='%u';
67+
```
68+
Don't forget to replace the placeholders in the line starting with ` connect ` with your correct database credentials.
69+
70+
## Default admin login credentials
71+
Admin-login page: ` /admin `
72+
73+
Username: ` admin `
74+
75+
Password: ` admin `
76+
77+
78+
Make sure to change the administrator password IMMEDEATELY after installation!
79+
80+
3981
## License
4082
This project is licensed under the GNU General Public License Version 3 - see the LICENSE file for details.

0 commit comments

Comments
 (0)