https://github.com/kaelianbaudelet/Locked
The great companion to your ControlD for easily blocking and unblocking your domains.
https://github.com/kaelianbaudelet/Locked
block controld dns locked unblock
Last synced: 10 months ago
JSON representation
The great companion to your ControlD for easily blocking and unblocking your domains.
- Host: GitHub
- URL: https://github.com/kaelianbaudelet/Locked
- Owner: afi-dev
- License: mit
- Created: 2024-11-24T00:11:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-05T10:53:30.000Z (over 1 year ago)
- Last Synced: 2024-12-21T09:58:43.804Z (over 1 year ago)
- Topics: block, controld, dns, locked, unblock
- Language: TypeScript
- Homepage:
- Size: 294 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Locked
**Locked** is a web application designed as a practical add-on for **ControlD** users. It makes it easy to manage access to sites blocked or unblocked by **ControlD DNS**, while providing additional security information for each domain. To use this project you need a **ControlD subscription**.
# Preview
|  |  |
| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|  |  |
# Features
- **Fast domain blocking and unblocking**: add or remove domains from your ControlD block lists with a single click.
- **ControlD subscription overview**: quickly view the number of days remaining on your ControlD subscription.
- **Security information**: view domain security information directly from the block/unblock page. This information is provided by VirusTotal via a personal API key.
# How does it work?
When **ControlD** blocks a site, a customised blocking page is displayed (if this option is enabled in ControlD). Locked integrates directly with this page to provide a simplified management experience:
- **Instant unblocking**: Locked interacts with the ControlD API to unblock the site instantly. This feature enables access to be restored quickly while maintaining visibility of the site's security information.
- **Fast blocking**: as well as unblocking, the Locked application can also block a site in a matter of seconds. Simply enter the URL of a domain in the Locked interface to add it to the ControlD blocking lists.
- **ControlD subscription tracking**: in Locked, users can quickly see information about their ControlD subscription, including the number of days remaining.
Locked transforms the management of blocked and unblocked sites into a simple, secure and efficient process.
# Requirements
> [!IMPORTANT]
> To use Locked, you will need :
>
> - A ControlD subscription in Some Control or Full Control.
> - A VirusTotal API key to access domain security information (optional but recommended).
> - An active ControlD API key.
# Installation
Follow the steps below to install the development repo and start Locked :
1. Clone the repository :
```bash
git clone https://github.com/Afi-dev/locked.git
```
2. Install the dependencies :
```bash
cd locked
pnpm install or npm install
```
Here's an improved version:
3. Configuring the `.env` file
Copy the `.env.example` file and rename it to `.env`.
- **ControlD API Key** (required) :
> [!IMPORTANT]
> Make sure you configure a ControlD API key with **write permissions**.
Paste your **ControlD API** key into the `.env` file to activate the blocking and unblocking functions.
- **VirusTotal API Key** (optional) :
To display domain security information, also paste your **VirusTotal API** key to the `.env` file.
4. Run Locked
```bash
npx next dev
pnpx next dev
```
# License
Copyright © 2024 Kaelian BAUDELET and contributors.
Code published under the **MIT licence.**