PTS Shield - n05urpr1532-MHA-Team/PTS-Team GitHub Wiki

Table of Contents

  1. PTS YouTube
  2. Intro
  3. Initial Actions
  4. PTS Actions
  5. Conclusion

1. PTS YouTube

NOTE: Watching the Video will provide the deepest insight in deploying PTSShield!

2. Intro

What does it provide you? Protection through Google Authentication by shielding your container/apps from unauthorized users! Unlike PTS's Legacy ApPTSuard, you sign in once and your apps are protected without having to sign in each time... over and over!

PTS Shield utilizes Google's OAuth in conjunction with Traefik and Thomseddon's Authentication Project - PLEASE STAR HIS PROJECT.

*WARNING: Will need to create another GSuite OAuth Key labeled web

3. Initial Actions

A. Prerequisites

Note: If you have sonarr/radarr/etc on a separate server than nzbget/sab/etc, you CANNOT use PTSShield for these apps, it won't work. PTSShield is basically a firewall and requires google authentication. Your apps don't know about and can't handle this "firewall". You have to disable PTSShield for these apps in this case. If your apps are on the same server, use the traefik internal access URL, not your domain!

B. Next Steps

  • Next, visit Google's Credential Console and select WEB Application!
    • This is not the same OAuth Key from PTS Blitz (which was --- other)
    • Selecting the wrong version will have you troubleshooting all day!
  • Name: Call it whatever you like!
  • Authorized Redirects: Make sure it matches as such https://oauth.yourdomain.com/_oauth
    • If you see a red warning about needing to add the domain to the trusted list, click it and do so!
    • Make sure you hit Enter to actually add it before you save!
  • Create: When finished, click the create button.

4. PTS Actions

Just notes until snapshots are taken:

  • Enter your CLIENT ID and SECRET from above
  • Add whitelisted users to access your apps
  • Exempt apps that you do not want to be touched by PTS Shield
  • Deploy!

Lesson Learned

  • If you fail to pay attention, you can end up copying the wrong key from another project and you'll wonder why it's not working. It happened to myself; so please pay attention!

5. Conclusion

PTS Shield is an awesome tool to provide you simple security powered by Google! Ensure to stop by Thomseddon's Authentication Project and give him a STAR if you like it!

⚠️ **GitHub.com Fallback** ⚠️