README fixes

This commit is contained in:
2019-08-31 03:01:59 -04:00
parent 2bebf584f8
commit 59ad80bda7
7 changed files with 61 additions and 54 deletions

View File

@@ -3,9 +3,9 @@
Some simple Ansible roles created with `ansible-galaxy init <role> --offline` command
klips/ansible/roles/...
-- core - Role to configure a new host with basic authentication / package settings
-- docker - Role to install docker, docker-compose, configure docker user group
-- nginx - Role to install and configure a new nginx webserver on a host
- core - Role to configure a new host with basic authentication / package settings
- docker - Role to install docker, docker-compose, configure docker user group
- nginx - Role to install and configure a new nginx webserver on a host
All of these roles assume you are using the apt package manager, and running a Debian / Ubuntu system.
@@ -16,14 +16,14 @@ A simple role for configuring a set of packages / settings on a new Ubuntu host
Packages Added / Configured
- Git
-- Configure / set user name and email
- Configure / set user name and email
- SSH
-- MOTD (Template, replacable, displayed on login.)
-- PAM (Template, replacable, authusers file to bypass)
-- authusers (Add users to file to bypass PAM settings)
- MOTD (Template, replacable, displayed on login.)
- PAM (Template, replacable, authusers file to bypass)
- authusers (Add users to file to bypass PAM settings)
- Vim
-- Install Vim
-- Run https://github.com/shaunrd0/klips/scripts/setup-vim.sh
- Install Vim
- Run https://github.com/shaunrd0/klips/blob/master/scripts/setup-vim.sh
docker

View File

@@ -5,14 +5,14 @@ A simple role for configuring a set of packages / settings on a new Ubuntu host
Packages Added / Configured
- Git
-- Configure / set user name and email
- Configure / set user name and email
- SSH
-- MOTD (Template, replacable, displayed on login.)
-- PAM (Template, replacable, authusers file to bypass)
-- authusers (Add users to file to bypass PAM settings)
- MOTD (Template, replacable, displayed on login.)
- PAM (Template, replacable, authusers file to bypass)
- authusers (Add users to file to bypass PAM settings)
- Vim
-- Install Vim
-- Run https://github.com/shaunrd0/klips/scripts/setup-vim.sh
- Install Vim
- Run https://github.com/shaunrd0/klips/scripts/setup-vim.sh
Requirements
------------
@@ -34,23 +34,23 @@ hostname: "localhost"
domain_name: "www.localhost.com"
```
Basic package installation variable -
#### Basic package installation variable -
packages - A list of packages to install when running core configuration. Add package to this list and it will be installed on your new host. Further configuration will need to be done manually, unless the role is modified otherwise.
SSH Configuration Variables -
#### SSH Configuration Variables -
ssh_port - The port to configure SSH to listen on
auth_methods - Authentication methods to allow SSH base configuration to use. Otherwise, specify a match within the sshd_config
MOTD Configuration Variables -
#### MOTD Configuration Variables -
hostname - The hostname of the box you are using, used in the MOTD for a host-specific greeting, so you know which host you are logged into when glancing between terminals.
domain_name - The domain name, if available, associated with this host.
Git Configuration Variables -
#### Git Configuration Variables -
git_email - Email address to configure with Git

View File

@@ -17,6 +17,8 @@ Found in `.../roles/docker/defaults/main.yml`
docker_users: [user1, user2]
```
#### Docker Group Configuration Variable -
docker_users - A list of users to configure / add to the docker group
Example Playbook

View File

@@ -19,7 +19,7 @@ nginx_root_dir: "/var/www/html/"
index_files: "index.html index.htm"
```
NGINX Configuration Variables -
#### NGINX Configuration Variables -
domain_name - Domain name to be used in nginx.conf, default value is the same as nginx base package default setting (localhost)