Document Utilities

Quickstart Guide

This guide takes you from a fresh clone to a running local DEQLYNK instance with working chat, account creation, and owner controls. Follow the sequence in order to avoid startup and session issues.

Goal: Boot the Flask app locally, open the web UI, create your first user identity, and access owner controls.

Step 1: Open the Project in a Terminal

From your workspace root, move into the app folder and ensure your Python environment has required dependencies. If you already use a virtual environment, activate it before running commands.

cd DEQLYNK-App
python -m pip install -r requirements.txt

Step 2: Configure Local Environment Variables

Create or verify .env in the app directory. For local testing, you can keep LOCAL_DEV_MODE=true to reduce friction while developing queue and captcha-protected flows.

LOCAL_DEV_MODE=true
DEQLYNK_SECRET_KEY=replace-with-a-strong-random-secret
TURNSTILE_SITE_KEY=
TURNSTILE_SECRET_KEY=
Security note: For production, set LOCAL_DEV_MODE=false and provide valid Turnstile keys.

Step 3: Start the Flask Server

Run the application directly with Python. By default, DEQLYNK serves on port 5000.

python app.py

If startup is successful, open your browser at http://127.0.0.1:5000.

Step 4: Create Your First User Account

  • Open the signup page from the header or directly navigate to /signup.
  • Complete signup and download/store the generated key JSON safely.
  • This key is your login identity for future sessions.
  • Log in with the uploaded key file or manual key string.

After login, non-owner users are redirected through queue protection before entering chat.

Step 5: Access the Owner Dashboard

Owner access is separate from standard users. To enter owner mode:

  • Use the owner master key in the login flow (manual key field).
  • On success, you are redirected to /dashboard.
  • Use dashboard tabs for system status, profile, API keys, donation controls, and user management telemetry.
Important: Rotate and store the owner master key securely. Never expose it in frontend code, screenshots, or client logs.

Step 6: Run a Functional Smoke Test

  • Verify /docs opens and redirects to /docs/introduction.
  • Verify signup and login for a standard user.
  • Send one message in chat and confirm response appears.
  • Log in as owner and confirm /dashboard loads all tabs.

You now have a full local DEQLYNK flow running and are ready to continue with API setup, external distillation providers, and deeper model education content.