updated config:* help doc
This commit is contained in:
Abdulmhsen B. A. A
@@ -27,14 +27,14 @@ final class AddCommand extends Command
|
||||
r(
|
||||
<<<HELP
|
||||
|
||||
This command allow you to add new backend to your [<value>servers.yaml</value>] config.
|
||||
This command require <notice>interaction</notice> to work.
|
||||
This command allow you to add new backend.
|
||||
This command require <notice>interaction</notice> to work.
|
||||
|
||||
This command is purely shortcut for running the following command:
|
||||
This command is purely shortcut for running the following command:
|
||||
|
||||
{cmd} <cmd>{manage_route}</cmd> --add -- <value>backend_name</value>
|
||||
{cmd} <cmd>{manage_route}</cmd> --add -- <value>backend_name</value>
|
||||
|
||||
HELP,
|
||||
HELP,
|
||||
[
|
||||
'cmd' => trim(commandContext()),
|
||||
'route' => self::ROUTE,
|
||||
|
||||
@@ -36,25 +36,25 @@ final class EditCommand extends Command
|
||||
r(
|
||||
<<<HELP
|
||||
|
||||
This command allow you to <notice>edit</notice> backend config settings <notice>inline</notice>.
|
||||
This command allow you to <notice>edit</notice> backend config settings <notice>inline</notice>.
|
||||
|
||||
The [<flag>--key</flag>] accept string value. the list of officially supported keys are:
|
||||
The [<flag>--key</flag>] accept string value. the list of officially supported keys are:
|
||||
|
||||
[{keyNames}]
|
||||
[{keyNames}]
|
||||
|
||||
-------
|
||||
<notice>[ FAQ ]</notice>
|
||||
-------
|
||||
-------
|
||||
<notice>[ FAQ ]</notice>
|
||||
-------
|
||||
|
||||
<question># How to edit config setting?</question>
|
||||
<question># How to edit config setting?</question>
|
||||
|
||||
{cmd} <cmd>{route}</cmd> <flag>--key</flag> <value>key</value> <flag>--set</flag> <value>value</value> -- <value>backend_name</value>
|
||||
{cmd} <cmd>{route}</cmd> <flag>--key</flag> <value>key</value> <flag>--set</flag> <value>value</value> -- <value>backend_name</value>
|
||||
|
||||
<question># How to change the webhook token?</question>
|
||||
<question># How to change the webhook token?</question>
|
||||
|
||||
{cmd} <cmd>{route}</cmd> <flag>--regenerate-webhook-token</flag> -- <value>backend_name</value>
|
||||
|
||||
HELP,
|
||||
{cmd} <cmd>{route}</cmd> <flag>--regenerate-webhook-token</flag> -- <value>backend_name</value>
|
||||
|
||||
HELP,
|
||||
[
|
||||
'cmd' => trim(commandContext()),
|
||||
'route' => self::ROUTE,
|
||||
|
||||
@@ -30,10 +30,9 @@ final class ListCommand extends Command
|
||||
->setHelp(
|
||||
<<<HELP
|
||||
|
||||
This command list your configured backends.
|
||||
|
||||
HELP
|
||||
This command list your configured backends.
|
||||
|
||||
HELP
|
||||
);
|
||||
}
|
||||
|
||||
|
||||
@@ -39,10 +39,10 @@ final class ManageCommand extends Command
|
||||
r(
|
||||
<<<HELP
|
||||
|
||||
This command allows you to manage backend settings.
|
||||
This command require <notice>interaction</notice> to work.
|
||||
This command allows you to manage backend settings.
|
||||
This command require <notice>interaction</notice> to work.
|
||||
|
||||
HELP,
|
||||
HELP,
|
||||
)
|
||||
);
|
||||
}
|
||||
@@ -63,11 +63,11 @@ HELP,
|
||||
r(
|
||||
<<<ERROR
|
||||
|
||||
<error>ERROR:</error> This command require <notice>interaction</notice>. For example:
|
||||
<error>ERROR:</error> This command require <notice>interaction</notice>. For example:
|
||||
|
||||
{cmd} <cmd>{route}</cmd> -- <value>{backend}</value>
|
||||
{cmd} <cmd>{route}</cmd> -- <value>{backend_name}</value>
|
||||
|
||||
ERROR,
|
||||
ERROR,
|
||||
[
|
||||
'cmd' => trim(commandContext()),
|
||||
'route' => self::ROUTE,
|
||||
|
||||
@@ -43,23 +43,23 @@ final class UnifyCommand extends Command
|
||||
r(
|
||||
<<<HELP
|
||||
|
||||
This command is mainly intended for <notice>Plex</notice> multi server users.
|
||||
You shouldn't use this command unless told by the team.
|
||||
This command is mainly intended for <notice>Plex</notice> multi server users.
|
||||
You shouldn't use this command unless told by the team.
|
||||
|
||||
Due to <notice>Plex</notice> webhook limitation you cannot use multiple webhook tokens for one PlexPass account.
|
||||
And as workaround we have to use one webhook token for all of your <notice>Plex</notice> backends.
|
||||
|
||||
Due to <notice>Plex</notice> webhook limitation you cannot use multiple webhook tokens for one PlexPass account.
|
||||
And as workaround we have to use one webhook token for all of your <notice>Plex</notice> backends.
|
||||
This command will do the following.
|
||||
|
||||
This command will do the following.
|
||||
3. Update backends unique identifier (uuid).
|
||||
1. Change the selected backend's webhook tokens to be replica of each other.
|
||||
2. Enable limit backend webhook requests to matching unique identifier.
|
||||
|
||||
3. Update backends unique identifier (uuid).
|
||||
1. Change the selected backend's webhook tokens to be replica of each other.
|
||||
2. Enable limit backend webhook requests to matching unique identifier.
|
||||
To execute the command, you can do the following
|
||||
|
||||
To execute the command, you can do the following
|
||||
{cmd} <cmd>{route}</cmd> -- <value>plex</value>
|
||||
|
||||
{cmd} <cmd>{route}</cmd> -- <value>plex</value>
|
||||
|
||||
HELP,
|
||||
HELP,
|
||||
[
|
||||
'cmd' => trim(commandContext()),
|
||||
'route' => self::ROUTE,
|
||||
|
||||
@@ -42,29 +42,29 @@ final class ViewCommand extends Command
|
||||
r(
|
||||
<<<HELP
|
||||
|
||||
This command display all of your backends information.
|
||||
You can select and/or filter the displayed information.
|
||||
This command display all of your backends information.
|
||||
You can select and/or filter the displayed information.
|
||||
|
||||
-------
|
||||
<notice>[ FAQ ]</notice>
|
||||
-------
|
||||
-------
|
||||
<notice>[ FAQ ]</notice>
|
||||
-------
|
||||
|
||||
<question># How to show one backend information?</question>
|
||||
<question># How to show one backend information?</question>
|
||||
|
||||
The flag [<flag>-s, --select-backends</flag>] accept comma seperated list of backends name, Using the flag
|
||||
in combination with [<flag>--exclude</flag>] flag will flip the logic to exclude the selected backends
|
||||
rather than include them.
|
||||
The flag [<flag>-s, --select-backends</flag>] accept comma seperated list of backends name, Using the flag
|
||||
in combination with [<flag>--exclude</flag>] flag will flip the logic to exclude the selected backends
|
||||
rather than include them.
|
||||
|
||||
{cmd} <cmd>{route}</cmd> <flag>--select-backends</flag> <value>my_backend</value>
|
||||
{cmd} <cmd>{route}</cmd> <flag>--select-backends</flag> <value>my_backend</value>
|
||||
|
||||
<question># How to show specific <value>key</value>?</question>
|
||||
<question># How to show specific <value>key</value>?</question>
|
||||
|
||||
The key can be any value that already exists in the list. to access sub-keys use dot notation for example,
|
||||
To see if the value of <value>import.enabled</value> you would run:
|
||||
The key can be any value that already exists in the list. to access sub-keys use dot notation for example,
|
||||
To see if the value of <value>import.enabled</value> you would run:
|
||||
|
||||
{cmd} <cmd>{route}</cmd> <value>import.enabled</value>
|
||||
{cmd} <cmd>{route}</cmd> -- <value>import.enabled</value>
|
||||
|
||||
HELP,
|
||||
HELP,
|
||||
[
|
||||
'cmd' => trim(commandContext()),
|
||||
'route' => self::ROUTE,
|
||||
|
||||
Reference in New Issue
Block a user