broadfield-dev commited on
Commit
49bb20c
Β·
verified Β·
1 Parent(s): 5cf429e

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +32 -1
README.md CHANGED
@@ -9,4 +9,35 @@ app_file: app.py
9
  pinned: false
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  pinned: false
10
  ---
11
 
12
+ # πŸ”‘ KeyLock Operations Dashboard
13
+
14
+ This is a self-contained demonstration of the complete KeyLock ecosystem, featuring the API Server, Image Creator, and an API Client simulator in a single, unified interface.
15
+
16
+ ## Important: Initial Setup Required
17
+
18
+ For the decryption functionality to work, you must provide the server's secret private key.
19
+
20
+ 1. **Go to the Settings Tab:** In this Space, navigate to the "Settings" page.
21
+ 2. **Add a Repository Secret:** Find the "Repository secrets" section and click "New secret".
22
+ 3. **Enter the Secret:**
23
+ - **Name:** `KEYLOCK_PRIV_KEY`
24
+ - **Value:** Paste the entire private key string that corresponds to the public key stored in `keylock_pub.pem`.
25
+
26
+ The Space will restart automatically. Once running, the "API Server Status" tab will confirm if the key was loaded successfully.
27
+
28
+ ## Dashboard Tabs
29
+
30
+ ### πŸ“‘ API Server Status & Docs
31
+ This tab shows the health of the conceptual "server". It confirms whether the private key is loaded and displays the public key that clients should use for encryption. It also provides documentation for the API endpoint that this server exposes for external clients.
32
+
33
+ ### 🏭 Image Creator
34
+ This is a tool to create encrypted PNG images.
35
+ - Enter your secret data in the textbox.
36
+ - Click "Create Encrypted Image".
37
+ - The application will use the server's public key (from `keylock_pub.pem`) to encrypt your data and embed it into a new image, which you can then download.
38
+
39
+ ### πŸ’» API Client (Simulator)
40
+ This tab acts as a client to test the server's decryption logic.
41
+ - Upload an image (ideally, one you just made in the "Image Creator" tab).
42
+ - Click "Decrypt Image".
43
+ - The application will perform a *simulated API call* by directly passing the image to the internal decryption function. The decrypted JSON data will be displayed. This demonstrates the end-to-end data flow without the need for an actual HTTP request.