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

APPTSUARD IS NO LONGER SUPPORTED as of PTS 7.7

Table of Contents

  1. Intro
  2. Information
  3. Summary

1. Intro

The purpose of the application guard is to protect a user's containers by utilizing Traefik's authentication mechanism. When apPTSuard is enabled, a user will be challenge with a username and password. ApPTSuard is specifically meant to protect containers that are being utilized across the Internet with a domain name; not IP Address (see portguard).

2. Information

a. Case Use

As mentioned above, apPTSuard should be used when accessing your containers across the Internet. There are several containers that offer no protection such as NetData or Heimdall.

If a user discovers that their containers are being exposed without the use of a username/password, then the user should turn on apPTSuard. Some applications such as Sonarr and Radarr offer their own built in protection, but when in doubt; turn on apPTSuard.

b. Deployment

Just select apPTSuard from the tools menu and it will proceed onward to ask the user to generate a username and password.

When created, PTS hashes the username and password and create a hashed file. From there, PTS will rebuild all your containers with the hashed file set in place.

Once complete, the user will be prompted by a username/password in order to utilize the container.

c. Final Note

Please take note that you must utilize portguard to be truly effective. If a user fails to turn on portguard, the user's container's port will be able to access the program. Meaning, while a malicious user is unable to access sonarr.mydomain.com, they can still access mydomain.com:8989.

3. Summary

ApPTSuard is a simple product to use. Utilizing Traefik's built in protection with the power of PTS's scripts, a user will find themselves better protected than without it.