diff --git a/README.md b/README.md index b74cd45..5270598 100644 --- a/README.md +++ b/README.md @@ -6,69 +6,3 @@ The snippets are organized within topic-labeled folders. 'plates' is short-hand Other directories could contain configuration files, bash exports, scripts, etc. -All snippets will be listed below with the directories in the master branch. If you are not on master, I cant guarentee anything will be anywhere unless otherwise described. - -### Contents - -``` -https://github.com/shaunrd0/... -klips/ -├── ansible -│   ├── apt-up.yml -│   ├── core.yml -│   ├── docker.yml -│   ├── hosts -│   ├── make-host.yml -│   ├── nginx.yml -│   └── roles -│   ├── core -│   ├── docker -│   └── nginx -├── configs -│   └── .vimrc -├── plates -│   ├── cpp-cmake -│   └── cpp-launcher -├── README.md -├── refs -│   └── doxygenROT -└── scripts - ├── adduser.sh - ├── cmake-build.sh - ├── README.md - └── setup-vim.sh -``` - -### 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 - - 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 - -### configs - - .vimrc - Various settings for vim, can be copied or used with setup-vim.sh) - -### plates - - cpp-cmake - Simple cpp executable template, built using cmake - - cpp-launcher - Simple cpp launcher template, built using cmake. Easily expandable. - -### 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 ` - (Don't need sudo if new user doesn't need it) - - `sudo ./adduser ` - - `sudo ./adduser jeff 1005` - (Create jeff user and assign userID to 1005) - - Follow prompts to configure password / sudo depending on needs of new user - diff --git a/ansible/README.md b/ansible/README.md index 9297480..afc9394 100644 --- a/ansible/README.md +++ b/ansible/README.md @@ -9,10 +9,14 @@ Playbooks - 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 + - fail2ban.yml - Playbook example for using fail2ban role + - postifx.yml - Playbook example for using postfix role 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 + - fail2ban - Role to install and configure fail2ban on a new host + - postfix - Role to install and configure postfix on a new host diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000..3202499 --- /dev/null +++ b/scripts/README.md @@ -0,0 +1,8 @@ +### 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 ` - (Don't need sudo if new user doesn't need it) + - `sudo ./adduser ` + - `sudo ./adduser jeff 1005` - (Create jeff user and assign userID to 1005) + - Follow prompts to configure password / sudo depending on needs of new user +