Skip to content

Commit

Permalink
Added meta/role data
Browse files Browse the repository at this point in the history
  • Loading branch information
danielsimkus committed Jan 21, 2022
1 parent 75edaef commit d55c68a
Show file tree
Hide file tree
Showing 5 changed files with 89 additions and 13 deletions.
29 changes: 29 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
language: python
python: "2.7"

# Use the new container infrastructure
sudo: false

# Install ansible
addons:
apt:
packages:
- python-pip

install:
# Install ansible
- pip install ansible

# Check ansible version
- ansible --version

# Create ansible.cfg with correct roles_path
- printf '[defaults]\nroles_path=../' >ansible.cfg

script:
# Basic role syntax check
- ansible-playbook tests/test.yml -i tests/inventory --syntax-check

notifications:
webhooks: https://galaxy.ansible.com/api/v1/notifications/
39 changes: 26 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,41 @@
# inbucket-ansible
Ansible role for installing InBucket https://github.com/inbucket/inbucket
Role Name
=========

# How to use
Ansible role for installing [InBucket](https://github.com/inbucket/inbucket)


Role Variables
--------------

The package works without anything needing changing, however you can check the [Defaults file](https://github.com/carandclassic/inbucket-ansible/blob/main/defaults/main.yml) for any of the variables you want to override.
You can find information on the full config here: https://www.inbucket.org/configurator/

Add the `carandclassic.inbucket-ansible` role in your playbook
```
roles:
- { role: carandclassic.inbucket-ansible, tags: ["inbucket"] }
```

# Laravel
Example Playbook
----------------

Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:

- hosts: servers
roles:
- { role: carandclassic.inbucket }

Laravel
-------

If you're using with Laravel you'll want the following in your .env, replacing appropriately if you've overriden the default values
```
MAIL_DRIVER=smtp
MAIL_HOST=localhost
MAIL_PORT=2500
```

# Accessing the webpanel
By default the webpanel should be accessible on port `9000`:
`http://{yourVMIpAddress}:9000`
License
-------

MIT

If you want to use localhost, you will have to setup portforwarding in vagrant 👍
Author Information
------------------
- [Daniel Simkus](https://github.com/danielsimkus)
- [Car&Classic](https://github.com/carandclassic)
27 changes: 27 additions & 0 deletions meta/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
galaxy_info:
role_name: inbucket
author: danielsimkus
description: Ansible role for installing Inbucket mail catcher
company: Car & Classic Ltd
license: MIT
min_ansible_version: 2.12
platforms:
- name: Ubuntu
versions:
- "focal"
- "bionic"
- "xenial"
- name: Debian
versions:
- "stretch"
- "jessie"
- "buster"
- "bullseye"

galaxy_tags:
- development
- web
- system
- mail
- inbucket
dependencies: []
2 changes: 2 additions & 0 deletions tests/inventory
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
localhost

5 changes: 5 additions & 0 deletions tests/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
- hosts: localhost
remote_user: root
roles:
- inbucket

0 comments on commit d55c68a

Please sign in to comment.