Merge pull request #11 from go-micro/dev

feat: update documents

README.md

@@ -10,7 +10,7 @@ Go micro dashboard is designed to make it as easy as possible for users to work
   - [ ] Register service
   - [ ] Deregister service
 - [x] Health check
-- [ ] Configure service
+- [ ] Configuration service
 - [x] Synchronous communication
   - [x] RPC
   - [ ] Stream
@@ -42,6 +42,37 @@ default username: admin
 default password: micro
 ```
 
+##### ENV
+```
+export SERVER_ADDRESS=:8082
+export SERVER_AUTH_USERNAME=user
+export SERVER_AUTH_PASSWORD=pass
+```
+
+##### YAML
+```
+export CONFIG_TYPE=yaml
+```
+```yaml
+server:
+  env: "dev"
+  address: ":8082"
+  swagger:
+    host: "localhost:8082"
+```
+
+##### TOML
+```
+export CONFIG_TYPE=toml
+```
+```toml
+[server]
+env = "dev"
+address = ":8082"
+[server.swagger]
+host = "localhost:8082"
+```
+
 ### Web UI
 
 [Document](https://github.com/go-micro/dashboard/tree/main/frontend)
@@ -76,6 +107,14 @@ kubectl apply -f deployment.yaml
 - [Slack](https://join.slack.com/t/go-micro/shared_invite/zt-175aaev1d-iHExPTlfxvfkOeeKLIYEYw)
 - [QQ Group](https://jq.qq.com/?_wv=1027&k=5Gmrfv9i)
 
+## Screen Shots
+![Login](docs/screenshots/1.login.png)
+![Dashboard](docs/screenshots/2.dashboard.png)
+![Services](docs/screenshots/3.services.png)
+![Service Detail](docs/screenshots/4.service%20detail.png)
+![Nodes](docs/screenshots/5.nodes.png)
+![Request](docs/screenshots/6.call.png)
+
 ## License
 
 [Apache License 2.0](./LICENSE)

deployment.yaml

@@ -56,7 +56,7 @@ spec:
       containers:
         - image: xpunch/go-micro-dashboard:latest
           imagePullPolicy: IfNotPresent
-          name: micro-dashboard
+          name: dashboard
           ports:
             - containerPort: 80
               protocol: TCP
@@ -65,6 +65,9 @@ spec:
               value: "kubernetes"
             - name: MICRO_CLIENT_RETRIES
               value: "0"
+            # default config type env
+            # - SERVER_AUTH_USERNAME=user
+            # - SERVER_AUTH_PASSWORD=pass
           resources:
             limits:
               memory: 512Mi

docker-compose.yml

@@ -11,5 +11,8 @@ services:
       - MICRO_REGISTRY_ADDRESS=etcd
       - CONFIG_TYPE=yaml
       - CONFIG_FILE=/etc/micro/dashboard.yaml
+      # default config type env
+      # - SERVER_AUTH_USERNAME=user
+      # - SERVER_AUTH_PASSWORD=pass
     volumes:
       - "./config.yaml:/etc/micro/dashboard.yaml"