Peek Platform Documentation

Contents:

• How to Use Peek Documentation
• Overview
  • Architecture
  • Services
    • Peek Logic Service
    • Storage Service
    • Field Service
    • Field App
    • Office Service
    • Office App
    • Worker Service
    • Agent Service
    • Admin App
  • Plugins
    • Enterprise Extensible
    • One Plugin, One Package
  • Noop Plugin Example
• Tutorials
  • Peek Plugin Tutorial
    • First Steps
    • Scaffolding From Scratch
    • Add Documentation
    • Add Logic Service
    • Add Agent Service
    • Add Storage Service
    • Add Admin App
    • Add Field App
    • Add Field Service
    • Add Office App
    • Add Office Service
    • Add Tuples
    • Add Tuple Loader
    • Add Offline Storage
    • Add Observables
    • Add Actions
    • Add Vortex RPC
    • Add Plugin Python API
    • Add Plugin TypeScript APIs (TODO)
    • Use Plugin APIs (TODO)
    • Add Worker Service
    • Challenges
  • Twisted Python Tutorial
    • Understanding Twisted
    • Understanding Deferreds
    • Twisted Challenges
    • Understanding VortexPy
  • Python Gotchas
    • List Iteration Modification
    • Mutable Class Variables
    • Mutable Default Function Arguments
  • ReStructuredText Cheat Sheet
    • Sections
    • Header 2
    • Inline Markups
    • Files
    • Reference Links
    • URL Link
    • Code Block
    • Bullets
    • Numbered Lists
    • Directives
    • Images
    • Admonitions
    • TOC tree
    • Docstring Format
• Setup OS Requirements
  • Setup OS Requirements Windows
    • Installation Objective
    • OS Commands
    • Installation Guide
    • Create Peek OS User
    • MS .NET Framework 3.5 SP1
    • Visual C++ Build Tools 2015
    • Setup Msys Git
    • Install PostgresSQL
    • Install Python 3.6
    • Install Worker Dependencies
    • Install Oracle Client (Optional)
    • Install FreeTDS (Optional)
    • What Next?
  • Setup OS Requirements macOS
    • Installation Objective
    • Installation Guide
    • Set Terminal shell to Bash
    • Safari Open Safe Files
    • Create Peek Platform OS User
    • Install Xcode
    • Install Homebrew
    • Preparing .bash_profile
    • Install Python 3.9.1
    • Install PostgreSQL
    • Install Worker Dependencies
    • Install Oracle Client (Optional)
    • Change Open File Limit on macOS
    • What Next?
  • Setup OS Requirements RHEL 7
    • Installation Objective
    • Installation Guide
    • Install Red Hat Linux Server 7.7 OS
    • Login as Peek
    • Registering RHEL
    • Removing IPv6 Localhost
    • Installing General Prerequisites
    • Installing VMWare Tools (Optional)
    • Update Firewall
    • Preparing .bashrc
    • Compile and Install Python 3.9.1
    • Install PostgreSQL
    • Install Worker Dependencies
    • Install Oracle Client (Optional)
    • Install FreeTDS (Optional)
    • What Next?
  • Setup OS Requirements RHEL 8
    • Staring Off
    • Partition Table
  • Setup OS Requirements Debian
    • Installation Objective
    • Installation Guide
    • Install Debian 10 OS
    • SSH Setup
    • Login as Peek
    • Configure Static IP (Optional)
    • Installing General Prerequisites
    • Installing VMWare Tools (Optional)
    • Preparing .bashrc
    • Compile and Install Python 3.9.1
    • Install PostgreSQL
    • Install Worker Dependencies
    • Install Oracle Client (Optional)
    • Install FreeTDS (Optional)
    • What Next?
  • What Next?
• Deploy Peek Release
  • Windows
    • Deploy Virtual Environment
  • Linux
  • macOS
  • Development Considerations
  • What Next?
• Administration
  • Configuring Platform config.json
    • Peek Logic Service
    • Peek Field Service
    • Peek Office Service
    • Peek Agent Service
    • Peek Field, Office, Logic Service SSL
  • Install Self Signed Certificates
    • Create the Certificates
    • Update Service Configuration Files
    • Complete
  • Configure Mutual TLS
    • Complete
  • Manage Peek Services
    • Peek Services
    • Peek Service State Transition
    • Peek Service Management Commands
    • Inspect Live Peek Processes
  • Run Peek Manually
    • Check Environment
    • run_peek_logic_service
    • run_peek_office_service
    • run_peek_agent_service
    • Whats Next
  • Logs
  • Getting Support
    • Enterprise Support
    • Reporting Bugs
  • Updating Plugin Settings
  • Peek Windows Admin
    • Windows Services
    • Backup and Restore PostgreSQL DB
• Capacitor App
  • Build Capacitor App
    • iOS
  • What Next?
• Peek Development
  • Develop Peek Plugin Guides
    • Develop Peek Plugins
    • Setup Plugin for Development
    • Developing With The Frontends
    • Continue Development
    • What Next?
  • Publish Peek Plugins
    • Create Private Plugin Release
    • Create PyPI Public Release
    • What Next?
  • Package Peek Plugins
    • Packaging a Production Release
    • What Next?
  • Develop Peek Platform
    • Development Setup Objective
    • Hardware Recommendation
    • Software Installation and Configuration
    • What Next?
  • Publish Peek Platform
    • Building a Production Release
    • Building a Development Release
    • What Next?
  • Package Peek Platform
    • Building a Windows Release
    • Building a Linux Release
    • Building a macOS Release
    • What Next?
  • Setup Pycharm IDE
  • Setup VS Code IDE
  • Helper Scripts for Development
    • git_check_sync.py
    • git_check_branch.sh
    • git_optimize.sh
  • What Next?
