Mirrors/python-plexapi
2
0
Fork 0
mirror of https://github.com/pkkid/python-plexapi synced 2024-11-21 19:23:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add client_baseurl and vlinet_token to docs

Browse source
This commit is contained in:
Michael Shepanski 2017-02-22 01:24:56 -05:00
parent 08f1e4b83d
commit abef6ab312
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/configuration.rst
View file

@ -18,6 +18,8 @@ are optional. An example config.ini file may look like the following with all po
myplex_password = kodi-stinks
server_baseurl = http://127.0.0.1:32400
server_token = XBHSMSJSDJ763JSm
client_baseurl = http://127.0.0.1:32433
client_token = BDFSLCNSNL789FH7
[headers]
identifier = 0x485b314307f3L
@ -85,6 +87,20 @@ Section [auth] Options
(persmission 600) to ensure no other users on the system can read them. Or better yet, only specify
sensitive values as a local environment variables.
**client_baseurl**
Default baseurl to use when creating a new :any:`PlexClient` object. Specifying this along with
:samp:`auth.client_token` allow you to more easily connect to a client and remove the need to hard
code the baseurl and token in any supplemental scripts you may write. To create a client object using
these values you may simply specify :samp:`client = PlexClient()` without any arguments (default: None).
**client_token**
Default token to use when creating a new :any:`PlexClient` object. See `auth.client_baseurl` for more
information and example usage (default: None).
WARNING: When specifying a password or token in the configuration file, be sure lock it down
(persmission 600) to ensure no other users on the system can read them. Or better yet, only specify
sensitive values as a local environment variables.
Section [header] Options
------------------------