mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-01-06 12:19:37 -06:00
update readme with usage
This commit is contained in:
43
README.md
43
README.md
@@ -26,6 +26,49 @@ make generate build
|
|||||||
./bin/ocis -h
|
./bin/ocis -h
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
Included with the ocis binary is embedded a go-micro runtime that is in charge of starting services as a fork of the master process. This provides complete control over the services. Ocis extensions can be added as part of this runtime.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
> ./bin/ocis micro
|
||||||
|
```
|
||||||
|
|
||||||
|
This will currently boot:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go.micro
|
||||||
|
go.micro.api
|
||||||
|
go.micro.bot
|
||||||
|
go.micro.broker
|
||||||
|
go.micro.debug
|
||||||
|
go.micro.http.broker
|
||||||
|
go.micro.monitor
|
||||||
|
go.micro.network
|
||||||
|
go.micro.proxy
|
||||||
|
go.micro.registry
|
||||||
|
go.micro.router
|
||||||
|
go.micro.runtime
|
||||||
|
go.micro.store
|
||||||
|
go.micro.tunnel
|
||||||
|
go.micro.web
|
||||||
|
```
|
||||||
|
|
||||||
|
Further ocis extensions can be added to the runtime via the ocis command like:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
./bin/ocis hello
|
||||||
|
```
|
||||||
|
|
||||||
|
Which whill register:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go.micro.web.hello
|
||||||
|
go.micro.api.hello
|
||||||
|
```
|
||||||
|
|
||||||
|
To the list of available services.
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
||||||
If you find a security issue please contact security@owncloud.com first.
|
If you find a security issue please contact security@owncloud.com first.
|
||||||
|
|||||||
Reference in New Issue
Block a user