Skip to content

Commit

Permalink
add truenas instructions (#896)
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreyNikiforov authored Jul 6, 2024
1 parent d200e2a commit db197af
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ mode
size
raw
webui
nas
```
27 changes: 27 additions & 0 deletions docs/nas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Network Attached Storage

The following are example setups for NAS.

## TrueNAS

Use `Install Custom App` button to set up `icloudpd`:
| Field | Value | Note |
|-------|-------|------|
Application Name | `icloudpd` |
Version | N/A | Leave default
Container Images/Image repository | `icloudpd/icloudpd` |
Container Images/Image tag | `latest` |
Container Entrypoint/Container Args | `icloudpd` `-u` `[email protected]` `-d` `/data` `--password-provider` `webui` `--mfa-provider` `webui` `--watch-with-interval` `3600` | each as a separate arg (param name and param value become two separate args)
Port Forwarding/Container Port | `8080` |
Port Forwarding/Host Port | `9090` | or other available port on your host
Storage/Host Path Volumes/Host Path | /mnt/my_pool/photos | or another location on your host
Storage/Host Path Volumes/Mount Path | /data |
Portal Configuration/Enable Portal Configuration | checked |
Portal Configuration/Portal Name | `icloudpd` |
Portal Configuration/Protocol to Portal | `HTTP Protocol` |
Portal Configuration/Use Node IP for Portal IP/Domain | checked |
Portal Configuration/Port | `9090` |

Once the app has started, connect to the [WebUI](webui) to enter password and MFA code one of two ways:
- Using browser from your PC to 9090 port of your NAS
- Clicking on `icloudp` button in Detail/Application Info section of TrueNAS portal

0 comments on commit db197af

Please sign in to comment.