mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-02-22 05:29:01 -06:00
Code Issues Packages Projects Releases Wiki Activity

move getting started section from README -> docs

Browse Source
This commit is contained in:
A.Unger
2019-12-17 15:09:24 +01:00
parent c1af1196d6
commit 3c1a837784
2 changed files with 43 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@@ -26,49 +26,6 @@ make generate build
./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
If you find a security issue please contact security@owncloud.com first.

43
docs/content/getting-started.md
View File

@@ -17,6 +17,49 @@ TBD
TBD
## Runtime
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.
## Configuration
We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.