Skip to content

INDEX.md

Latest commit

 

History

History
321 lines (206 loc) · 7.13 KB

INDEX.md

File metadata and controls

321 lines (206 loc) · 7.13 KB

Documentation Index

Welcome! Find what you need quickly.

🚀 Start Here

New to the project?
→ Quick Start Guide - Be running in 5 minutes

Want to understand the project?
→ README.md - Complete overview

Need to configure something?
→ Configuration Guide - All config fields explained

📚 Documentation by Goal

I want to...

...set up the project quickly
→ Quick Start - 5-minute setup

...configure auth servers
→ Config Guide - auth_servers

...customize UI text
→ Locale Guide - Text labels and translations

...understand authentication flows
→ Architecture - How authentication works

...integrate with the API
→ API Reference - Endpoint documentation

...use SIM verification (TS43)
→ TS43 Guide - SIM-based auth

...use SMS OTP verification
→ SMS Flow Guide - SMS-based phone verification

...customize app behavior
→ App Config - UI and versioning settings

📖 All Documentation Files

User Guides

Feature Guides

Reference

Documentation Structure

docs/
├── INDEX.md           ← You are here
├── QUICKSTART.md      ← Start here for setup
├── CONFIG_DEFAULT_JSON_SAMPLE.md  ← Config reference
├── LOCALE.md          ← UI text customization
├── TS43.md            ← SIM verification guide
├── SMS.md             ← SMS OTP verification guide
├── API.md             ← API endpoint reference
├── ARCHITECTURE.md    ← System overview
└── APP_CONFIG_JSON.md ← App behavior settings

Need Help?

Common Questions

Q: How do I start the app?
A: See Quick Start

Q: How do I add another auth server?
A: Edit auth_servers array in config - Guide

Q: How do I change button labels?
A: Edit locale in config - Guide

Q: How do I enable SIM verification?
A: Add pvn_sim to clients - TS43 Guide

Q: How do I enable SMS OTP verification?
A: Add pvn_sms to clients - SMS Flow Guide

Q: Where are the API endpoints?
A: See API Documentation

Resources

File Descriptions

Click to see detailed description of each documentation file

Quick Start Guide

File: docs/QUICKSTART.md

Contents:

  • 5-minute setup instructions
  • Prerequisites checklist
  • Common issues and solutions
  • Testing different flows

Best for: First-time users, quick setup

Main README

File: README.md (root directory)

Contents:

  • Project overview
  • Features list
  • Installation instructions
  • Configuration guide
  • User flows explanation
  • API endpoints overview
  • Docker deployment
  • Development guide
  • Troubleshooting

Best for: Complete reference, understanding the project

API Documentation

File: docs/API.md

Contents:

  • Detailed endpoint documentation
  • Request/response formats
  • Query parameters
  • Status codes
  • WebSocket events
  • Error handling
  • Code examples

Best for: API integration, endpoint reference

Architecture Documentation

File: docs/ARCHITECTURE.md

Contents:

  • System architecture diagrams
  • Component structure
  • Data flow diagrams
  • Security architecture
  • Module structure
  • Performance considerations
  • Extension points

Best for: Understanding system design, extending the application

TS43 Route Documentation

File: docs/TS43.md

Contents:

  • TS43 router responsibilities and flow
  • Endpoint behavior and request/response fields
  • Helper function roles
  • Key code snippet for digital request output

Best for: Understanding TS43 flow and router behavior

SMS Flow Documentation

File: docs/SMS.md

Contents:

  • SMS OTP verification flow (CIBA with channel sms)
  • Quick setup and configuration
  • Frontend integration (login button, start_pvn_sms, start_sms_flow)
  • API endpoints: /sms/auth, /sms/token, /sms/log
  • Backend → auth server: CIBA auth, SMS callback, token exchange
  • Troubleshooting

Best for: Implementing or debugging SMS phone verification

Sample Config Reference

File: docs/CONFIG_DEFAULT_JSON_SAMPLE.md

Contents:

  • How to copy and apply the sample config
  • Required vs optional configuration fields
  • Auth servers configuration (multi-server support)
  • Client flow configuration with credential override mechanism
  • Locale override fields
  • Configuration examples and troubleshooting

Best for: Understanding and customizing config/default.json.sample

Key Features:

  • Multi auth server support with dropdown selection
  • Credential fallback mechanism (root vs per-client)
  • Complete field validation on startup

App Config Reference

File: docs/APP_CONFIG_JSON.md

Contents:

  • App UI configuration schema
  • Versioning and maintenance settings
  • Branding, environment labels, and screen text
  • Override examples via config/default.json

Best for: Customizing config/app_config.json and app UI behavior

Locale Configuration

File: docs/LOCALE.md

Contents:

  • Locale file structure
  • Override mechanism
  • Deep merging behavior
  • Usage examples
  • Troubleshooting guide

Best for: Customizing UI text labels, internationalization setup

Documentation Conventions

Code Examples

All code examples use:

  • bash for shell commands
  • json for configuration files
  • javascript for code snippets

Diagrams

Architecture diagrams use ASCII art format for universal compatibility.

Links

  • Internal links use relative paths
  • External links open in new tabs (when applicable)

Contributing to Documentation

When updating documentation:

  1. Keep examples up-to-date with code changes
  2. Update all affected documentation files
  3. Test code examples before committing
  4. Follow existing documentation style
  5. Update this index if adding new documentation files

Documentation Updates

Last Updated: [Current Date]

Version: 1.1.27-SNAPSHOT

Maintainer: Development Team

Feedback

For documentation feedback or improvements:

  • Create an issue in the repository
  • Submit a pull request with improvements
  • Contact the development team