Skip to content

Commit

Permalink
remove plex credentials
Browse files Browse the repository at this point in the history
  • Loading branch information
saltydk committed Aug 4, 2024
1 parent afbdf07 commit 78609ad
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 36 deletions.
19 changes: 0 additions & 19 deletions docs/reference/accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,25 +83,6 @@ Each tab shows a "section" in the file.
This parameter is optional.
Entering Dockerhub credentials increases the number of images one can pull.

=== "plex"
```yaml
plex:
user:
pass:
tfa: no
```

`user` - Plex username or email address on the profile.

`pass` - Plex password. See the [password considerations](#password-considerations) below. Wrap the password in quotes if it contains anything other than letters and numbers.

`tfa` - "yes" or "no" depending on whether you want to use the two-factor authentication [TFA] compatible Plex connection system.

This parameter is required.
This will be used to claim the Plex server under your username and generate Plex Access Tokens for apps such as Autoscan, etc.
Note: The "tfa" setting controls whether Saltbox uses the newer authentication method or not; this newer method is *required* for use with TFA, but will work even with it off; it's the "Open an URL, log into Plex, grant access to this app" workflow you may be familiar with from other contexts.
If you use the `tfa` workflow, a random client ID and a Plex Access Token will be stored in `/opt/saltbox/plex.ini` for later use. Consider securing this file if you are running Saltbox on a shared machine.

=== "user"
```yaml
---
Expand Down
27 changes: 10 additions & 17 deletions docs/saltbox/install/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,15 +104,12 @@ To edit any of the following configuration files use the command written in the
dockerhub:
user: # (4)!
token: # (5)!
plex:
user: # (6)!
pass: # (7)!
user:
name: seed # (8)!
pass: password123 # (9)!
domain: testsaltbox.ml # (10)!
email: your@email.com # (11)!
ssh_key: # (12)!
name: seed # (6)!
pass: password123 # (7)!
domain: testsaltbox.ml # (8)!
email: your@email.com # (9)!
ssh_key: # (10)!
```

1. apprise url. See <https://github.com/caronc/apprise#popular-notification-services> for more information.
Expand All @@ -131,31 +128,27 @@ To edit any of the following configuration files use the command written in the

5. Docker Hub account token. *Not your password.* A token can be created in the Security tab of your Docker Hub account.

6. Plex.tv username or email address on the account.

7. Plex.tv password for the account. It should be wrapped in quotes if it contains any non alphanumeric characters.

8. Username that will be created (if it doesn't exist) during the installation and apps that have automatic user configuration.
6. Username that will be created (if it doesn't exist) during the installation and apps that have automatic user configuration.

Do not use root.

Required.

9. Password used for username account during the installation and apps that have automatic user configuration.
7. Password used for username account during the installation and apps that have automatic user configuration.

See the [password considerations.](../../reference/accounts.md#password-considerations)

Required.

10. Domain that you want to use for the server.
8. Domain that you want to use for the server.

Required.

11. Email address used for Let's Encrypt SSL certificates.
9. Email address used for Let's Encrypt SSL certificates.

Required.

12. SSH Public Key. The key will be added to your configured user's `authorized_keys` file. This parameter accepts either the public key or a GitHub url (i.e. [https://github.com/charlie.keys](https://github.com/charlie.keys)) which will pull the keys you have added to your GitHub account.
10. SSH Public Key. The key will be added to your configured user's `authorized_keys` file. This parameter accepts either the public key or a GitHub url (i.e. [https://github.com/charlie.keys](https://github.com/charlie.keys)) which will pull the keys you have added to your GitHub account.

=== "settings.yml"

Expand Down

0 comments on commit 78609ad

Please sign in to comment.