User Manual

  1. Download the latest version of Sharding-Proxy from
  2. If using docker´╝îexecute command docker pull shardingsphere/sharding-proxy to get image. More details please referenceDocker Image.
  3. Modify the conf/server.yaml and conf/config-xxx.yaml file after decompression, and configure the sharding rule and master-slave rule. Please reference Configuration Manual.
  4. Run bin/ on Linux, or bin/start.bat on Windows to start Sharding-Proxy. If you want to set port and configuration file, please refer to quick-start.
  5. Connect to it by means of any client tools, e.g. mysql -u root -h -P 3307


  1. The default port of Sharding-Proxy is 3307, user can change it by passing the port number on startup script, e.g. bin/ 3308.
  2. Sharding-Proxy use conf/server.yaml to configure registry-center, authentication and common properties.
  3. Sharding-Proxy support multiple logic schema, for every configuration file which prefix as config-, and suffix as .yaml.