• Troubleshooting
  • Troubleshooting Windows
    • Test cx_Oracle in Python
  • Troubleshooting Debian
    • Test cx_Oracle in Python
    • OSError: inotify instance limit reached
  • Troubleshooting macOS
    • Test cx_Oracle in Python
    • ORA-21561: OID generation failed
• Utilities
• API Reference
• Release Notes
  • PEEP Overviews
    • PEEP 0-10
  • v3.4.x UAT Results
    • v3.4.0 UAT Results
  • v3.4.x Release Notes
    • Platform Changes
    • Major Plugin Changes
    • Deployment Changes
    • Migration Steps
    • User Acceptance Test Results
    • v3.4.16 Changes
    • v3.4.15 Changes
    • v3.4.14 Changes
    • v3.4.13 Changes
    • v3.4.12 Changes
    • v3.4.11 Changes
    • v3.4.10 Changes
    • v3.4.9 Changes
    • v3.4.8 Changes
    • v3.4.7 Changes
    • v3.4.6 Changes
    • v3.4.5 Changes
    • v3.4.4 Changes
    • v3.4.3 Changes
    • v3.4.2 Changes
    • v3.4.1 Changes
    • v3.4.0 Changes
  • v3.3.x Release Notes
    • Platform Changes
    • Major Plugin Changes
    • Deployment Changes
    • Migration Steps
    • v3.3.4 Changes
    • v3.3.3 Changes
    • v3.3.2 Changes
    • v3.3.1 Changes
    • v3.3.0 Changes
  • v3.2.x Release Notes
    • Platform Changes
    • Major Plugin Changes
    • Deployment Changes
    • Migration Steps
    • v3.2.13 Changes
    • v3.2.12 Changes
    • v3.2.11 Changes
    • v3.2.10 Changes
    • v3.2.9 Changes
    • v3.2.8 Changes
    • v3.2.7 Changes
    • v3.2.6 Changes
    • v3.2.5 Changes
    • v3.2.4 Changes
    • v3.2.3 Changes
    • v3.2.2 Changes
    • v3.2.1 Changes
    • v3.2.0 Changes
  • v3.1.x Release Notes
    • Platform Changes
    • Major Plugin Changes
    • Deployment Changes
    • Migration Steps
    • User Acceptance Test Results
    • v3.1.10 Changes
    • v3.1.9 Changes
    • v3.1.8 Changes
    • v3.1.6 Changes
    • v3.1.5 Changes
    • v3.1.4 Changes
    • v3.1.3 Changes
    • v3.1.2 Changes
    • v3.1.1 Changes
    • v3.1.0 Changes
  • v3.1.x UAT Results
    • v3.1.10 UAT Results
    • v3.1.8 UAT Results
    • v3.1.0 UAT Results
  • v3.0.x Release Notes
    • Platform Changes
    • Major Plugin Changes
    • Deployment Changes
    • Migration Steps
    • v3.0.0 Issues Log
  • v2.5.x Release Notes
    • Platform Changes
    • Major Plugin Changes
    • Deployment Changes
    • Migration Steps
    • v2.5.4 Issues Log
    • v2.5.3 Issues Log
    • v2.5.2 Issues Log
    • v2.5.1 Issues Log
    • v2.5.0 Issues Log
  • v2.4.x Release Notes
    • Platform Changes
    • Major Plugin Changes
    • Deployment Changes
    • Migration Steps
    • v2.4.5 Issues Log
    • v2.4.4 Issues Log
    • v2.4.3 Issues Log
    • v2.4.2 Issues Log
    • v2.4.1 Issues Log
    • v2.4.0 Issues Log
  • v2.3.x Release Notes
    • Platform Changes
    • Plugin Changes
    • Deployment Changes
    • Migration Steps
    • v2.3.3 Issues Log
    • v2.3.2 Issues Log
    • v2.3.1 Issues Log
    • v2.3.0 Issues Log
  • v2.2.x Release Notes
    • Platform Changes
    • Plugin Changes
    • Deployment Changes
    • Migration Steps
    • v2.2.2 Issues Log
    • v2.2.1 Issues Log
    • v2.2.0 Issues Log
  • v2.1.x Release Notes
    • Platform Changes
    • Plugin Changes
    • Deployment Changes
    • Migration Steps
    • v2.1.7 Issues Log
    • v2.1.6 Issues Log
    • v2.1.5 Issues Log
    • v2.1.4 Issues Log
    • v2.1.3 Issues Log
    • v2.1.2 Issues Log
    • v2.1.1 Issues Log
    • v2.1.0 Issues Log
  • v2.0.x Release Notes
    • Platform Changes
    • Plugin Changes
    • Deployment Changes
    • Migration Steps
    • v2.0.5 Issues Log
    • v2.0.4 Issues Log
    • v2.0.3 Issues Log
    • v2.0.1 Issues Log
    • v2.0.0 Issues Log
  • v1.3.x Release Notes
    • Changes
    • Linux Deployment
    • macOS Deployment
    • iOS Deployment
    • Windows Deployment
    • Enable New Plugins
  • v1.2.x Release Notes
    • Changes
    • Linux Deployment
    • macOS Deployment
    • iOS Deployment
    • Windows Deployment
    • Enable New Plugins
  • v1.1.0 Release Notes
    • Changes
    • Linux Deployment
    • macOS Deployment
    • Windows Deployment
    • Enable New Plugins
  • v0.10.0 Release Notes
    • Changes
    • Deployment
  • v0.6.0 Release Notes
    • NPM : peek-field-app-util
• Security Errata
  • 230824 [CVE-2023-40217] Bypass TLS handshake on closed sockets
    • Vulnerability Details
    • Patch Instructions

Indices and tables

• Index

• Module Index

• Search Page