Mirrors/ansible-nas
2
0
Fork 0
mirror of https://github.com/davestephens/ansible-nas synced 2024-12-26 11:33:08 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #96 from koenvervloesem/master

Browse source 
Documentation fixes: typos, links, whitespace
This commit is contained in:
David Stephens 2019-06-05 20:41:06 +01:00 committed by GitHub
commit 0efdaddf0e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 32 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/applications/bitwarden.md
View file

@ -11,7 +11,7 @@ Set `bitwarden_enabled: true` in your `group_vars/all.yml` file.
## Specific Configuration ## Specific Configuration
Make sure you set your admin token! It is `bitwarden_admin_token` in `group_vars/all.yml` file. The string you put here will be the login to the admin section of your bitwarden installation (https://bitwarden.ansiblenasdomain.tld/admin). This token can be anything, but it's recommended to use a long, randomly generated string of characters, for example running: Make sure you set your admin token! It is `bitwarden_admin_token` in `group_vars/all.yml` file. The string you put here will be the login to the admin section of your Bitwarden installation (https://bitwarden.ansiblenasdomain.tld/admin). This token can be anything, but it's recommended to use a long, randomly generated string of characters, for example running:
`openssl rand -base64 48`. `openssl rand -base64 48`.
To create a user, you need to set `bitwarden_allow_signups` to `true` in your `all.yml`, and re-run the playbook to reprovision the To create a user, you need to set `bitwarden_allow_signups` to `true` in your `all.yml`, and re-run the playbook to reprovision the

2
docs/applications/firefly.md
View file

@ -8,4 +8,4 @@ Firefly III is a self-hosted financial manager. It can help you keep track of ex
Set `firefly_enabled: true` in your `group_vars/all.yml` file. Set `firefly_enabled: true` in your `group_vars/all.yml` file.
The very basic MiniDLNA web interface can be found at http://ansible_nas_host_or_ip:8066. The Firefly III web interface can be found at http://ansible_nas_host_or_ip:8066.

2
docs/applications/mymediaforalexa.md
View file

@ -1,6 +1,6 @@
# My Media for Alexa # My Media for Alexa
Homepage: https://www.mymediaalexa.com/](https://www.mymediaalexa.com/) Homepage: [https://www.mymediaalexa.com/](https://www.mymediaalexa.com/)
My Media lets you stream your music collection to your Amazon Echo or Amazon Dot without having to upload all your music collection to the Cloud. This keeps your music under your control. My Media lets you stream your music collection to your Amazon Echo or Amazon Dot without having to upload all your music collection to the Cloud. This keeps your music under your control.

2
docs/applications/nzbget.md
View file

@ -2,7 +2,7 @@
Homepage: [https://nzbget.net/](https://nzbget.net/) Homepage: [https://nzbget.net/](https://nzbget.net/)
The most efficient usenet downloader. NZBGet is written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources. The most efficient Usenet downloader. NZBGet is written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources.
## Usage ## Usage

2
docs/applications/transmission.md
View file

@ -13,5 +13,5 @@ Transmission's web interface can be found at http://ansible_nas_host_or_ip:9091
## Specific Configuration ## Specific Configuration
If you enable Tranmission with OpenVPN, you'll need to copy `group_vars/vpn_credentials.yml.dist` to If you enable Transmission with OpenVPN, you'll need to copy `group_vars/vpn_credentials.yml.dist` to
`group_vars/vpn_credentials.yml` and fill in your settings. `group_vars/vpn_credentials.yml` and fill in your settings.

2
docs/applications/watchtower.md
View file

@ -2,7 +2,7 @@
Homepage: [https://github.com/v2tec/watchtower](https://github.com/v2tec/watchtower) Homepage: [https://github.com/v2tec/watchtower](https://github.com/v2tec/watchtower)
A process for watching your Docker containers and automatically udpating and restarting them whenever their base image is refreshed. A process for watching your Docker containers and automatically updating and restarting them whenever their base image is refreshed.
## Usage ## Usage

2
docs/configuration/external_access.md
View file

@ -11,7 +11,7 @@ There are a number of steps required to enable external access to the applicatio
Enabling access to applications externally **does not** automatically secure them. If you can access an application from within your own network without a username and password, this will also be the case externally. Enabling access to applications externally **does not** automatically secure them. If you can access an application from within your own network without a username and password, this will also be the case externally.
It is your responsiblity to ensure that applications you enable external access to are secured appropriately! It is your responsibility to ensure that applications you enable external access to are secured appropriately!
## Enable Traefik ## Enable Traefik

2
docs/hardware.md
View file

@ -16,6 +16,6 @@ The [homeserver Reddit](https://www.reddit.com/r/HomeServer/) has lots of good i
## HP Microserver ## HP Microserver
Ansible-NAS development is tested against an HP Microserver N54L, with 16GB of memory, a 60gb SSD for the OS and 4x2TB WD Red NAS drives for storage. It works great :-) Ansible-NAS development is tested against an HP Microserver N54L, with 16GB of memory, a 60GB SSD for the OS and 4x2TB WD Red NAS drives for storage. It works great :-)
This is obviously not the only solution but a reasonable one if you just want a single box to buy, and many different models are available on eBay for varying costs. This is obviously not the only solution but a reasonable one if you just want a single box to buy, and many different models are available on eBay for varying costs.

2
docs/index.md
View file

@ -28,4 +28,4 @@ you're done, check out the [post-installation](post_installation.md) steps.
If this is all very confusing, there is also an [overview](overview.md) of the If this is all very confusing, there is also an [overview](overview.md) of the
project and what is required for complete beginners. If you're only confused project and what is required for complete beginners. If you're only confused
abot ZFS, we'll help you [get started](zfs/zfs_overview.md) as well. about ZFS, we'll help you [get started](zfs/zfs_overview.md) as well.

4
docs/overview.md
View file

@ -10,7 +10,7 @@ small box that sits in the corner and runs 24/7. These days, a NAS doesn't just
only handle files, but also offers other services, for instance video streaming only handle files, but also offers other services, for instance video streaming
with [Plex](https://www.plex.tv/) or [Emby](https://emby.media/index.html). You with [Plex](https://www.plex.tv/) or [Emby](https://emby.media/index.html). You
can buy consumer NAS boxes from [various can buy consumer NAS boxes from [various
manifacturers](https://en.wikipedia.org/wiki/List_of_NAS_manufacturers) where manufacturers](https://en.wikipedia.org/wiki/List_of_NAS_manufacturers) where
you just have to add the hard drives, or you can configure your own hardware and you just have to add the hard drives, or you can configure your own hardware and
use open-source software as the operating system. use open-source software as the operating system.
@ -65,7 +65,7 @@ As a to-do list, before you can even install Ansible-NAS, you'll have to:
You will probably want to install a specialized filesystem for bulk storage such You will probably want to install a specialized filesystem for bulk storage such
as [ZFS](http://www.open-zfs.org/wiki/Main_Page) or as [ZFS](http://www.open-zfs.org/wiki/Main_Page) or
[Btrfs](https://btrfs.wiki.kernel.org/index.php/Main_Page). Both offer features [Btrfs](https://btrfs.wiki.kernel.org/index.php/Main_Page). Both offer features
such as snapshots, checksumming and scrubing to protect your data against such as snapshots, checksumming and scrubbing to protect your data against
bitrot, ransomware and other nasties. Ansible-NAS historically prefers **ZFS** bitrot, ransomware and other nasties. Ansible-NAS historically prefers **ZFS**
because this lets you swap storage pools with because this lets you swap storage pools with
[FreeNAS](https://freenas.org/zfs/). A [brief introduction](zfs/zfs_overview.md) [FreeNAS](https://freenas.org/zfs/). A [brief introduction](zfs/zfs_overview.md)

2
docs/zfs/zfs_overview.md
View file

@ -176,7 +176,7 @@ and ZFS is no exception. However, there is absolutely no requirement for ZFS to
have ECC RAM. If you just don't care about the danger of random bit flips have ECC RAM. If you just don't care about the danger of random bit flips
because, hey, you can always just download [Night of the Living because, hey, you can always just download [Night of the Living
Dead](https://archive.org/details/night_of_the_living_dead) all over again, Dead](https://archive.org/details/night_of_the_living_dead) all over again,
you're prefectly free to use normal RAM. If you do use ECC RAM, make sure your you're perfectly free to use normal RAM. If you do use ECC RAM, make sure your
processor and motherboard support it. processor and motherboard support it.
### No, the SLOG is not really a write cache ### No, the SLOG is not really a write cache