Skip to content

[WeOpen-Star] Optimize shenyu configuration document #674

@yu199195

Description

@yu199195

Admin Config

The original config yamil file : https://github.com/apache/shenyu/blob/master/shenyu-admin/src/main/resources/application.yml

Now, maybe loss this config:

shenyu:
  sync:
     websocket:
         messageMaxSize: 10240
         allowOrigins: ws://localhost:9095;ws://localhost:9195;

  apidoc:
    gatewayUrl: http://127.0.0.1:9195
    envProps:
      - envLabel: Test environment
        addressLabel: Request Address
        addressUrl: http://127.0.0.1:9195
      - envLabel: Prod environment
        addressLabel: Request Address
        addressUrl: http://127.0.0.1:9195

And remove this config :

shenyu
   database:
    dialect: mysql
    init_script: "META-INF/schema.sql"
    init_enable: true

Task

  1. modify this en file : https://github.com/apache/shenyu-website/blob/main/docs/user-guide/property-config/admin-property-config.md

  2. modify this zh file : https://github.com/apache/shenyu-website/blob/main/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/property-config/admin-property-config.md

Verification Admin Config

After you modify file ,You verify local and you can see this : Hao to build shenyu website .

After you pull request merged. You can verify to this : en-doc , zh-doc

Gateway Config

The original config yamil file : https://github.com/apache/shenyu/blob/master/shenyu-bootstrap/src/main/resources/application.yml

Now, maybe loss this config:

shenyu:
  matchCache:
    enabled: false
    maxFreeMemory: 256 # 256MB
   cross:
       originRegex: ^http(|s)://(.*\.|)abc.com$
   sync:
      websocket:
          allowOrigin: ws://localhost:9195
   fallback:
     enabled: false
     paths:
        - /fallback/hystrix
        - /fallback/resilience4j
    health:
       enabled: false
       paths:
          - /actuator/health
          - /health_check
    metrics:
       enabled: false
       name : prometheus
       host: 127.0.0.1
       port: 8090
       jmxConfig:
       props:
         jvm_enabled: true
   plugins:
        rate-limiter.enabled: false
  local:
    enabled: false
    sha512Key: "BA3253876AED6BC22D4A6FF53D8406C6AD864195ED144AB5C87621B6C233B548BAEAE6956DF346EC8C17F5EA10F35EE3CBC514797ED7DDD3145464E2A0BAB413" 
  sharedPool:
     enable: true
      prefix: "shenyu-shared"
      corePoolSize: 200
      maximumPoolSize: 2000
      keepAliveTime: 60000
     maxWorkQueueMemory: 1073741824
   maxFreeMemory: 268435456

Task

  1. modify this en file : https://github.com/apache/shenyu-website/blob/main/docs/user-guide/property-config/gateway-property-config.md

  2. modify this zh file : https://github.com/apache/shenyu-website/blob/main/i18n/zh/docusaurus-plugin-content-docs/current/user-guide/property-config/gateway-property-config.md

Verification Gateway Config

After you modify file ,You verify local and you can see this : Hao to build shenyu website .

After you pull request merged. You can verify to this : en-doc , zh-doc

How to contributor

You can see this : Contributor Guide

  1. I suggest you subscribe to shenyu dev mailing list, and when you encounter any problems, or when you finish,
    you can send an email to dev@shenyu.apache.org

  2. I suggest you git clone the source code and finish the changes. like this :

fork this to you repository : https://github.com/apache/shenyu-website.git

git clone git@github.com:${YOUR_USERNAME}/${TARGET_REPO}.git

git checkout -b a-dev-branch

git push origin a-dev-branch

How to Participation

  1. reply: [WeOpen Star]I would like to help
    2.add this wechat

image

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions