सर्वर इंस्टॉल
OpenKey Server एक वैकल्पिक zero-knowledge sync API है। यह केवल ciphertext संग्रहीत करता है ताकि आप अपने डिवाइसों में vault sync कर सकें। मास्टर पासवर्ड और plaintext vault keys कभी क्लाइंट नहीं छोड़ते।
आवश्यकताएँ
- Docker और Docker Compose (अनुशंसित), या Python 3.12+ PostgreSQL 16 के साथ
- मज़बूत
JWT_SECRET(कम से कम 32 वर्ण, placeholder नहीं)
Docker से इंस्टॉल
cd openkey_server
cp .env.example .env
openssl rand -hex 32 # paste into JWT_SECRET in .env
docker compose up --build -dस्वस्थ होने पर:
| URL | उद्देश्य |
|---|---|
http://localhost:8000 | API base |
http://localhost:8000/docs | OpenAPI docs |
http://localhost:8000/health | Health check |
API startup पर schema migrations स्वचालित (alembic upgrade head)।
महत्वपूर्ण कॉन्फ़िगरेशन
| Variable | Notes |
|---|---|
JWT_SECRET | आवश्यक। न्यूनतम 32 वर्ण; startup पर placeholders अस्वीकृत |
DATABASE_URL | Async Postgres URL (Compose db service के लिए सेट) |
CORS_ORIGINS | comma-separated origins — * नहीं |
ACCESS_TOKEN_EXPIRE_MINUTES | अल्पकालिक access JWT (डिफ़ॉल्ट 15) |
REFRESH_TOKEN_EXPIRE_DAYS | opaque refresh token TTL (डिफ़ॉल्ट 7, उपयोग पर rotate) |
AUTH_RATE_LIMIT_* | auth endpoints पर per-IP limits |
Production के लिए: API HTTPS के पीछे रखें, unique JWT_SECRET सेट करें, CORS_ORIGINS clients तक सीमित करें।
प्रोडक्शन HTTPS
Full Caddy / nginx examples: English · العربية.
Put the API behind TLS, set a unique JWT_SECRET, and restrict CORS_ORIGINS (never *). Point clients at https://your.domain and check /health.
अपने clients कनेक्ट करें
प्रत्येक client समान सर्वर URL पर इंगित करें (स्थानीय Docker: http://localhost:8000, या public HTTPS URL)।
OpenKey ऐप (phone / desktop)
आधिकारिक स्टोर या डाउनलोड चैनल से आधिकारिक OpenKey ऐप इंस्टॉल करें।
- मास्टर पासवर्ड से स्थानीय vault अनलॉक या बनाएँ।
- Settings → Data → Self-hosted server खोलें।
- सर्वर URL दर्ज करें (उदाहरण:
https://openkey.example.com)। - Register (पहला device) या Login (दूसरा device जिसमें यह vault account है)।
- ciphertext pull/push के लिए Sync now टैप करें।
ऐप स्थानीय एन्क्रिप्टेड database रखता है। sync केवल opaque ciphertext exchange करता है। और: ऐप का उपयोग।
ब्राउज़र एक्सटेंशन
openkey_extensionbuild और load (npm install && npm run build, फिरdist/load)।- extension Options खोलकर समान सर्वर URL सेट करें।
- समान email + मास्टर पासवर्ड से अनलॉक (extension
/auth/preloginफिर login)।
Desktop bridge (वैकल्पिक): OpenKey desktop ऐप अनलॉक करें, native messaging host रजिस्टर करने Autofill सक्षम करें, फिर extension में «Use desktop app» चुनें। अलग extension unlock के बिना fill/save अनलॉक ऐप से हो सकता है।
CLI
openkey config set-server http://localhost:8000
openkey login --email [email protected]
eval $(openkey unlock)
openkey syncसर्वर के बिना secrets discovery: CLI (desktop ऐप bridge)।
Multi-device checklist
- सर्वर एक बार इंस्टॉल और सुरक्षित करें।
- पहले device पर: register + sync।
- प्रत्येक नए device पर: client इंस्टॉल → समान सर्वर URL → समान email और मास्टर पासवर्ड → sync।
- नियमित offline backups रखें (export / local backup) — भूला मास्टर पासवर्ड के लिए सर्वर recovery path नहीं।
अगला: ऐप का उपयोग · CLI · Security