diff --git a/internal/website/docs/index.md b/internal/website/docs/index.md index 5cc42535..b5e50c54 100644 --- a/internal/website/docs/index.md +++ b/internal/website/docs/index.md @@ -34,3 +34,4 @@ about the framework. - [Store](store.md) - [Plugins](plugins.md) - [Examples](examples/index.md) +- [Server (optional)](server.md) diff --git a/internal/website/docs/server.md b/internal/website/docs/server.md new file mode 100644 index 00000000..6f6b3d75 --- /dev/null +++ b/internal/website/docs/server.md @@ -0,0 +1,32 @@ +--- +layout: default +--- + +# Micro Server (Optional) + +The Micro server is an optional API and dashboard that provides a fixed entrypoint for discovering and interacting with services. It is not required to build or run services; the examples in this documentation run services directly with `go run`. + +## Install + +Install the CLI which includes the server command: + +``` +go install go-micro.dev/v5/cmd/micro@latest +``` + +## Run + +Start the server: + +``` +micro server +``` + +Then open http://localhost:8080 in your browser. + +## When to use it +- Exploring registered services and endpoints +- Calling endpoints via a web UI or HTTP API +- Local development and debugging + +Note: The server is evolving and configuration or features may change. For CLI usage details, see `cmd/micro/cli/README.md` in this repository.