yan/rvs-prxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
ae15f30253
rvs-prxy/Design_Doc/DevProc.md

2.2 KiB
Raw Blame History

Purpose of this file

  • This shows the Development Processes work.
  • Current tool(s) with LLM Qwen-coder-plus, deepseek, etc.

Development Processes: The following is sorted with the latest items at the top.

make a generic doc. for this arch.

  • Add more detail into Design_Doc/architecture.md: 1) Add block diagram(s) as visualization of the description of Design_Doc/architecture.md, 2) attached auto-sys-deploy-ref.sh and update-compose-config-ref.sh with corresponding auto-sys-deploy.sh.md and update-compose-config.sh.md as an example, using real example parameters, outputs, etc. during the explanation.

  • Base your understand of auto-sys-deploy-ref.sh and update-compose-config-ref.sh with your mardown documents at Design_Doc/. I aim to have a summary document at Design_Doc/architecture.md, it talks about the generic concept of this architecture which can apply to any applications with clearly listing the parameters and corresponding outputs. For example, currently auto-sys-deploy-ref.sh and update-compose-config-ref.sh:

    • Prerequisites
      • Using FRP (fast reverse proxy) service with frpc and frps
      • using Traefik
      • Docker and Docker Compose installed
      • SSH key at ~/.ssh/itl-devs1 for proxy server access
      • DOWNLOAD_SOURCE environment variable set
      • User permissions for Docker commands
      • SSH keys for authentication (~/.ssh/authorized_keys and ~/.ssh/devs1)
    • parameters
      • Instance Name: Alphanumeric, hyphens, and underscores only
      • Docker Network: Existing Docker network or custom network name
      • FRP Server Address: IP address of the FRP server
      • FRP Server Port: Default is 16999
      • Proxy Ports: Configurable remote ports for rad (default 8776), ssh (default 22), and web (default 80) proxies
      • application port(s)
      • Domain name for Traefik routing rules
    • outcomes
      • public domain connected to a internal service.
    • etc.

Understand how previous to do

  • Analysis and explain these two scripts to me: auto-sys-deploy-ref.sh and update-compose-config-ref.sh; Write your explaination into Design_Doc/auto-sys-deploy.sh.md and Design_Doc/update-compose-config.sh.md corresponding.