From 835864c53af09f433c4eb6ca7859edda2067b935 Mon Sep 17 00:00:00 2001 From: Ryan Date: Tue, 5 Jul 2022 19:07:45 -0400 Subject: [PATCH] update READMEs with relavent information --- applications/roles/media-manager/README.md | 69 ++++++++++++++++------ applications/roles/media/README.md | 54 +++++++++++------ 2 files changed, 85 insertions(+), 38 deletions(-) diff --git a/applications/roles/media-manager/README.md b/applications/roles/media-manager/README.md index 225dd44..c2ec18f 100644 --- a/applications/roles/media-manager/README.md +++ b/applications/roles/media-manager/README.md @@ -1,38 +1,69 @@ -Role Name -========= +Media Manager +============= -A brief description of the role goes here. - -Requirements ------------- - -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +A series of docker containers to allow full automation of media management. Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +| Variable | Description | Required | Default | +| -------------------- | --------------------------------------------------- | :------: | ------- | +| `TZ` | Timezone | - [ ] | `America/New_York` | +| `PUID` | User ID | - [ ] | `1000` | +| `PGID` | Group ID | - [ ] | `1000` | +| `PIA_USER` | username for PIA VPN | - [x] | | +| `PIA_PASS` | password for PIA VPN | - [x] | | +| `DOWNLOAD_FOLDER` | Folder where completed torrents are downloaded | - [ ] | `/mnt/downloads` | +| `CONFIG_FOLDER` | Folder containing all persistent configuration data | - [ ] | `~/.config` | +| `MEDIA_FOLDER` | base folder for all media content | - [ ] | `/mnt/media` | +| `MOVIE_FOLDER` | folder for 1080p movies | - [ ] | `{{ MEDIA_FOLDER }}/movies` | +| `MOVIE_ANIME_FOLDER` | folder for anime movies | - [ ] | `{{ MEDIA_FOLDER }}/movies-anime` | +| `MOVIE_4k_FOLDER` | folder for movies in 4k | - [ ] | `{{ MEDIA_FOLDER }}/movies-4k` | +| `TV_FOLDER` | folder for TV Shows 1080p or lower | - [ ] | `{{ MEDIA_FOLDER }}/tv` | +| `TV_ANIME_FOLDER` | folder for Anime TV Shows | - [ ] | `{{ MEDIA_FOLDER }}/tv-anime` | +| `TV_4K_FOLDER` | folder for TV Shows in 4k | - [ ] | `{{ MEDIA_FOLDER }}/tv-4k` | Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +* Docker module 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: +Required vars +```yaml +- hosts: media-managers + include_roles: + - name: media-manager + vars: + PIA_USER: "username-here" + PIA_PASS: "password-here" +``` - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +All variables +```yaml +- hosts: media-managers + include_roles: + - name: media-manager + vars: + PIA_USER: "username-here" + PIA_PASS: "password-here" + TZ: "America/New_York" + PUID: "1000" + PGID: "1000" + DOWNLOAD_FOLDER: "/mnt/downloads" + CONFIG_FOLDER: "~/.config" + MEDIA_FOLDER: "/mnt/content" + MOVIE_FOLDER: "/mnt/content/movies" + MOVIE_4K_FOLDER: "/mnt/content/movies-4k" + MOVIE_ANIME_FOLDER: "/mnt/content/movies-anime" + TV_FOLDER: "/mnt/content/tv" + TV_4K_FOLDER: "/mnt/content/tv-4k" + TV_ANIME_FOLDER: "/mnt/content/tv-anime" +``` License ------- BSD - -Author Information ------------------- - -An optional section for the role authors to include contact information, or a website (HTML is not allowed). diff --git a/applications/roles/media/README.md b/applications/roles/media/README.md index 225dd44..8fd2eb0 100644 --- a/applications/roles/media/README.md +++ b/applications/roles/media/README.md @@ -1,38 +1,54 @@ -Role Name -========= +Media Server +============ -A brief description of the role goes here. - -Requirements ------------- - -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +A series of docker containers to allow full automation of media management. Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +| Variable | Description | Required | Default | +| ----------------- | --------------------------------------------------- | :------: | ------- | +| `TZ` | Timezone | - [ ] | `America/New_York` | +| `PUID` | User ID | - [ ] | `1000` | +| `PGID` | Group ID | - [ ] | `1000` | +| `DISK_UUID` | UUID of disk holding media | - [x] | | +| `DOWNLOAD_FOLDER` | Folder where completed torrents are downloaded | - [ ] | `/mnt/downloads` | +| `CONFIG_FOLDER` | Folder containing all persistent configuration data | - [ ] | `~/.config` | +| `MEDIA_FOLDER` | base folder for all media content | - [ ] | `/mnt/content` | Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +* Docker module 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: +Required vars +```yaml +- hosts: media-servers + include_roles: + - name: media + vars: + DISK_UUID: "UUID" +``` - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +All variables +```yaml +- hosts: media-servers + include_roles: + - name: media + vars: + DISK_UUID: "UUID" + TZ: "America/New_York" + PUID: "1000" + PGID: "1000" + DOWNLOAD_FOLDER: "/mnt/downloads" + CONFIG_FOLDER: "~/.config" + MEDIA_FOLDER: "/mnt/content" +``` License ------- BSD - -Author Information ------------------- - -An optional section for the role authors to include contact information, or a website (HTML is not allowed).