diff --git a/README.md b/README.md index 4979e0a6..e7bdb2c1 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,8 @@ Ansible config and a bunch of Docker containers. * [Emby](https://emby.media/) - Media streaming and management * [Firefly III](https://firefly-iii.org/) - Free and open source personal finance manager * [get_iplayer](https://github.com/get-iplayer/get_iplayer) - download programmes from BBC iplayer -* [Gitea](https://gitea.io/en-us/) - Simple self-hosted Github clone -* [Gitlab](https://about.gitlab.com/features/) - Self-hosted Github clone of the highest order +* [Gitea](https://gitea.io/en-us/) - Simple self-hosted GitHub clone +* [GitLab](https://about.gitlab.com/features/) - Self-hosted GitHub clone of the highest order * [Glances](https://nicolargo.github.io/glances/) - for seeing the state of your system via a web browser * [Grafana](https://github.com/grafana/grafana) - Dashboarding tool * [Guacamole](https://guacamole.apache.org/) - Web based remote desktop gateway, supports VNC, RDP and SSH diff --git a/docs/applications/bazarr.md b/docs/applications/bazarr.md index 328e73cf..ed0c9adf 100644 --- a/docs/applications/bazarr.md +++ b/docs/applications/bazarr.md @@ -12,4 +12,4 @@ Set `bazarr_enabled: true` in your `inventories//nas.yml` file. ## Specific Configuration -Follow the [Wiki](https://github.com/morpheus65535/bazarr/wiki) for conecting to Sonarr and Radarr. \ No newline at end of file +Follow the [Wiki](https://github.com/morpheus65535/bazarr/wiki) for connecting to Sonarr and Radarr. diff --git a/docs/applications/emby.md b/docs/applications/emby.md index 4ece0ae6..4f5a315a 100644 --- a/docs/applications/emby.md +++ b/docs/applications/emby.md @@ -35,7 +35,7 @@ configuration directory read/write. ## File system considerations -Movie and TV show files are almost alway very large and pre-compressed. If you +Movie and TV show files are almost always very large and pre-compressed. If you are using a specialized filesystem such as ZFS for bulk storage, you'll want to set the parameters accordingly. The [ZFS configuration documentation](../zfs/zfs_configuration.md) has an example of this. diff --git a/docs/applications/gitlab.md b/docs/applications/gitlab.md index 21da3207..a554d3bb 100644 --- a/docs/applications/gitlab.md +++ b/docs/applications/gitlab.md @@ -2,7 +2,7 @@ Homepage: [https://docs.gitlab.com/omnibus/docker/](https://docs.gitlab.com/omnibus/docker/) -If Gitea isn't powerful enough for you then consider GitLab. It's a much more powerful (and consquently bigger) Git repository solution that includes a suite of code analytics. On the other hand it requires more RAM. +If Gitea isn't powerful enough for you then consider GitLab. It's a much more powerful (and consequently bigger) Git repository solution that includes a suite of code analytics. On the other hand it requires more RAM. ## Usage diff --git a/docs/applications/jellyfin.md b/docs/applications/jellyfin.md index 83ddd101..4a44572d 100644 --- a/docs/applications/jellyfin.md +++ b/docs/applications/jellyfin.md @@ -33,7 +33,7 @@ configuration directory read/write. ## File system considerations -Movie and TV show files are almost alway very large and pre-compressed. If you +Movie and TV show files are almost always very large and pre-compressed. If you are using a specialized filesystem such as ZFS for bulk storage, you'll want to set the parameters accordingly. The [ZFS configuration documentation](../zfs/zfs_configuration.md) has an example of this. diff --git a/docs/applications/nextcloud.md b/docs/applications/nextcloud.md index f68d95e3..946f8e10 100644 --- a/docs/applications/nextcloud.md +++ b/docs/applications/nextcloud.md @@ -9,7 +9,7 @@ Set `nextcloud_enabled: true` in your `inventories//nas.yml` fil Tread carefully. -External access may require that you manually configure your Fully Qualified Domain Name (FQDN) as a trusted domain within the application. There is an evnironment variable set up for this in the "nextcloud task" which will most likely make manual configuration unneccessary. If you get the following [screenshot](https://docs.nextcloud.com/server/14/admin_manual/installation/installation_wizard.html#trusted-domains) warning when trying to access nextcloud externally you'll need to manually set it up. +External access may require that you manually configure your Fully Qualified Domain Name (FQDN) as a trusted domain within the application. There is an environment variable set up for this in the "nextcloud task" which will most likely make manual configuration unnecessary. If you get the following [screenshot](https://docs.nextcloud.com/server/14/admin_manual/installation/installation_wizard.html#trusted-domains) warning when trying to access nextcloud externally you'll need to manually set it up. This can be accomplished in two commands. diff --git a/docs/applications/radarr.md b/docs/applications/radarr.md index acc7a547..bdc3cdfc 100644 --- a/docs/applications/radarr.md +++ b/docs/applications/radarr.md @@ -18,4 +18,4 @@ Radarr will get the file path from the Download client. On default settings with For Radarr to understand that the `/movies` folder is a folder, you'll need to add a new subfolder into it. You can also do this by adding a random movie to the folder. Keep in mind to have the internal setting **Create empty movie folders** on **yes** -Comprehensive setup information can be found on the [Radarr github wiki](https://github.com/Radarr/Radarr/wiki/Setup-Guide) +Comprehensive setup information can be found on the [Radarr GitHub wiki](https://github.com/Radarr/Radarr/wiki/Setup-Guide) diff --git a/docs/applications/sonarr.md b/docs/applications/sonarr.md index bbbd93ab..26dad584 100644 --- a/docs/applications/sonarr.md +++ b/docs/applications/sonarr.md @@ -19,4 +19,4 @@ Sonarr will get the file path from the Download client. On default settings with For Sonarr to understand that the `/tv` folder is a folder, you'll need to add a folder into it. You can also do this by adding a random series to the folder. Keep in mind to have the setting **Create empty movie folders** on **yes** -For comprehensive configuration instructions see the [Sonarr github wiki](https://github.com/Sonarr/Sonarr/wiki) +For comprehensive configuration instructions see the [Sonarr GitHub wiki](https://github.com/Sonarr/Sonarr/wiki) diff --git a/docs/applications/wallabag.md b/docs/applications/wallabag.md index 73b3ab5c..9bcaa20c 100644 --- a/docs/applications/wallabag.md +++ b/docs/applications/wallabag.md @@ -10,7 +10,7 @@ Set `wallabag_enabled: true` in your `inventories//nas.yml` file If you want to access wallabag externally, don't forget to set `wallabag_available_externally: "true"` in your `inventories//nas.yml` file. -I reccomend using the mobile app, which will sync with this installation so you have access to your saved articles even if you don't have signal or wifi access. +I recommend using the mobile app, which will sync with this installation so you have access to your saved articles even if you don't have signal or wifi access. The default credentials are wallabag:wallabag diff --git a/docs/configuration/application_ports.md b/docs/configuration/application_ports.md index 129221ee..73aff9d0 100644 --- a/docs/configuration/application_ports.md +++ b/docs/configuration/application_ports.md @@ -18,9 +18,9 @@ By default, applications can be found on the ports listed below. | get_iplayer | 8182 | | | Gitea | 3001 | Web | | Gitea | 222 | SSH | -| Gitlab | 4080 | HTTP | -| Gitlab | 4443 | HTTPS | -| Gitlab | 422 | SSH | +| GitLab | 4080 | HTTP | +| GitLab | 4443 | HTTPS | +| GitLab | 422 | SSH | | Glances | 61208 | SSH | | Grafana | 3000 | | | Guacamole | 8090 | | diff --git a/docs/upgrading.md b/docs/upgrading.md index 42280f5a..2dee7876 100644 --- a/docs/upgrading.md +++ b/docs/upgrading.md @@ -4,7 +4,7 @@ If you're upgrading from [this](https://github.com/davestephens/ansible-nas/commit/52c7fef3aba08e30331931747c81fb7b3bfd359a) commit or earlier, these instructions are relevant to you. -Rather than having to merge every new config line into your own `all.yml` file, now you only need to maintain the differences that are relevant to you in your own `nas.yml`, stored within an inventory directory. Your inventory `nas.yml` takes prescendence over `group_vars/all.yml`, which is how this setup works. `group_vars/all.yml` is now tracked as part of the repo. +Rather than having to merge every new config line into your own `all.yml` file, now you only need to maintain the differences that are relevant to you in your own `nas.yml`, stored within an inventory directory. Your inventory `nas.yml` takes precedence over `group_vars/all.yml`, which is how this setup works. `group_vars/all.yml` is now tracked as part of the repo. This will make updates from `master` much simpler, as there will be no requirement to merge changes from `all.yml.dist` into your own `all.yml` any more. You simply pull from master, then add the bits you're interested in into your inventory `nas.yml`. diff --git a/docs/zfs/zfs_configuration.md b/docs/zfs/zfs_configuration.md index 4fb6530d..5d032d7f 100644 --- a/docs/zfs/zfs_configuration.md +++ b/docs/zfs/zfs_configuration.md @@ -107,7 +107,7 @@ late. Pools have properties that apply either to the pool itself or to filesystems created in the pool. You can use the command `zpool get all tank` to see the pool properties and `zfs get all tank` to see the filesystem properties. Most -default values are perfecly sensible, some you'll [want to +default values are perfectly sensible, some you'll [want to change](https://jrs-s.net/2018/08/17/zfs-tuning-cheat-sheet/). Setting defaults makes life easier when we create our filesystems.