Skip to content

Commit

Permalink
docs: Update command line arguments
Browse files Browse the repository at this point in the history
  • Loading branch information
cetteup committed Jan 5, 2024
1 parent a2c2f18 commit aac5c30
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ DynDNS-like tool for keeping your Plex IPv6 custom access URL up to date, automa

If any required command line argument is omitted, the tool will prompt you to provide input at runtime.

| Name | Description | Required |
|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|
| address | Plex server's address in format http\[s\]://host:port | Yes |
| interface | Name of network interface to use for IPv6 access | Yes |
| token | Plex access token (X-Plex-Token) [How to find](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/) | If config is not given |
| config | Path to Plex config (Preferences.xml) [How to find](https://support.plex.tv/articles/202915258-where-is-the-plex-media-server-data-directory-located/) | No |
| Name | Description | Required | Options | Default |
|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|----------------------|---------|
| address | Plex server's address in format http\[s\]://host:port | Yes |
| interface | Name of network interface to use for IPv6 access | Yes |
| token | Plex access token (X-Plex-Token) [How to find](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/) | If config is not given | | |
| config | Path to Plex config (Preferences.xml) [How to find](https://support.plex.tv/articles/202915258-where-is-the-plex-media-server-data-directory-located/) | No | | |
| use | Which IPv6 address(es) to use if multiple are found on the interface | No | `first` `last` `all` | `first` |
| capitalization | Capitalization to use for dashed IPv6 address in Plex custom access URL | No | `upper` `lower` | `lower` |

## Usage

Expand Down

0 comments on commit aac5c30

Please sign in to comment.