Fix READMEs

This commit is contained in:
Shaun Reed 2019-08-31 03:08:24 -04:00
parent 59ad80bda7
commit d6170be41d
4 changed files with 64 additions and 46 deletions

View File

@ -43,13 +43,17 @@ klips/
### ansible
Ansible roles, playbooks
Playbooks
- apt-up.yml - Playbook to update servers / groups ad hoc
- core.yml - Playbook example for using core configuration role
- docker.yml - Playbook example for using docker install role (Debian / Ubuntu)
- hosts - Sample / partially default ansible hosts file
- make-host.yml - Playbook example for using multiple roles together to create a new host
- nginx.yml - Playbook example for using nginx role
- roles - Some simple Ansible roles created with `ansible-galaxy init <role> --offline` command
Roles
- Basic ansible role created with ansible-galaxy command
- core - Role to configure a new host with basic authentication / package settings
- docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu)
- nginx - Role to install and configure a new nginx webserver on a host
@ -66,15 +70,22 @@ Ansible roles, playbooks
- doxygenROT - Basic rule-of-thumb for Doxygen commenting
### scripts
- adduser.sh - Script to add new user, run with sudo if you want to configure / allow user to sudo
- ./adduser - (Print help text)
- ./adduser <name> <userID> - (Don't need sudo if new user doesn't need it)
- sudo ./adduser <name> <userID>
- sudo ./adduser jeff 1005 - (Create jeff user and assign userID to 1005)
adduser.sh - Script to add new user, run with sudo if you want to configure / allow user to sudo
- `./adduser` - (Print help text)
- `./adduser <name> <userID>` - (Don't need sudo if new user doesn't need it)
- `sudo ./adduser <name> <userID>`
- `sudo ./adduser jeff 1005` - (Create jeff user and assign userID to 1005)
- Follow prompts to configure password / sudo depending on needs of new user
- cmake-build.sh - Script to toss around and build cmake projects
- README.md - Further clarification of scripts
- setup-vim.sh - Script for setting up vim configuration
cmake-build.sh
- Script to toss around and build cmake projects
README.md
- Further clarification of scripts
setup-vim.sh
- Script for setting up vim configuration
- Includes Pathogen Plugin manager
- Includes auto-completion (Clang_completion)
- Supertab completion interaction (Tab to interact with completion context)

View File

@ -11,7 +11,7 @@ Playbooks
- nginx.yml - Playbook example for using nginx role
Roles
- roles - Basic ansible role created with ansible-galaxy command
- Basic ansible role created with ansible-galaxy command
- core - Role to configure a new host with basic authentication / package settings
- docker - Role to install docker, docker-compose, configure docker user group (Debian / Ubuntu)
- nginx - Role to install and configure a new nginx webserver on a host

View File

@ -9,19 +9,23 @@ klips/ansible/roles/...
All of these roles assume you are using the apt package manager, and running a Debian / Ubuntu system.
core
------------
A simple role for configuring a set of packages / settings on a new Ubuntu host using Ansible.
Packages Added / Configured
- Git
### Packages Added / Configured
Git
- Configure / set user name and email
- SSH
SSH
- MOTD (Template, replacable, displayed on login.)
- PAM (Template, replacable, authusers file to bypass)
- authusers (Add users to file to bypass PAM settings)
- Vim
Vim
- Install Vim
- Run https://github.com/shaunrd0/klips/blob/master/scripts/setup-vim.sh

View File

@ -3,14 +3,17 @@ core
A simple role for configuring a set of packages / settings on a new Ubuntu host using Ansible.
Packages Added / Configured
- Git
### Packages Added / Configured
Git
- Configure / set user name and email
- SSH
SSH
- MOTD (Template, replacable, displayed on login.)
- PAM (Template, replacable, authusers file to bypass)
- authusers (Add users to file to bypass PAM settings)
- Vim
Vim
- Install Vim
- Run https://github.com/shaunrd0/klips/scripts/setup-vim.sh