Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
martbock committed Jul 29, 2018
0 parents commit 149d002
Show file tree
Hide file tree
Showing 351 changed files with 192,269 additions and 0 deletions.
87 changes: 87 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
APP_NAME=MUM
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost
TIMEZONE=Europe/Berlin

LOG_CHANNEL=stack

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=homestead
DB_USERNAME=homestead
DB_PASSWORD=secret

BROADCAST_DRIVER=log
CACHE_DRIVER=file
SESSION_DRIVER=file
SESSION_LIFETIME=120
QUEUE_DRIVER=sync

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

MAIL_DRIVER=smtp
MAIL_HOST=localhost
MAIL_PORT=587
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null

# PASSWORD_MIN_LENGTH=8
# VALIDATE_LOCAL_PART=true
# ALLOW_UNICODE_LOCAL_PART=true
# VALIDATE_DOMAIN=true
# VALIDATE_DOMAIN_AS_HOSTNAME=false

# HASHING_DRIVER=bcrypt

# DOMAINS_QUOTA=0
# DOMAINS_MAX_QUOTA=null

# MAILBOXES_ROOT_DIRECTORY=/srv/mail/mailboxes
# MAILBOXES_HOMEDIR=/srv/mail/mailboxes/%d/%n
# MAILBOXES_MAILDIR=maildir:/srv/mail/mailboxes/%d/%n:LAYOUT=fs

# SYSTEM_HEALTH_CHECK_SERVICES=false
# SYSTEM_HEALTH_CHECK_FREQUENCY=5min
# SYSTEM_HEALTH_MAX_ENTRIES_INCIDENT_HISTORY=100

# SIZE_MEASUREMENTS_DELETE_OLD=true
# SIZE_MEASUREMENTS_DELETE_AFTER_MONTHS=12
# SIZE_MEASUREMENTS_DELETE_AFTER_WEEKS=0
# SIZE_MEASUREMENTS_DELETE_AFTER_DAYS=0

# ENABLE_INTEGRATIONS=false
# INTEGRATIONS_ENABLE_SHELL_COMMANDS=false
# INTEGRATIONS_ENABLE_WEB_HOOKS=false
# INTEGRATIONS_SHELL_COMMANDS_FAILED_RETRY_DELAY=60
# INTEGRATIONS_SHELL_COMMANDS_ALLOW_PARAMETERS=false
# INTEGRATIONS_WEB_HOOKS_FAILED_RETRY_DELAY=60
# INTEGRATIONS_SHELL_COMMAND_01=
# INTEGRATIONS_SHELL_COMMAND_02=
# INTEGRATIONS_SHELL_COMMAND_03=
# INTEGRATIONS_SHELL_COMMAND_04=
# INTEGRATIONS_SHELL_COMMAND_05=
# INTEGRATIONS_SHELL_COMMAND_06=
# INTEGRATIONS_SHELL_COMMAND_07=
# INTEGRATIONS_SHELL_COMMAND_08=
# INTEGRATIONS_SHELL_COMMAND_09=
# INTEGRATIONS_SHELL_COMMAND_10=

# SHOW_EMAIL_SETTINGS=true

SMTP_HOSTNAME=smtp.example.com
SMTP_PORT=587
SMTP_SSL=STARTTLS

IMAP_HOSTNAME=imap.example.com
IMAP_PORT=993
IMAP_SSL=SSL/TLS

POP3_HOSTNAME=pop3.example.com
POP3_PORT=995
POP3_SSL=SSL/TLS
5 changes: 5 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
* text=auto
*.css linguist-vendored
*.scss linguist-vendored
*.js linguist-vendored
CHANGELOG.md export-ignore
16 changes: 16 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/node_modules
/public/hot
/public/storage
/storage/*.key
/vendor
/.idea
/.vscode
/.vagrant
Homestead.json
Homestead.yaml
npm-debug.log
yarn-error.log
.env
.DS_Store
/coverage_report
.php_cs.cache
88 changes: 88 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# How to contribute

:tada: First off, thanks for contributing - you are awesome! :tada:

There is a lot to do and this project depends on people contributing in their free time.
If you want to help, either tackle an issue from the [board](https://github.com/mum-project/mum/issues),
write more tests or maybe some [documentation](https://github.com/mum-project/docs)?
If you have an idea for a new feature, let's discuss it in an issue. When people like your idea, open a pull request!

## Coding Conventions

We follow the PSR-2 coding standard and the PSR-4 autoloading standard.

## Code of Conduct

### TL;DR

Be nice to each other.

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

### Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [[email protected]](mailto:[email protected]).
All complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

### Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 Martin Bock, Max Merz

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# MUM

> This software is still in development and not production-ready. Help us make it better by contributing!
## Documentation
The up-to-date version of the documentation is hosted [right here](https://mum-project.github.io/docs/).
The [docs repository](https://github.com/mum-project/docs) is tagged using MUM's version numbers, so you
may access older documentation simply by downloading the corresponding documentation version and building
the static site yourself.

## About the Project
MUM originated as a software development project at [Stuttgart Media University](https://www.hdm-stuttgart.de).
Since there weren't any good web-based user management tools for Postfix and Dovecot out there, we decided
to build our own.

## Contributing
You want to help? Awesome! Have a look at the [Contribution Guide](CONTRIBUTING.md) and start coding.

## Security
If you discover any security vulnerabilities, please send an email to [[email protected]](mailto:[email protected]).

## License
The [MIT license](https://opensource.org/licenses/MIT).
Please see the [license file](LICENSE.md) for more information.

Copyright © 2018 Martin Bock, Max Merz.
Loading

0 comments on commit 149d002

Please sign in to comment.