feat: update docs

main
Johnson 2 years ago
parent 36cabc7cbc
commit 8c09b2d5e5

@ -10,7 +10,7 @@ Go micro dashboard is designed to make it as easy as possible for users to work
- [ ] Register service - [ ] Register service
- [ ] Deregister service - [ ] Deregister service
- [x] Health check - [x] Health check
- [ ] Configure service - [ ] Configuration service
- [x] Synchronous communication - [x] Synchronous communication
- [x] RPC - [x] RPC
- [ ] Stream - [ ] Stream
@ -42,6 +42,37 @@ default username: admin
default password: micro 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 ### Web UI
[Document](https://github.com/go-micro/dashboard/tree/main/frontend) [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) - [Slack](https://join.slack.com/t/go-micro/shared_invite/zt-175aaev1d-iHExPTlfxvfkOeeKLIYEYw)
- [QQ Group](https://jq.qq.com/?_wv=1027&k=5Gmrfv9i) - [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 ## License
[Apache License 2.0](./LICENSE) [Apache License 2.0](./LICENSE)

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

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

Binary file not shown.

After

Width:  |  Height:  |  Size: 226 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 878 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 792 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 951 KiB

Loading…
Cancel
Save