mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-03-08 23:09:02 -05:00
@@ -1,23 +1,21 @@
|
||||
* * *
|
||||
|
||||
---
|
||||
title: Accounts
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: <https://github.com/owncloud/ocis-accounts>
|
||||
geekdocRepo: https://github.com/owncloud/ocis-accounts
|
||||
geekdocEditPath: edit/master/docs
|
||||
|
||||
## geekdocFilePath: \_index.md
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
[](https://github.com/owncloud/ocis-hello/blob/master/LICENSE)
|
||||
|
||||
## Abstract
|
||||
|
||||
OCIS needs to be able to identify users. Whithout a non reassignable and persistend account ID share metadata cannot be reliably persisted. `ocis-accounts` allows exchanging oidc claims for a uuid. Using a uuid allows users to change the login, mail or even openid connect provider without breaking any persisted metadata that might have been attached to it.
|
||||
|
||||
- persists accounts
|
||||
- uses graph api properties
|
||||
\-ldap can be synced using the onpremise\* attributes
|
||||
- persists accounts
|
||||
- uses graph api properties
|
||||
-ldap can be synced using the onpremise* attributes
|
||||
|
||||
## Table of Contents
|
||||
|
||||
{{< toc-tree >}}
|
||||
{{< toc-tree >}}
|
||||
@@ -1,29 +1,28 @@
|
||||
* * *
|
||||
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: <https://github.com/owncloud/ocis-accounts>
|
||||
geekdocRepo: https://github.com/owncloud/ocis-accounts
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: building.md
|
||||
---
|
||||
|
||||
## geekdocFilePath: building.md
|
||||
|
||||
{{< toc >}}
|
||||
{{< 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.13. After the installation of the required tools you need to get the sources:
|
||||
|
||||
{{< highlight txt >}}
|
||||
git clone <https://github.com/owncloud/ocis-accounts.git>
|
||||
{{< highlight txt >}}
|
||||
git clone https://github.com/owncloud/ocis-accounts.git
|
||||
cd ocis-accounts
|
||||
{{< / 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-accounts -h` to see all available options and subcommands.
|
||||
|
||||
@@ -1,20 +1,19 @@
|
||||
* * *
|
||||
|
||||
---
|
||||
title: "Configuration"
|
||||
date: "2020-07-01T11:10:52+0200"
|
||||
weight: 20
|
||||
geekdocRepo: <https://github.com/owncloud/ocis-reva>
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: configuration.md
|
||||
---
|
||||
|
||||
## geekdocFilePath: configuration.md
|
||||
|
||||
{{< toc >}}
|
||||
{{< toc >}}
|
||||
|
||||
## Configuration
|
||||
|
||||
oCIS Single Binary is not responsible for configuring extensions. Instead, each extension could either be configured by environment variables, cli flags or config files.
|
||||
|
||||
Each extension has its dedicated documentation page (e.g. <https://owncloud.github.io/extensions/ocis_proxy/configuration>) which lists all possible configurations. Config files and environment variables are picked up if you use the `./bin/ocis server` command within the oCIS single binary. Command line flags must be set explicitly on the extensions subcommands.
|
||||
Each extension has its dedicated documentation page (e.g. https://owncloud.github.io/extensions/ocis_proxy/configuration) which lists all possible configurations. Config files and environment variables are picked up if you use the `./bin/ocis server` command within the oCIS single binary. Command line flags must be set explicitly on the extensions subcommands.
|
||||
|
||||
### Configuration using config files
|
||||
|
||||
@@ -26,7 +25,7 @@ $HOME/.ocis
|
||||
./config
|
||||
```
|
||||
|
||||
For this configuration to be picked up, have a look at your extension `root` command and look for which default config name it has assigned. _i.e: ocis-proxy reads `proxy.json | yaml | toml ...`_.
|
||||
For this configuration to be picked up, have a look at your extension `root` command and look for which default config name it has assigned. *i.e: ocis-proxy reads `proxy.json | yaml | toml ...`*.
|
||||
|
||||
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
|
||||
|
||||
@@ -44,28 +43,28 @@ Start ocis accounts service
|
||||
|
||||
Usage: `ocis-reva server [command options] [arguments...]`
|
||||
|
||||
\--http-namespace | $ACCOUNTS_HTTP_NAMESPACE
|
||||
--http-namespace | $ACCOUNTS_HTTP_NAMESPACE
|
||||
: Set the base namespace for the http namespace. Default: `com.owncloud.web`.
|
||||
|
||||
\--http-addr | $ACCOUNTS_HTTP_ADDR
|
||||
--http-addr | $ACCOUNTS_HTTP_ADDR
|
||||
: Address to bind http server. Default: `localhost:9181`.
|
||||
|
||||
\--http-root | $ACCOUNTS_HTTP_ROOT
|
||||
--http-root | $ACCOUNTS_HTTP_ROOT
|
||||
: Root path of http server. Default: `/`.
|
||||
|
||||
\--grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE
|
||||
--grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE
|
||||
: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
|
||||
|
||||
\--grpc-addr | $ACCOUNTS_GRPC_ADDR
|
||||
--grpc-addr | $ACCOUNTS_GRPC_ADDR
|
||||
: Address to bind grpc server. Default: `localhost:9180`.
|
||||
|
||||
\--name | $ACCOUNTS_NAME
|
||||
--name | $ACCOUNTS_NAME
|
||||
: service name. Default: `accounts`.
|
||||
|
||||
\--accounts-data-path | $ACCOUNTS_DATA_PATH
|
||||
--accounts-data-path | $ACCOUNTS_DATA_PATH
|
||||
: accounts folder. Default: `/var/tmp/ocis-accounts`.
|
||||
|
||||
\--asset-path | $HELLO_ASSET_PATH
|
||||
--asset-path | $HELLO_ASSET_PATH
|
||||
: Path to custom assets.
|
||||
|
||||
### ocis-reva ocis-accounts
|
||||
@@ -74,11 +73,12 @@ Provide accounts and groups for oCIS
|
||||
|
||||
Usage: `ocis-reva ocis-accounts [command options] [arguments...]`
|
||||
|
||||
\--log-level | $ACCOUNTS_LOG_LEVEL
|
||||
--log-level | $ACCOUNTS_LOG_LEVEL
|
||||
: Set logging level. Default: `info`.
|
||||
|
||||
\--log-pretty | $ACCOUNTS_LOG_PRETTY
|
||||
--log-pretty | $ACCOUNTS_LOG_PRETTY
|
||||
: Enable pretty logging. Default: `true`.
|
||||
|
||||
\--log-color | $ACCOUNTS_LOG_COLOR
|
||||
--log-color | $ACCOUNTS_LOG_COLOR
|
||||
: Enable colored logging. Default: `true`.
|
||||
|
||||
|
||||
@@ -1,14 +1,13 @@
|
||||
* * *
|
||||
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 20
|
||||
geekdocRepo: <https://github.com/owncloud/ocis-accounts>
|
||||
geekdocRepo: https://github.com/owncloud/ocis-accounts
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
## geekdocFilePath: getting-started.md
|
||||
|
||||
{{< toc >}}
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -57,6 +56,6 @@ The program provides a few sub-commands on execution. The available configuratio
|
||||
|
||||
The server command is used to start the grpc server. For further help please execute:
|
||||
|
||||
{{< highlight txt >}}
|
||||
{{< highlight txt >}}
|
||||
ocis-accounts server --help
|
||||
{{< / highlight >}}
|
||||
{{< / highlight >}}
|
||||
|
||||
Reference in New Issue
Block a user