Skip to content
 
 

Repository files navigation

Guardian parental controls

Documentation

Guardian is a cross-platform parental control system with a secure server–agent architecture. A Flask server hosts the Web UI, REST APIs, and WebSocket hub. Managed devices run outbound client agents (Rust on Linux and Windows, Kotlin on Android). Nintendo Switch and Xbox consoles integrate via cloud parental-control APIs—no on-console agent required.

Documentation

Full documentation: https://pantherale0.github.io/timekpr-webui/

Topic Guide
Deploy the server Server deployment
Compare vs Family Link, Bark, etc. vs commercial parental controls
Linux agent Linux agent
Android agent Android agent
Windows agent Windows agent
Nintendo / Xbox Cloud consoles
Troubleshooting Troubleshooting

Build docs locally:

pip install -r requirements-docs.txt
mkdocs serve

Quick start (Docker)

git clone https://github.com/pantherale0/timekpr-webui.git
cd timekpr-webui
cp .env.example .env   # set AGENT_TOKEN and TZ
docker-compose up -d --build

Sign in at the dashboard with admin / admin and change the password under Settings.

Install Linux agent

curl -fsSLo /tmp/install-timekpr-agent.sh \
  https://raw.githubusercontent.com/pantherale0/timekpr-webui/master/scripts/install-agent.sh
chmod 0755 /tmp/install-timekpr-agent.sh
sudo /tmp/install-timekpr-agent.sh --server-url "wss://your-domain.com/ws"

Approve the device under Admin → Devices.

Repository layout

Path Description
server/ Flask web app, worker, tests
agent/ Rust Linux/Windows agent
android-agent/ Kotlin Android agent
docs/ MkDocs documentation source
scripts/ Install and release helpers

Contributing

See Local development, Contributing, and AGENTS.md for the development environment and contributor conventions.

License

MIT — see LICENSE.

About

A multi-platform parental controls service

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages