run remark linter locally
This commit is contained in:
+79
-80
@@ -1,4 +1,4 @@
|
||||
# Changelog for [unreleased] (UNRELEASED)
|
||||
# Changelog for [unreleased] \(UNRELEASED)
|
||||
|
||||
The following sections list the changes in ocis-ocs unreleased.
|
||||
|
||||
@@ -6,20 +6,20 @@ The following sections list the changes in ocis-ocs unreleased.
|
||||
|
||||
## Summary
|
||||
|
||||
* Bugfix - Match the user response to the OC10 format: [#181](https://github.com/owncloud/product/issues/181)
|
||||
- Bugfix - Match the user response to the OC10 format: [#181](https://github.com/owncloud/product/issues/181)
|
||||
|
||||
## Details
|
||||
|
||||
* Bugfix - Match the user response to the OC10 format: [#181](https://github.com/owncloud/product/issues/181)
|
||||
- Bugfix - Match the user response to the OC10 format: [#181](https://github.com/owncloud/product/issues/181)
|
||||
|
||||
The user response contained the field `displayname` but for certain responses the field
|
||||
`display-name` is expected. The field `display-name` was added and now both fields are
|
||||
returned to the client.
|
||||
The user response contained the field `displayname` but for certain responses the field
|
||||
`display-name` is expected. The field `display-name` was added and now both fields are
|
||||
returned to the client.
|
||||
|
||||
https://github.com/owncloud/product/issues/181
|
||||
https://github.com/owncloud/ocis/ocs/pull/61
|
||||
<https://github.com/owncloud/product/issues/181>
|
||||
<https://github.com/owncloud/ocis/ocs/pull/61>
|
||||
|
||||
# Changelog for [0.3.1] (2020-09-02)
|
||||
# Changelog for [0.3.1] \(2020-09-02)
|
||||
|
||||
The following sections list the changes in ocis-ocs 0.3.1.
|
||||
|
||||
@@ -27,28 +27,28 @@ The following sections list the changes in ocis-ocs 0.3.1.
|
||||
|
||||
## Summary
|
||||
|
||||
* Bugfix - Add the top level response structure to json responses: [#181](https://github.com/owncloud/product/issues/181)
|
||||
* Enhancement - Update ocis-accounts: [#42](https://github.com/owncloud/ocis/ocs/pull/42)
|
||||
- Bugfix - Add the top level response structure to json responses: [#181](https://github.com/owncloud/product/issues/181)
|
||||
- Enhancement - Update ocis-accounts: [#42](https://github.com/owncloud/ocis/ocs/pull/42)
|
||||
|
||||
## Details
|
||||
|
||||
* Bugfix - Add the top level response structure to json responses: [#181](https://github.com/owncloud/product/issues/181)
|
||||
- Bugfix - Add the top level response structure to json responses: [#181](https://github.com/owncloud/product/issues/181)
|
||||
|
||||
Probably during moving the ocs code into the ocis-ocs repo the response format was changed.
|
||||
This change adds the top level response to json responses. Doing that the reponse should be
|
||||
compatible to the responses from OC10.
|
||||
Probably during moving the ocs code into the ocis-ocs repo the response format was changed.
|
||||
This change adds the top level response to json responses. Doing that the reponse should be
|
||||
compatible to the responses from OC10.
|
||||
|
||||
https://github.com/owncloud/product/issues/181
|
||||
https://github.com/owncloud/product/issues/181#issuecomment-683604168
|
||||
<https://github.com/owncloud/product/issues/181>
|
||||
<https://github.com/owncloud/product/issues/181#issuecomment-683604168>
|
||||
|
||||
|
||||
* Enhancement - Update ocis-accounts: [#42](https://github.com/owncloud/ocis/ocs/pull/42)
|
||||
- Enhancement - Update ocis-accounts: [#42](https://github.com/owncloud/ocis/ocs/pull/42)
|
||||
|
||||
Update ocis-accounts to v0.4.2-0.20200828150703-2ca83cf4ac20
|
||||
Update ocis-accounts to v0.4.2-0.20200828150703-2ca83cf4ac20
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/42
|
||||
<https://github.com/owncloud/ocis/ocs/pull/42>
|
||||
|
||||
# Changelog for [0.3.0] (2020-08-27)
|
||||
# Changelog for [0.3.0] \(2020-08-27)
|
||||
|
||||
The following sections list the changes in ocis-ocs 0.3.0.
|
||||
|
||||
@@ -56,35 +56,35 @@ The following sections list the changes in ocis-ocs 0.3.0.
|
||||
|
||||
## Summary
|
||||
|
||||
* Bugfix - Mimic oc10 user enabled as string in provisioning api: [#39](https://github.com/owncloud/ocis/ocs/pull/39)
|
||||
* Bugfix - Use opaque ID of a user for signing keys: [#436](https://github.com/owncloud/ocis/issues/436)
|
||||
* Enhancement - Add option to create user with uidnumber and gidnumber: [#34](https://github.com/owncloud/ocis/ocs/pull/34)
|
||||
- Bugfix - Mimic oc10 user enabled as string in provisioning api: [#39](https://github.com/owncloud/ocis/ocs/pull/39)
|
||||
- Bugfix - Use opaque ID of a user for signing keys: [#436](https://github.com/owncloud/ocis/issues/436)
|
||||
- Enhancement - Add option to create user with uidnumber and gidnumber: [#34](https://github.com/owncloud/ocis/ocs/pull/34)
|
||||
|
||||
## Details
|
||||
|
||||
* Bugfix - Mimic oc10 user enabled as string in provisioning api: [#39](https://github.com/owncloud/ocis/ocs/pull/39)
|
||||
- Bugfix - Mimic oc10 user enabled as string in provisioning api: [#39](https://github.com/owncloud/ocis/ocs/pull/39)
|
||||
|
||||
The oc10 user provisioning API uses a string for the boolean `enabled` flag. 😭
|
||||
The oc10 user provisioning API uses a string for the boolean `enabled` flag. 😭
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/39
|
||||
<https://github.com/owncloud/ocis/ocs/pull/39>
|
||||
|
||||
|
||||
* Bugfix - Use opaque ID of a user for signing keys: [#436](https://github.com/owncloud/ocis/issues/436)
|
||||
- Bugfix - Use opaque ID of a user for signing keys: [#436](https://github.com/owncloud/ocis/issues/436)
|
||||
|
||||
OCIS switched from user the user's opaque ID (UUID) everywhere, so to keep compatible we have
|
||||
adjusted the signing keys endpoint to also use the UUID when storing and generating the keys.
|
||||
OCIS switched from user the user's opaque ID (UUID) everywhere, so to keep compatible we have
|
||||
adjusted the signing keys endpoint to also use the UUID when storing and generating the keys.
|
||||
|
||||
https://github.com/owncloud/ocis/issues/436
|
||||
https://github.com/owncloud/ocis/ocs/pull/32
|
||||
<https://github.com/owncloud/ocis/issues/436>
|
||||
<https://github.com/owncloud/ocis/ocs/pull/32>
|
||||
|
||||
|
||||
* Enhancement - Add option to create user with uidnumber and gidnumber: [#34](https://github.com/owncloud/ocis/ocs/pull/34)
|
||||
- Enhancement - Add option to create user with uidnumber and gidnumber: [#34](https://github.com/owncloud/ocis/ocs/pull/34)
|
||||
|
||||
We have added an option to pass uidnumber and gidnumber to the ocis api while creating a new user
|
||||
We have added an option to pass uidnumber and gidnumber to the ocis api while creating a new user
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/34
|
||||
<https://github.com/owncloud/ocis/ocs/pull/34>
|
||||
|
||||
# Changelog for [0.2.0] (2020-08-17)
|
||||
# Changelog for [0.2.0] \(2020-08-17)
|
||||
|
||||
The following sections list the changes in ocis-ocs 0.2.0.
|
||||
|
||||
@@ -92,37 +92,37 @@ The following sections list the changes in ocis-ocs 0.2.0.
|
||||
|
||||
## Summary
|
||||
|
||||
* Bugfix - Fix file descriptor leak: [#79](https://github.com/owncloud/ocis/accounts/issues/79)
|
||||
* Enhancement - Add Group management for OCS Povisioning API: [#25](https://github.com/owncloud/ocis/ocs/pull/25)
|
||||
* Enhancement - Basic Support for the User Provisioning API: [#23](https://github.com/owncloud/ocis/ocs/pull/23)
|
||||
- Bugfix - Fix file descriptor leak: [#79](https://github.com/owncloud/ocis/accounts/issues/79)
|
||||
- Enhancement - Add Group management for OCS Povisioning API: [#25](https://github.com/owncloud/ocis/ocs/pull/25)
|
||||
- Enhancement - Basic Support for the User Provisioning API: [#23](https://github.com/owncloud/ocis/ocs/pull/23)
|
||||
|
||||
## Details
|
||||
|
||||
* Bugfix - Fix file descriptor leak: [#79](https://github.com/owncloud/ocis/accounts/issues/79)
|
||||
- Bugfix - Fix file descriptor leak: [#79](https://github.com/owncloud/ocis/accounts/issues/79)
|
||||
|
||||
Only use a single instance of go-micro's GRPC client as it already does connection pooling.
|
||||
This prevents connection and file descriptor leaks.
|
||||
Only use a single instance of go-micro's GRPC client as it already does connection pooling.
|
||||
This prevents connection and file descriptor leaks.
|
||||
|
||||
https://github.com/owncloud/ocis/accounts/issues/79
|
||||
https://github.com/owncloud/ocis/ocs/pull/29
|
||||
<https://github.com/owncloud/ocis/accounts/issues/79>
|
||||
<https://github.com/owncloud/ocis/ocs/pull/29>
|
||||
|
||||
|
||||
* Enhancement - Add Group management for OCS Povisioning API: [#25](https://github.com/owncloud/ocis/ocs/pull/25)
|
||||
- Enhancement - Add Group management for OCS Povisioning API: [#25](https://github.com/owncloud/ocis/ocs/pull/25)
|
||||
|
||||
We added support for the group management related set of API calls of the provisioning API.
|
||||
[Reference](https://doc.owncloud.com/server/admin_manual/configuration/user/user_provisioning_api.html)
|
||||
We added support for the group management related set of API calls of the provisioning API.
|
||||
[Reference](https://doc.owncloud.com/server/admin_manual/configuration/user/user_provisioning_api.html)
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/25
|
||||
<https://github.com/owncloud/ocis/ocs/pull/25>
|
||||
|
||||
|
||||
* Enhancement - Basic Support for the User Provisioning API: [#23](https://github.com/owncloud/ocis/ocs/pull/23)
|
||||
- Enhancement - Basic Support for the User Provisioning API: [#23](https://github.com/owncloud/ocis/ocs/pull/23)
|
||||
|
||||
We added support for a basic set of API calls for the user provisioning API.
|
||||
[Reference](https://doc.owncloud.com/server/admin_manual/configuration/user/user_provisioning_api.html)
|
||||
We added support for a basic set of API calls for the user provisioning API.
|
||||
[Reference](https://doc.owncloud.com/server/admin_manual/configuration/user/user_provisioning_api.html)
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/23
|
||||
<https://github.com/owncloud/ocis/ocs/pull/23>
|
||||
|
||||
# Changelog for [0.1.0] (2020-07-23)
|
||||
# Changelog for [0.1.0] \(2020-07-23)
|
||||
|
||||
The following sections list the changes in ocis-ocs 0.1.0.
|
||||
|
||||
@@ -130,51 +130,50 @@ The following sections list the changes in ocis-ocs 0.1.0.
|
||||
|
||||
## Summary
|
||||
|
||||
* Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#20](https://github.com/owncloud/ocis/ocs/pull/20)
|
||||
* Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/ocs/issues/1)
|
||||
* Change - Upgrade micro libraries: [#11](https://github.com/owncloud/ocis/ocs/issues/11)
|
||||
* Enhancement - Configuration: [#14](https://github.com/owncloud/ocis/ocs/pull/14)
|
||||
* Enhancement - Support signing key: [#18](https://github.com/owncloud/ocis/ocs/pull/18)
|
||||
- Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#20](https://github.com/owncloud/ocis/ocs/pull/20)
|
||||
- Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/ocs/issues/1)
|
||||
- Change - Upgrade micro libraries: [#11](https://github.com/owncloud/ocis/ocs/issues/11)
|
||||
- Enhancement - Configuration: [#14](https://github.com/owncloud/ocis/ocs/pull/14)
|
||||
- Enhancement - Support signing key: [#18](https://github.com/owncloud/ocis/ocs/pull/18)
|
||||
|
||||
## Details
|
||||
|
||||
* Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#20](https://github.com/owncloud/ocis/ocs/pull/20)
|
||||
- Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#20](https://github.com/owncloud/ocis/ocs/pull/20)
|
||||
|
||||
ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.
|
||||
ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/20
|
||||
<https://github.com/owncloud/ocis/ocs/pull/20>
|
||||
|
||||
|
||||
* Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/ocs/issues/1)
|
||||
- Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/ocs/issues/1)
|
||||
|
||||
Just prepared an initial basic version to serve OCS for the ownCloud Infinite Scale project. It
|
||||
just provides a minimal viable product to demonstrate the microservice pattern.
|
||||
Just prepared an initial basic version to serve OCS for the ownCloud Infinite Scale project. It
|
||||
just provides a minimal viable product to demonstrate the microservice pattern.
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/issues/1
|
||||
<https://github.com/owncloud/ocis/ocs/issues/1>
|
||||
|
||||
|
||||
* Change - Upgrade micro libraries: [#11](https://github.com/owncloud/ocis/ocs/issues/11)
|
||||
- Change - Upgrade micro libraries: [#11](https://github.com/owncloud/ocis/ocs/issues/11)
|
||||
|
||||
Updated the micro and ocis-pkg libraries to version 2.
|
||||
Updated the micro and ocis-pkg libraries to version 2.
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/issues/11
|
||||
<https://github.com/owncloud/ocis/ocs/issues/11>
|
||||
|
||||
|
||||
* Enhancement - Configuration: [#14](https://github.com/owncloud/ocis/ocs/pull/14)
|
||||
- Enhancement - Configuration: [#14](https://github.com/owncloud/ocis/ocs/pull/14)
|
||||
|
||||
Extensions should be responsible of configuring themselves. We use Viper for config loading
|
||||
from default paths. Environment variables **WILL** take precedence over config files.
|
||||
Extensions should be responsible of configuring themselves. We use Viper for config loading
|
||||
from default paths. Environment variables **WILL** take precedence over config files.
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/14
|
||||
<https://github.com/owncloud/ocis/ocs/pull/14>
|
||||
|
||||
|
||||
* Enhancement - Support signing key: [#18](https://github.com/owncloud/ocis/ocs/pull/18)
|
||||
- Enhancement - Support signing key: [#18](https://github.com/owncloud/ocis/ocs/pull/18)
|
||||
|
||||
We added support for the `/v[12].php/cloud/user/signing-key` endpoint that is used by the
|
||||
owncloud-sdk to generate signed URLs. This allows directly downloading large files with
|
||||
browsers instead of using `blob://` urls, which eats memory ...
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/18
|
||||
https://github.com/owncloud/ocis-proxy/pull/75
|
||||
https://github.com/owncloud/owncloud-sdk/pull/504
|
||||
We added support for the `/v[12].php/cloud/user/signing-key` endpoint that is used by the
|
||||
owncloud-sdk to generate signed URLs. This allows directly downloading large files with
|
||||
browsers instead of using `blob://` urls, which eats memory ...
|
||||
|
||||
<https://github.com/owncloud/ocis/ocs/pull/18>
|
||||
<https://github.com/owncloud/ocis-proxy/pull/75>
|
||||
<https://github.com/owncloud/owncloud-sdk/pull/504>
|
||||
|
||||
+2
-2
@@ -2,7 +2,7 @@
|
||||
|
||||
[](https://cloud.drone.io/owncloud/ocis-ocs)
|
||||
[](https://gitter.im/cs3org/reva)
|
||||
[](https://www.codacy.com/app/owncloud/ocis-ocs?utm_source=github.com&utm_medium=referral&utm_content=owncloud/ocis-ocs&utm_campaign=Badge_Grade)
|
||||
[](https://www.codacy.com/app/owncloud/ocis-ocs?utm_source=github.com&utm_medium=referral&utm_content=owncloud/ocis-ocs&utm_campaign=Badge_Grade)
|
||||
[](http://godoc.org/github.com/owncloud/ocis-ocs)
|
||||
[](http://goreportcard.com/report/github.com/owncloud/ocis-ocs)
|
||||
[](http://microbadger.com/images/owncloud/ocis-ocs "Get your own image badge on microbadger.com")
|
||||
@@ -28,7 +28,7 @@ make generate build
|
||||
|
||||
## Security
|
||||
|
||||
If you find a security issue please contact security@owncloud.com first.
|
||||
If you find a security issue please contact [security@owncloud.com](mailto:security@owncloud.com) first.
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
@@ -2,4 +2,4 @@ Enhancement: Configuration
|
||||
|
||||
Extensions should be responsible of configuring themselves. We use Viper for config loading from default paths. Environment variables **WILL** take precedence over config files.
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/14
|
||||
<https://github.com/owncloud/ocis/ocs/pull/14>
|
||||
|
||||
@@ -4,4 +4,4 @@ Just prepared an initial basic version to serve OCS for the ownCloud
|
||||
Infinite Scale project. It just provides a minimal viable product to
|
||||
demonstrate the microservice pattern.
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/issues/1
|
||||
<https://github.com/owncloud/ocis/ocs/issues/1>
|
||||
|
||||
@@ -2,6 +2,6 @@ Enhancement: Support signing key
|
||||
|
||||
We added support for the `/v[12].php/cloud/user/signing-key` endpoint that is used by the owncloud-sdk to generate signed URLs. This allows directly downloading large files with browsers instead of using `blob://` urls, which eats memory ...
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/18
|
||||
https://github.com/owncloud/ocis-proxy/pull/75
|
||||
https://github.com/owncloud/owncloud-sdk/pull/504
|
||||
<https://github.com/owncloud/ocis/ocs/pull/18>
|
||||
<https://github.com/owncloud/ocis-proxy/pull/75>
|
||||
<https://github.com/owncloud/owncloud-sdk/pull/504>
|
||||
|
||||
@@ -2,4 +2,4 @@ Change: upgrade micro libraries
|
||||
|
||||
Updated the micro and ocis-pkg libraries to version 2.
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/issues/11
|
||||
<https://github.com/owncloud/ocis/ocs/issues/11>
|
||||
|
||||
@@ -2,4 +2,4 @@ Bugfix: build docker images with alpine:latest instead of alpine:edge
|
||||
|
||||
ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/20
|
||||
<https://github.com/owncloud/ocis/ocs/pull/20>
|
||||
|
||||
@@ -3,5 +3,5 @@ Bugfix: Fix file descriptor leak
|
||||
Only use a single instance of go-micro's GRPC client as it already
|
||||
does connection pooling. This prevents connection and file descriptor leaks.
|
||||
|
||||
https://github.com/owncloud/ocis/accounts/issues/79
|
||||
https://github.com/owncloud/ocis/ocs/pull/29
|
||||
<https://github.com/owncloud/ocis/accounts/issues/79>
|
||||
<https://github.com/owncloud/ocis/ocs/pull/29>
|
||||
|
||||
@@ -2,4 +2,4 @@ Enhancement: Add Group management for OCS Povisioning API
|
||||
|
||||
We added support for the group management related set of API calls of the provisioning API. [Reference](https://doc.owncloud.com/server/admin_manual/configuration/user/user_provisioning_api.html)
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/25
|
||||
<https://github.com/owncloud/ocis/ocs/pull/25>
|
||||
|
||||
@@ -2,4 +2,4 @@ Enhancement: Basic Support for the User Provisioning API
|
||||
|
||||
We added support for a basic set of API calls for the user provisioning API. [Reference](https://doc.owncloud.com/server/admin_manual/configuration/user/user_provisioning_api.html)
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/23
|
||||
<https://github.com/owncloud/ocis/ocs/pull/23>
|
||||
|
||||
@@ -2,4 +2,4 @@ Enhancement: Add option to create user with uidnumber and gidnumber
|
||||
|
||||
We have added an option to pass uidnumber and gidnumber to the ocis api while creating a new user
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/34
|
||||
<https://github.com/owncloud/ocis/ocs/pull/34>
|
||||
|
||||
@@ -2,4 +2,4 @@ Bugfix: Mimic oc10 user enabled as string in provisioning api
|
||||
|
||||
The oc10 user provisioning API uses a string for the boolean `enabled` flag. 😭
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/39
|
||||
<https://github.com/owncloud/ocis/ocs/pull/39>
|
||||
|
||||
@@ -3,6 +3,5 @@ Bugfix: Add the top level response structure to json responses
|
||||
Probably during moving the ocs code into the ocis-ocs repo the response format was changed.
|
||||
This change adds the top level response to json responses. Doing that the reponse should be compatible to the responses from OC10.
|
||||
|
||||
https://github.com/owncloud/product/issues/181
|
||||
https://github.com/owncloud/product/issues/181#issuecomment-683604168
|
||||
|
||||
<https://github.com/owncloud/product/issues/181>
|
||||
<https://github.com/owncloud/product/issues/181#issuecomment-683604168>
|
||||
|
||||
@@ -2,4 +2,4 @@ Enhancement: Update ocis-accounts
|
||||
|
||||
update ocis-accounts to v0.4.2-0.20200828150703-2ca83cf4ac20
|
||||
|
||||
https://github.com/owncloud/ocis/ocs/pull/42
|
||||
<https://github.com/owncloud/ocis/ocs/pull/42>
|
||||
|
||||
@@ -4,5 +4,5 @@ The user response contained the field `displayname` but for certain responses
|
||||
the field `display-name` is expected. The field `display-name` was added and
|
||||
now both fields are returned to the client.
|
||||
|
||||
https://github.com/owncloud/product/issues/181
|
||||
https://github.com/owncloud/ocis/ocs/pull/61
|
||||
<https://github.com/owncloud/product/issues/181>
|
||||
<https://github.com/owncloud/ocis/ocs/pull/61>
|
||||
|
||||
+5
-4
@@ -1,10 +1,11 @@
|
||||
---
|
||||
* * *
|
||||
|
||||
title: "Ocs"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-ocs
|
||||
geekdocRepo: <https://github.com/owncloud/ocis-ocs>
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
## geekdocFilePath: \_index.md
|
||||
|
||||
This service provides the OCS API which is required by some ownCloud clients.
|
||||
|
||||
+11
-10
@@ -1,28 +1,29 @@
|
||||
---
|
||||
* * *
|
||||
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-ocs
|
||||
geekdocRepo: <https://github.com/owncloud/ocis-ocs>
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: building.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
## geekdocFilePath: building.md
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
As this project is built with Go, so you need to install that first. The installation of Go is out of the scope of this document, please follow the official documentation for [Go](https://golang.org/doc/install), to build this project you have to install Go >= v1.12. After the installation of the required tools you need to get the sources:
|
||||
|
||||
{{< highlight txt >}}
|
||||
git clone https://github.com/owncloud/ocis-ocs.git
|
||||
{{< highlight txt >}}
|
||||
git clone <https://github.com/owncloud/ocis-ocs.git>
|
||||
cd ocis-ocs
|
||||
{{< / highlight >}}
|
||||
{{< / highlight >}}
|
||||
|
||||
All required tool besides Go itself and make are bundled or getting automatically installed within the `GOPATH`. All commands to build this project are part of our `Makefile`.
|
||||
|
||||
## Backend
|
||||
|
||||
{{< highlight txt >}}
|
||||
{{< highlight txt >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-ocs -h` to see all available options.
|
||||
|
||||
+12
-11
@@ -1,13 +1,14 @@
|
||||
---
|
||||
* * *
|
||||
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-ocs
|
||||
geekdocRepo: <https://github.com/owncloud/ocis-ocs>
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
## geekdocFilePath: getting-started.md
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -15,7 +16,7 @@ So far we are offering two different variants for the installation. You can choo
|
||||
|
||||
### Docker
|
||||
|
||||
Docker images for ocis-ocs are hosted on https://hub.docker.com/r/owncloud/ocis-ocs.
|
||||
Docker images for ocis-ocs are hosted on <https://hub.docker.com/r/owncloud/ocis-ocs>.
|
||||
|
||||
The `latest` tag always reflects the current master branch.
|
||||
|
||||
@@ -25,7 +26,7 @@ docker pull owncloud/ocis-ocs
|
||||
|
||||
### Binaries
|
||||
|
||||
The pre-built binaries for different platforms are downloadable at https://download.owncloud.com/ocis/ocs/ . Specific releases are organized in separate folders. They are in sync which every release tag on GitHub. The binaries from the current master branch can be found in https://download.owncloud.com/ocis/ocs/testing/
|
||||
The pre-built binaries for different platforms are downloadable at <https://download.owncloud.com/ocis/ocs/> . Specific releases are organized in separate folders. They are in sync which every release tag on GitHub. The binaries from the current master branch can be found in <https://download.owncloud.com/ocis/ocs/testing/>
|
||||
|
||||
```console
|
||||
curl https://download.owncloud.com/ocis/ocis-ocs/1.0.0-beta1/ocis-ocs-1.0.0-beta1-darwin-amd64 --output ocis-ocs
|
||||
@@ -41,17 +42,17 @@ The program provides a few sub-commands on execution. The available configuratio
|
||||
|
||||
The server command is used to start the http and debug server on two addresses within a single process. The http server is serving the general webservice while the debug server is used for health check, readiness check and to server the metrics mentioned below. For further help please execute:
|
||||
|
||||
{{< highlight txt >}}
|
||||
{{< highlight txt >}}
|
||||
ocis-ocs server --help
|
||||
{{< / highlight >}}
|
||||
{{< / highlight >}}
|
||||
|
||||
### Health
|
||||
|
||||
The health command is used to execute a health check, if the exit code equals zero the service should be up and running, if the exist code is greater than zero the service is not in a healthy state. Generally this command is used within our Docker containers, it could also be used within Kubernetes.
|
||||
|
||||
{{< highlight txt >}}
|
||||
{{< highlight txt >}}
|
||||
ocis-ocs health --help
|
||||
{{< / highlight >}}
|
||||
{{< / highlight >}}
|
||||
|
||||
## Metrics
|
||||
|
||||
|
||||
+5
-4
@@ -1,10 +1,11 @@
|
||||
---
|
||||
* * *
|
||||
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 40
|
||||
geekdocRepo: https://github.com/owncloud/ocis-ocs
|
||||
geekdocRepo: <https://github.com/owncloud/ocis-ocs>
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: license.md
|
||||
---
|
||||
|
||||
## geekdocFilePath: license.md
|
||||
|
||||
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/ocs/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
|
||||
|
||||
Reference in New Issue
Block a user