mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-01-05 19:59:37 -06:00
adapt docs structure
This commit is contained in:
A.Unger
21
docs/extensions/accounts/_index.md
Normal file
21
docs/extensions/accounts/_index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Accounts
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-accounts
|
||||
geekdocEditPath: edit/master/docs
|
||||
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
|
||||
|
||||
## Table of Contents
|
||||
|
||||
{{< toc-tree >}}
|
||||
28
docs/extensions/accounts/building.md
Normal file
28
docs/extensions/accounts/building.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-accounts
|
||||
geekdocEditPath: edit/master/docs
|
||||
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.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
|
||||
cd ocis-accounts
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / 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.
|
||||
84
docs/extensions/accounts/configuration.md
Normal file
84
docs/extensions/accounts/configuration.md
Normal file
@@ -0,0 +1,84 @@
|
||||
---
|
||||
title: "Configuration"
|
||||
date: "2020-07-01T11:10:52+0200"
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: configuration.md
|
||||
---
|
||||
|
||||
{{< 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.
|
||||
|
||||
### Configuration using config files
|
||||
|
||||
Out of the box extensions will attempt to read configuration details from:
|
||||
|
||||
```console
|
||||
/etc/ocis
|
||||
$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 ...`*.
|
||||
|
||||
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`.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
|
||||
|
||||
### ocis-reva server
|
||||
|
||||
Start ocis accounts service
|
||||
|
||||
Usage: `ocis-reva server [command options] [arguments...]`
|
||||
|
||||
--http-namespace | $ACCOUNTS_HTTP_NAMESPACE
|
||||
: Set the base namespace for the http namespace. Default: `com.owncloud.web`.
|
||||
|
||||
--http-addr | $ACCOUNTS_HTTP_ADDR
|
||||
: Address to bind http server. Default: `localhost:9181`.
|
||||
|
||||
--http-root | $ACCOUNTS_HTTP_ROOT
|
||||
: Root path of http server. Default: `/`.
|
||||
|
||||
--grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE
|
||||
: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
|
||||
|
||||
--grpc-addr | $ACCOUNTS_GRPC_ADDR
|
||||
: Address to bind grpc server. Default: `localhost:9180`.
|
||||
|
||||
--name | $ACCOUNTS_NAME
|
||||
: service name. Default: `accounts`.
|
||||
|
||||
--accounts-data-path | $ACCOUNTS_DATA_PATH
|
||||
: accounts folder. Default: `/var/tmp/ocis-accounts`.
|
||||
|
||||
--asset-path | $HELLO_ASSET_PATH
|
||||
: Path to custom assets.
|
||||
|
||||
### ocis-reva ocis-accounts
|
||||
|
||||
Provide accounts and groups for oCIS
|
||||
|
||||
Usage: `ocis-reva ocis-accounts [command options] [arguments...]`
|
||||
|
||||
--log-level | $ACCOUNTS_LOG_LEVEL
|
||||
: Set logging level. Default: `info`.
|
||||
|
||||
--log-pretty | $ACCOUNTS_LOG_PRETTY
|
||||
: Enable pretty logging. Default: `true`.
|
||||
|
||||
--log-color | $ACCOUNTS_LOG_COLOR
|
||||
: Enable colored logging. Default: `true`.
|
||||
|
||||
61
docs/extensions/accounts/getting-started.md
Normal file
61
docs/extensions/accounts/getting-started.md
Normal file
@@ -0,0 +1,61 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis-accounts
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
TBD
|
||||
|
||||
### Binaries
|
||||
|
||||
TBD
|
||||
|
||||
## 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.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
#### Server
|
||||
|
||||
OCIS_ACCOUNTS_NAME
|
||||
: Name of the accounts service. It will be part of the namespace.
|
||||
|
||||
OCIS_ACCOUNTS_NAMESPACE
|
||||
: Namespace of the accounts service.
|
||||
|
||||
OCIS_ACCOUNTS_ADDRESS
|
||||
: Endpoint for the grpc service endpoint.
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below.
|
||||
|
||||
### Configuration file
|
||||
|
||||
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/accounts/tree/master/pkg/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/accounts.yml`, `${HOME}/.ocis/accounts.yml` or `$(pwd)/config/accounts.yml`.
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-accounts --help`.
|
||||
|
||||
### Server
|
||||
|
||||
The server command is used to start the grpc server. For further help please execute:
|
||||
|
||||
{{< highlight txt >}}
|
||||
ocis-accounts server --help
|
||||
{{< / highlight >}}
|
||||
14
docs/extensions/glauth/_index.md
Normal file
14
docs/extensions/glauth/_index.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: "GLAuth"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-glauth
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
This service provides a simple glauth world API which can be used by clients or other extensions.
|
||||
|
||||
- reiner proxy
|
||||
ldap für eos und firewall
|
||||
- backend ist der accounts service
|
||||
28
docs/extensions/glauth/building.md
Normal file
28
docs/extensions/glauth/building.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-glauth
|
||||
geekdocEditPath: edit/master/docs
|
||||
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.13. After the installation of the required tools you need to get the sources:
|
||||
|
||||
{{< highlight txt >}}
|
||||
git clone https://github.com/owncloud/ocis-glauth.git
|
||||
cd ocis-glauth
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-glauth -h` to see all available options.
|
||||
272
docs/extensions/glauth/getting-started.md
Normal file
272
docs/extensions/glauth/getting-started.md
Normal file
@@ -0,0 +1,272 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis-glauth
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
TBD
|
||||
|
||||
### Binaries
|
||||
|
||||
TBD
|
||||
|
||||
## 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.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
GLAUTH_CONFIG_FILE
|
||||
: Path to config file, empty default value
|
||||
|
||||
GLAUTH_LOG_LEVEL
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
GLAUTH_LOG_COLOR
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
GLAUTH_LOG_PRETTY
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
GLAUTH_TRACING_ENABLED
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
GLAUTH_TRACING_TYPE
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
GLAUTH_TRACING_ENDPOINT
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
GLAUTH_TRACING_COLLECTOR
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
GLAUTH_TRACING_SERVICE
|
||||
: Service name for tracing, defaults to `glauth`
|
||||
|
||||
GLAUTH_DEBUG_ADDR
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9124`
|
||||
|
||||
GLAUTH_DEBUG_TOKEN
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
GLAUTH_DEBUG_PPROF
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
GLAUTH_DEBUG_ZPAGES
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
GLAUTH_HTTP_ADDR
|
||||
: Address to bind http server, defaults to `0.0.0.0:9120`
|
||||
|
||||
GLAUTH_HTTP_NAMESPACE
|
||||
: The http namespace
|
||||
|
||||
GLAUTH_HTTP_ROOT
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
#### Health
|
||||
|
||||
GLAUTH_DEBUG_ADDR
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9124`
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
--config-file
|
||||
: Path to config file, empty default value
|
||||
|
||||
--log-level
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
--log-color
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
--log-pretty
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
--tracing-enabled
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
--tracing-type
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
--tracing-endpoint
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
--tracing-collector
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
--tracing-service
|
||||
: Service name for tracing, defaults to `glauth`
|
||||
|
||||
--debug-addr
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9124`
|
||||
|
||||
--debug-token
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
--debug-pprof
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
--debug-zpages
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
--http-addr
|
||||
: Address to bind http server, defaults to `0.0.0.0:9120`
|
||||
|
||||
--http-namespace
|
||||
: Namespace for internal services communication, defaults to `com.owncloud.web`
|
||||
|
||||
--http-root
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
#### Health
|
||||
|
||||
--debug-addr
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9124`
|
||||
|
||||
### Configuration file
|
||||
|
||||
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/glauth/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/glauth.yml`, `${HOME}/.ocis/glauth.yml` or `$(pwd)/config/glauth.yml`.
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-glauth --help`.
|
||||
|
||||
### Server
|
||||
|
||||
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 >}}
|
||||
ocis-glauth server --help
|
||||
{{< / 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 >}}
|
||||
ocis-glauth health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
## Metrics
|
||||
|
||||
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `GLAUTH_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9124/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
10
docs/extensions/glauth/license.md
Normal file
10
docs/extensions/glauth/license.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 40
|
||||
geekdocRepo: https://github.com/owncloud/ocis-glauth
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: license.md
|
||||
---
|
||||
|
||||
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/glauth/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
|
||||
1
docs/extensions/graph/.gitignore
vendored
Normal file
1
docs/extensions/graph/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
public/
|
||||
6
docs/extensions/graph/archetypes/default.md
Normal file
6
docs/extensions/graph/archetypes/default.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
anchor: "{{ replace .TranslationBaseName "-" " " | title | urlize }}"
|
||||
weight:
|
||||
---
|
||||
18
docs/extensions/graph/config.toml
Normal file
18
docs/extensions/graph/config.toml
Normal file
@@ -0,0 +1,18 @@
|
||||
baseURL = "https://owncloud.github.io/ocis-graph/"
|
||||
languageCode = "en-us"
|
||||
title = "ownCloud Infinite Scale: Graph"
|
||||
pygmentsUseClasses = true
|
||||
|
||||
disableKinds = ["taxonomy", "taxonomyTerm", "RSS", "sitemap"]
|
||||
|
||||
[blackfriday]
|
||||
angledQuotes = true
|
||||
fractions = false
|
||||
plainIDAnchors = true
|
||||
smartlists = true
|
||||
extensions = ["hardLineBreak"]
|
||||
|
||||
[params]
|
||||
author = "ownCloud GmbH"
|
||||
description = "Serve Graph API for oCIS"
|
||||
keywords = "reva, ocis"
|
||||
8
docs/extensions/graph/content/about.md
Normal file
8
docs/extensions/graph/content/about.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "About"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "about"
|
||||
weight: 10
|
||||
---
|
||||
|
||||
This service provides a simple graph world API which can be used by clients or other extensions.
|
||||
24
docs/extensions/graph/content/building.md
Normal file
24
docs/extensions/graph/content/building.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "building"
|
||||
weight: 30
|
||||
---
|
||||
|
||||
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-graph.git
|
||||
cd ocis-graph
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-graph -h` to see all available options.
|
||||
265
docs/extensions/graph/content/getting-started.md
Normal file
265
docs/extensions/graph/content/getting-started.md
Normal file
@@ -0,0 +1,265 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "getting-started"
|
||||
weight: 20
|
||||
---
|
||||
|
||||
### Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
#### Docker
|
||||
|
||||
TBD
|
||||
|
||||
#### Binaries
|
||||
|
||||
TBD
|
||||
|
||||
### 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.
|
||||
|
||||
#### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
##### Global
|
||||
|
||||
GRAPH_CONFIG_FILE
|
||||
: Path to config file, empty default value
|
||||
|
||||
GRAPH_LOG_LEVEL
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
GRAPH_LOG_COLOR
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
GRAPH_LOG_PRETTY
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
##### Server
|
||||
|
||||
GRAPH_TRACING_ENABLED
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
GRAPH_TRACING_TYPE
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
GRAPH_TRACING_ENDPOINT
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
GRAPH_TRACING_COLLECTOR
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
GRAPH_TRACING_SERVICE
|
||||
: Service name for tracing, defaults to `graph`
|
||||
|
||||
GRAPH_DEBUG_ADDR
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9124`
|
||||
|
||||
GRAPH_DEBUG_TOKEN
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
GRAPH_DEBUG_PPROF
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
GRAPH_DEBUG_ZPAGES
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
GRAPH_HTTP_ADDR
|
||||
: Address to bind http server, defaults to `0.0.0.0:9120`
|
||||
|
||||
GRAPH_HTTP_ROOT
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
##### Health
|
||||
|
||||
GRAPH_DEBUG_ADDR
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9124`
|
||||
|
||||
#### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below.
|
||||
|
||||
##### Global
|
||||
|
||||
--config-file
|
||||
: Path to config file, empty default value
|
||||
|
||||
--log-level
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
--log-color
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
--log-pretty
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
##### Server
|
||||
|
||||
--tracing-enabled
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
--tracing-type
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
--tracing-endpoint
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
--tracing-collector
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
--tracing-service
|
||||
: Service name for tracing, defaults to `graph`
|
||||
|
||||
--debug-addr
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9124`
|
||||
|
||||
--debug-token
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
--debug-pprof
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
--debug-zpages
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
--http-addr
|
||||
: Address to bind http server, defaults to `0.0.0.0:9120`
|
||||
|
||||
--http-namespace
|
||||
: Namespace for internal services communication, defaults to `com.owncloud.web`
|
||||
|
||||
--http-root
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
##### Health
|
||||
|
||||
--debug-addr
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9124`
|
||||
|
||||
#### Configuration file
|
||||
|
||||
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/graph/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/graph.yml`, `${HOME}/.ocis/graph.yml` or `$(pwd)/config/graph.yml`.
|
||||
|
||||
### Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-graph --help`.
|
||||
|
||||
#### Server
|
||||
|
||||
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 >}}
|
||||
ocis-graph server --help
|
||||
{{< / 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 >}}
|
||||
ocis-graph health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
### Metrics
|
||||
|
||||
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `GRAPH_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9124/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
8
docs/extensions/graph/content/license.md
Normal file
8
docs/extensions/graph/content/license.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "license"
|
||||
weight: 40
|
||||
---
|
||||
|
||||
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/graph/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
|
||||
0
docs/extensions/graph/layouts/_default/list.html
Normal file
0
docs/extensions/graph/layouts/_default/list.html
Normal file
0
docs/extensions/graph/layouts/_default/single.html
Normal file
0
docs/extensions/graph/layouts/_default/single.html
Normal file
57
docs/extensions/graph/layouts/index.html
Normal file
57
docs/extensions/graph/layouts/index.html
Normal file
@@ -0,0 +1,57 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html id="html" lang="{{ with .Site.LanguageCode }}{{ . }}{{ else }}en-US{{ end }}">
|
||||
<head>
|
||||
<meta http-equiv="content-type" content="text/html;charset=utf-8">
|
||||
<meta name="viewport" content="width=device-width"/>
|
||||
|
||||
<title>
|
||||
{{ .Site.Title }}
|
||||
</title>
|
||||
|
||||
<meta name="description" content="{{ with .Site.Params.description }}{{ . }}{{ end }}">
|
||||
<meta name="author" content="{{ with .Site.Params.author }}{{ . }}{{ end }}">
|
||||
|
||||
{{ partial "style.html" . }}
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<section id="Menu">
|
||||
<header>
|
||||
<h1>
|
||||
{{ .Site.Title }}
|
||||
</h1>
|
||||
|
||||
<p>
|
||||
{{ .Site.Params.description }}
|
||||
</p>
|
||||
</header>
|
||||
|
||||
<nav>
|
||||
{{ range .Data.Pages.ByWeight }}
|
||||
<a href="#{{ .Params.anchor }}">
|
||||
{{ .Title }}
|
||||
</a>
|
||||
{{ end }}
|
||||
</nav>
|
||||
</section>
|
||||
|
||||
{{ range .Data.Pages.ByWeight }}
|
||||
<section id="{{ .Params.anchor }}">
|
||||
<h2>
|
||||
<a href="#{{ .Params.anchor }}">
|
||||
{{ .Title }}
|
||||
</a>
|
||||
|
||||
<small>
|
||||
<a href="#html">
|
||||
Back to Top
|
||||
</a>
|
||||
</small>
|
||||
</h2>
|
||||
|
||||
{{ .Content | markdownify }}
|
||||
</section>
|
||||
{{ end }}
|
||||
</body>
|
||||
</html>
|
||||
2
docs/extensions/graph/layouts/partials/style.html
Normal file
2
docs/extensions/graph/layouts/partials/style.html
Normal file
@@ -0,0 +1,2 @@
|
||||
<link rel="stylesheet" href="syntax.css" />
|
||||
<link rel="stylesheet" href="styles.css" />
|
||||
338
docs/extensions/graph/static/styles.css
Normal file
338
docs/extensions/graph/static/styles.css
Normal file
@@ -0,0 +1,338 @@
|
||||
body,
|
||||
html {
|
||||
cursor: default;
|
||||
}
|
||||
|
||||
body,
|
||||
div,
|
||||
dl,
|
||||
dt,
|
||||
dd,
|
||||
ul,
|
||||
ol,
|
||||
li,
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6,
|
||||
pre,
|
||||
form,
|
||||
fieldset,
|
||||
input,
|
||||
textarea,
|
||||
p,
|
||||
blockquote,
|
||||
th,
|
||||
td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
* {
|
||||
-webkit-box-sizing: border-box;
|
||||
-moz-box-sizing: border-box;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
:before,
|
||||
:after {
|
||||
-webkit-box-sizing: border-box;
|
||||
-moz-box-sizing: border-box;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
img,
|
||||
object,
|
||||
embed {
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
object,
|
||||
embed {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
img {
|
||||
margin: 1.25% 0;
|
||||
-ms-interpolation-mode: bicubic;
|
||||
}
|
||||
|
||||
html {
|
||||
background-color: #F0F1F3;
|
||||
padding: 2%;
|
||||
}
|
||||
|
||||
body {
|
||||
font-size: 16px;
|
||||
line-height: 1.6;
|
||||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
|
||||
color: #242424;
|
||||
max-width: 800px;
|
||||
margin: 5% auto;
|
||||
}
|
||||
|
||||
body::after {
|
||||
clear: both;
|
||||
content: "";
|
||||
display: table;
|
||||
}
|
||||
|
||||
header {
|
||||
margin-bottom: 8%;
|
||||
}
|
||||
|
||||
footer {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h2 a {
|
||||
color: #263A48;
|
||||
font-weight: 500;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2 {
|
||||
font-size: 36px;
|
||||
padding-bottom: 0.3em;
|
||||
margin-bottom: 0.4em;
|
||||
border-bottom: 1px solid #eee
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 22px;
|
||||
padding-bottom: 0.6em;
|
||||
margin-bottom: 0.6em;
|
||||
margin-top: 2.5em;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 18px;
|
||||
margin-bottom: 0.3em;
|
||||
}
|
||||
|
||||
h2 small a {
|
||||
color: #98999C;
|
||||
font-size: 15px;
|
||||
font-weight: normal;
|
||||
float: right;
|
||||
position: absolute;
|
||||
top: 15px;
|
||||
right: 20px;
|
||||
}
|
||||
|
||||
section {
|
||||
background: #fff;
|
||||
margin-bottom: 1%;
|
||||
position: relative;
|
||||
padding: 6% 8%;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
border-left: 3px solid #d54e21;
|
||||
font-size: 16px;
|
||||
padding: 0 0 0 20px;
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
blockquote a {
|
||||
color: #d54e21;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
blockquote code {
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
.highlight pre {
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
.highlight {
|
||||
margin-bottom: 4%;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #1e8cbe;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
ol {
|
||||
list-style: number;
|
||||
}
|
||||
|
||||
ol li {
|
||||
color: #98999C;
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
ol li:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p,
|
||||
ul,
|
||||
ol,
|
||||
blockquote {
|
||||
margin-bottom: 4%;
|
||||
}
|
||||
|
||||
ul ul {
|
||||
padding-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 4%;
|
||||
}
|
||||
|
||||
ul ul li:before {
|
||||
content: '-';
|
||||
display: inline-block;
|
||||
padding-right: 2%;
|
||||
}
|
||||
|
||||
ul.col-2 {
|
||||
color: #98999C;
|
||||
-webkit-column-count: 2;
|
||||
-moz-column-count: 2;
|
||||
column-count: 2;
|
||||
-webkit-column-gap: 20px;
|
||||
-moz-column-gap: 20px;
|
||||
column-gap: 20px;
|
||||
}
|
||||
|
||||
dl dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
dl dd {
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
@media screen and (min-width: 500px) {
|
||||
ul.col-2 {
|
||||
-webkit-column-count: 3;
|
||||
-moz-column-count: 3;
|
||||
column-count: 3;
|
||||
-webkit-column-gap: 20px;
|
||||
-moz-column-gap: 20px;
|
||||
column-gap: 20px;
|
||||
}
|
||||
}
|
||||
|
||||
nav {
|
||||
background: #F0F1F3;
|
||||
min-width: 215px;
|
||||
margin-bottom: 5px;
|
||||
margin-top: 15px;
|
||||
}
|
||||
|
||||
nav:first-of-type a {
|
||||
color: #d54e21;
|
||||
border-radius: 0;
|
||||
}
|
||||
|
||||
nav:first-of-type a:hover {
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
nav:first-of-type a:before {
|
||||
background-color: #d54e21;
|
||||
}
|
||||
|
||||
nav.affix {
|
||||
position: fixed;
|
||||
top: 20px;
|
||||
}
|
||||
|
||||
nav.affix-bottom {
|
||||
position: absolute;
|
||||
}
|
||||
|
||||
nav a {
|
||||
border-radius: 3px;
|
||||
font-size: 15px;
|
||||
display: block;
|
||||
cursor: pointer;
|
||||
font-weight: 500;
|
||||
position: relative;
|
||||
text-decoration: none;
|
||||
padding: 10px 12px;
|
||||
width: 100%;
|
||||
padding-right: 3px;
|
||||
border-bottom: 2px solid #fff;
|
||||
}
|
||||
|
||||
nav a:before {
|
||||
content: '';
|
||||
width: 4px;
|
||||
display: block;
|
||||
left: 0;
|
||||
position: absolute;
|
||||
height: 100%;
|
||||
display: none;
|
||||
background: #1e8cbe;
|
||||
top: 0;
|
||||
}
|
||||
|
||||
nav a:hover {
|
||||
background-color: #E6E8EA;
|
||||
color: #1e8cbe;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
nav a:hover:before {
|
||||
display: block;
|
||||
}
|
||||
|
||||
nav a:last-of-type {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
.gist {
|
||||
margin-top: 5.1%;
|
||||
margin-bottom: 5%;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 1050px) {
|
||||
body {
|
||||
margin: 0 auto;
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: 767px) {
|
||||
header span {
|
||||
display: none;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 26px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 20px;
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: 514px) {
|
||||
p,
|
||||
ul,
|
||||
ol,
|
||||
blockquote {
|
||||
margin-bottom: 8%;
|
||||
}
|
||||
}
|
||||
59
docs/extensions/graph/static/syntax.css
Normal file
59
docs/extensions/graph/static/syntax.css
Normal file
@@ -0,0 +1,59 @@
|
||||
/* Background */ .chroma { color: #f8f8f2; background-color: #272822 }
|
||||
/* Error */ .chroma .err { color: #960050; background-color: #1e0010 }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; }
|
||||
/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc }
|
||||
/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em; }
|
||||
/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em; }
|
||||
/* Keyword */ .chroma .k { color: #66d9ef }
|
||||
/* KeywordConstant */ .chroma .kc { color: #66d9ef }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #66d9ef }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #f92672 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #66d9ef }
|
||||
/* KeywordReserved */ .chroma .kr { color: #66d9ef }
|
||||
/* KeywordType */ .chroma .kt { color: #66d9ef }
|
||||
/* NameAttribute */ .chroma .na { color: #a6e22e }
|
||||
/* NameClass */ .chroma .nc { color: #a6e22e }
|
||||
/* NameConstant */ .chroma .no { color: #66d9ef }
|
||||
/* NameDecorator */ .chroma .nd { color: #a6e22e }
|
||||
/* NameException */ .chroma .ne { color: #a6e22e }
|
||||
/* NameFunction */ .chroma .nf { color: #a6e22e }
|
||||
/* NameOther */ .chroma .nx { color: #a6e22e }
|
||||
/* NameTag */ .chroma .nt { color: #f92672 }
|
||||
/* Literal */ .chroma .l { color: #ae81ff }
|
||||
/* LiteralDate */ .chroma .ld { color: #e6db74 }
|
||||
/* LiteralString */ .chroma .s { color: #e6db74 }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #e6db74 }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #e6db74 }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #e6db74 }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #e6db74 }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #e6db74 }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #e6db74 }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #ae81ff }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #e6db74 }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #e6db74 }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #e6db74 }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #e6db74 }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #e6db74 }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #e6db74 }
|
||||
/* LiteralNumber */ .chroma .m { color: #ae81ff }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ae81ff }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ae81ff }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ae81ff }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ae81ff }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ae81ff }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ae81ff }
|
||||
/* Operator */ .chroma .o { color: #f92672 }
|
||||
/* OperatorWord */ .chroma .ow { color: #f92672 }
|
||||
/* Comment */ .chroma .c { color: #75715e }
|
||||
/* CommentHashbang */ .chroma .ch { color: #75715e }
|
||||
/* CommentMultiline */ .chroma .cm { color: #75715e }
|
||||
/* CommentSingle */ .chroma .c1 { color: #75715e }
|
||||
/* CommentSpecial */ .chroma .cs { color: #75715e }
|
||||
/* CommentPreproc */ .chroma .cp { color: #75715e }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #75715e }
|
||||
/* GenericDeleted */ .chroma .gd { color: #f92672 }
|
||||
/* GenericEmph */ .chroma .ge { font-style: italic }
|
||||
/* GenericInserted */ .chroma .gi { color: #a6e22e }
|
||||
/* GenericStrong */ .chroma .gs { font-weight: bold }
|
||||
/* GenericSubheading */ .chroma .gu { color: #75715e }
|
||||
8
docs/extensions/konnectd/_index.md
Normal file
8
docs/extensions/konnectd/_index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Konnectd
|
||||
geekdocRepo: https://github.com/owncloud/ocis-konnectd
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
This service provides an OpenID Connect provider which is the default way to authenticate in OCIS.
|
||||
28
docs/extensions/konnectd/building.md
Normal file
28
docs/extensions/konnectd/building.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2020-02-21T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-konnectd
|
||||
geekdocEditPath: edit/master/docs
|
||||
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.13. After the installation of the required tools you need to get the sources:
|
||||
|
||||
{{< highlight txt >}}
|
||||
git clone https://github.com/owncloud/ocis-konnectd.git
|
||||
cd ocis-konnectd
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-konnectd -h` to see all available options and subcommands.
|
||||
176
docs/extensions/konnectd/configuration.md
Normal file
176
docs/extensions/konnectd/configuration.md
Normal file
@@ -0,0 +1,176 @@
|
||||
---
|
||||
title: "Configuration"
|
||||
date: "2020-09-21T13:14:47+0200"
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis-konnectd
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: configuration.md
|
||||
---
|
||||
|
||||
{{< 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.
|
||||
|
||||
### Configuration using config files
|
||||
|
||||
Out of the box extensions will attempt to read configuration details from:
|
||||
|
||||
```console
|
||||
/etc/ocis
|
||||
$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 ...`*.
|
||||
|
||||
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`.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
|
||||
|
||||
## Root Command
|
||||
|
||||
Serve Konnectd API for oCIS
|
||||
|
||||
Usage: `ocis-konnectd [global options] command [command options] [arguments...]`
|
||||
|
||||
--config-file | $KONNECTD_CONFIG_FILE
|
||||
: Path to config file.
|
||||
|
||||
--log-level | $KONNECTD_LOG_LEVEL
|
||||
: Set logging level. Default: `info`.
|
||||
|
||||
--log-pretty | $KONNECTD_LOG_PRETTY
|
||||
: Enable pretty logging. Default: `true`.
|
||||
|
||||
--log-color | $KONNECTD_LOG_COLOR
|
||||
: Enable colored logging. Default: `true`.
|
||||
|
||||
## Sub Commands
|
||||
|
||||
### ocis-konnectd health
|
||||
|
||||
Check health status
|
||||
|
||||
Usage: `ocis-konnectd health [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $KONNECTD_DEBUG_ADDR
|
||||
: Address to debug endpoint. Default: `0.0.0.0:9134`.
|
||||
|
||||
### ocis-konnectd server
|
||||
|
||||
Start integrated server
|
||||
|
||||
Usage: `ocis-konnectd server [command options] [arguments...]`
|
||||
|
||||
--tracing-enabled | $KONNECTD_TRACING_ENABLED
|
||||
: Enable sending traces.
|
||||
|
||||
--tracing-type | $KONNECTD_TRACING_TYPE
|
||||
: Tracing backend type. Default: `jaeger`.
|
||||
|
||||
--tracing-endpoint | $KONNECTD_TRACING_ENDPOINT
|
||||
: Endpoint for the agent.
|
||||
|
||||
--tracing-collector | $KONNECTD_TRACING_COLLECTOR
|
||||
: Endpoint for the collector.
|
||||
|
||||
--tracing-service | $KONNECTD_TRACING_SERVICE
|
||||
: Service name for tracing. Default: `konnectd`.
|
||||
|
||||
--debug-addr | $KONNECTD_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9134`.
|
||||
|
||||
--debug-token | $KONNECTD_DEBUG_TOKEN
|
||||
: Token to grant metrics access.
|
||||
|
||||
--debug-pprof | $KONNECTD_DEBUG_PPROF
|
||||
: Enable pprof debugging.
|
||||
|
||||
--debug-zpages | $KONNECTD_DEBUG_ZPAGES
|
||||
: Enable zpages debugging.
|
||||
|
||||
--http-addr | $KONNECTD_HTTP_ADDR
|
||||
: Address to bind http server. Default: `0.0.0.0:9130`.
|
||||
|
||||
--http-root | $KONNECTD_HTTP_ROOT
|
||||
: Root path of http server. Default: `/`.
|
||||
|
||||
--http-namespace | $KONNECTD_HTTP_NAMESPACE
|
||||
: Set the base namespace for service discovery. Default: `com.owncloud.web`.
|
||||
|
||||
--identity-manager | $KONNECTD_IDENTITY_MANAGER
|
||||
: Identity manager (one of ldap,kc,cookie,dummy). Default: `ldap`.
|
||||
|
||||
--transport-tls-cert | $KONNECTD_TRANSPORT_TLS_CERT
|
||||
: Certificate file for transport encryption.
|
||||
|
||||
--transport-tls-key | $KONNECTD_TRANSPORT_TLS_KEY
|
||||
: Secret file for transport encryption.
|
||||
|
||||
--iss | $KONNECTD_ISS
|
||||
: OIDC issuer URL. Default: `https://localhost:9200`.
|
||||
|
||||
--signing-kid | $KONNECTD_SIGNING_KID
|
||||
: Value of kid field to use in created tokens (uniquely identifying the signing-private-key).
|
||||
|
||||
--validation-keys-path | $KONNECTD_VALIDATION_KEYS_PATH
|
||||
: Full path to a folder containg PEM encoded private or public key files used for token validaton (file name without extension is used as kid).
|
||||
|
||||
--encryption-secret | $KONNECTD_ENCRYPTION_SECRET
|
||||
: Full path to a file containing a %d bytes secret key.
|
||||
|
||||
--signing-method | $KONNECTD_SIGNING_METHOD
|
||||
: JWT default signing method. Default: `PS256`.
|
||||
|
||||
--uri-base-path | $KONNECTD_URI_BASE_PATH
|
||||
: Custom base path for URI endpoints.
|
||||
|
||||
--sign-in-uri | $KONNECTD_SIGN_IN_URI
|
||||
: Custom redirection URI to sign-in form.
|
||||
|
||||
--signed-out-uri | $KONNECTD_SIGN_OUT_URI
|
||||
: Custom redirection URI to signed-out goodbye page.
|
||||
|
||||
--authorization-endpoint-uri | $KONNECTD_ENDPOINT_URI
|
||||
: Custom authorization endpoint URI.
|
||||
|
||||
--endsession-endpoint-uri | $KONNECTD_ENDSESSION_ENDPOINT_URI
|
||||
: Custom endsession endpoint URI.
|
||||
|
||||
--asset-path | $KONNECTD_ASSET_PATH
|
||||
: Path to custom assets.
|
||||
|
||||
--identifier-client-path | $KONNECTD_IDENTIFIER_CLIENT_PATH
|
||||
: Path to the identifier web client base folder. Default: `/var/tmp/konnectd`.
|
||||
|
||||
--identifier-registration-conf | $KONNECTD_IDENTIFIER_REGISTRATION_CONF
|
||||
: Path to a identifier-registration.yaml configuration file. Default: `./config/identifier-registration.yaml`.
|
||||
|
||||
--identifier-scopes-conf | $KONNECTD_IDENTIFIER_SCOPES_CONF
|
||||
: Path to a scopes.yaml configuration file.
|
||||
|
||||
--insecure | $KONNECTD_INSECURE
|
||||
: Disable TLS certificate and hostname validation.
|
||||
|
||||
--tls | $KONNECTD_TLS
|
||||
: Use TLS (disable only if konnectd is behind a TLS-terminating reverse-proxy).. Default: `false`.
|
||||
|
||||
--allow-client-guests | $KONNECTD_ALLOW_CLIENT_GUESTS
|
||||
: Allow sign in of client controlled guest users.
|
||||
|
||||
--allow-dynamic-client-registration | $KONNECTD_ALLOW_DYNAMIC_CLIENT_REGISTRATION
|
||||
: Allow dynamic OAuth2 client registration.
|
||||
|
||||
--disable-identifier-webapp | $KONNECTD_DISABLE_IDENTIFIER_WEBAPP
|
||||
: Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`.
|
||||
|
||||
154
docs/extensions/konnectd/getting-started.md
Normal file
154
docs/extensions/konnectd/getting-started.md
Normal file
@@ -0,0 +1,154 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-konnectd
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
Docker images for ocis-reva are hosted on https://hub.docker.com/r/owncloud/ocis-konnectd.
|
||||
|
||||
The `latest` tag always reflects the current master branch.
|
||||
|
||||
```console
|
||||
docker pull owncloud/ocis-konnectd
|
||||
```
|
||||
|
||||
### Binaries
|
||||
|
||||
The pre-built binaries for different platforms are downloadable at https://download.owncloud.com/ocis/ocis-konnectd/ . 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/ocis-konnectd/testing/
|
||||
|
||||
```console
|
||||
curl https://download.owncloud.com/ocis/ocis-konnectd/1.0.0-beta1/ocis-konnectd-1.0.0-beta1-darwin-amd64 --output ocis-konnectd
|
||||
chmod +x ocis-konnectd
|
||||
./ocis-konnectd server
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-konnectd --help`.
|
||||
|
||||
### Server
|
||||
|
||||
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 >}}
|
||||
ocis-konnectd server --help
|
||||
{{< / 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 >}}
|
||||
ocis-konnectd health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
## Metrics
|
||||
|
||||
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `KONNECTD_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9134/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
10
docs/extensions/ocis-phoenix/_index.md
Normal file
10
docs/extensions/ocis-phoenix/_index.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Phoenix"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-phoenix
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
This service embeds [Phoenix](https://github.com/owncloud/phoenix) to provide a UI for ownCloud Infinite Scale.
|
||||
26
docs/extensions/ocis-phoenix/building.md
Normal file
26
docs/extensions/ocis-phoenix/building.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-phoenix
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: building.md
|
||||
---
|
||||
|
||||
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-phoenix.git
|
||||
cd ocis-phoenix
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
The above commands will download a [Phoenix](https://github.com/owncloud/phoenix) release and embed it into the binary. Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-phoenix -h` to see all available options.
|
||||
339
docs/extensions/ocis-phoenix/getting-started.md
Normal file
339
docs/extensions/ocis-phoenix/getting-started.md
Normal file
@@ -0,0 +1,339 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis-phoenix
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
TBD
|
||||
|
||||
### Binaries
|
||||
|
||||
TBD
|
||||
|
||||
## 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.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
PHOENIX_CONFIG_FILE
|
||||
: Path to config file, empty default value
|
||||
|
||||
PHOENIX_LOG_LEVEL
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
PHOENIX_LOG_COLOR
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
PHOENIX_LOG_PRETTY
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
PHOENIX_TRACING_ENABLED
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
PHOENIX_TRACING_TYPE
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
PHOENIX_TRACING_ENDPOINT
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
PHOENIX_TRACING_COLLECTOR
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
PHOENIX_TRACING_SERVICE
|
||||
: Service name for tracing, defaults to `phoenix`
|
||||
|
||||
PHOENIX_DEBUG_ADDR
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9104`
|
||||
|
||||
PHOENIX_DEBUG_TOKEN
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
PHOENIX_DEBUG_PPROF
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
PHOENIX_DEBUG_ZPAGES
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
PHOENIX_HTTP_ADDR
|
||||
: Address to bind http server, defaults to `0.0.0.0:9100`
|
||||
|
||||
PHOENIX_HTTP_ROOT
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
PHOENIX_ASSET_PATH
|
||||
: Path to custom assets, empty default value
|
||||
|
||||
PHOENIX_WEB_CONFIG
|
||||
: Path to phoenix config, empty default value
|
||||
|
||||
PHOENIX_WEB_CONFIG_SERVER
|
||||
: Server URL, defaults to `http://localhost:9135`
|
||||
|
||||
PHOENIX_WEB_CONFIG_THEME
|
||||
: Theme, defaults to `owncloud`
|
||||
|
||||
PHOENIX_WEB_CONFIG_VERSION
|
||||
: Version, defaults to `0.1.0`
|
||||
|
||||
PHOENIX_APPS
|
||||
: Use multiple times to provide multiple apps
|
||||
|
||||
PHOENIX_EXTERNAL_APPS
|
||||
: Not supported yet, specify a config.json file via `PHOENIX_WEB_CONFIG`
|
||||
|
||||
PHOENIX_OIDC_METADATA_URL
|
||||
: OpenID Connect metadata URL, defaults to `http://localhost:9130/.well-known/openid-configuration`
|
||||
|
||||
PHOENIX_OIDC_AUTHORITY
|
||||
: OpenID Connect authority, defaults to `http://localhost:9130`
|
||||
|
||||
PHOENIX_OIDC_CLIENT_ID
|
||||
: OpenID Connect client ID, defaults to `phoenix`
|
||||
|
||||
PHOENIX_OIDC_RESPONSE_TYPE
|
||||
: OpenID Connect response type, defaults to `code`
|
||||
|
||||
PHOENIX_OIDC_SCOPE
|
||||
: OpenID Connect scope, defaults to `openid profile email`
|
||||
|
||||
In case you want to render any additional properties in the config.json you can provide a custom config.json using eg. `PHOENIX_WEB_CONFIG=/path/to/config.json ocis-phoenix server`
|
||||
|
||||
#### Health
|
||||
|
||||
PHOENIX_DEBUG_ADDR
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9104`
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
--config-file
|
||||
: Path to config file, empty default value
|
||||
|
||||
--log-level
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
--log-color
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
--log-pretty
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
--tracing-enabled
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
--tracing-type
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
--tracing-endpoint
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
--tracing-collector
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
--tracing-service
|
||||
: Service name for tracing, defaults to `phoenix`
|
||||
|
||||
--debug-addr
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9104`
|
||||
|
||||
--debug-token
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
--debug-pprof
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
--debug-zpages
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
--http-addr
|
||||
: Address to bind http server, defaults to `0.0.0.0:9100`
|
||||
|
||||
--http-root
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
--asset-path
|
||||
: Path to custom assets, empty default value
|
||||
|
||||
--web-config
|
||||
: Path to phoenix config, empty default value
|
||||
|
||||
--web-config-server
|
||||
: Server URL, defaults to `http://localhost:9135`
|
||||
|
||||
--web-config-theme
|
||||
: Theme, defaults to `owncloud`
|
||||
|
||||
--web-config-version
|
||||
: Version, defaults to `0.1.0`
|
||||
|
||||
--web-config-app
|
||||
: Provide multiple apps, defaults to `""`. Usage: `phoenix --web-config-app files --web-config-app pdf-viewer`
|
||||
|
||||
--oidc-metadata-url
|
||||
: OpenID Connect metadata URL, defaults to `http://localhost:9130/.well-known/openid-configuration`
|
||||
|
||||
--oidc-authority
|
||||
: OpenID Connect authority, defaults to `http://localhost:9130`
|
||||
|
||||
--oidc-client-id
|
||||
: OpenID Connect client ID, defaults to `phoenix`
|
||||
|
||||
--oidc-response-type
|
||||
: OpenID Connect response type, defaults to `code`
|
||||
|
||||
--oidc-scope
|
||||
: OpenID Connect scope, defaults to `openid profile email`
|
||||
|
||||
In case you want to render any additional properties in the config.json you can provide a custom config.json using eg. `ocis-phoenix server --web-config=/path/to/config.json`
|
||||
|
||||
#### Health
|
||||
|
||||
--debug-addr
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9104`
|
||||
|
||||
### Configuration file
|
||||
|
||||
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/ocis-phoenix/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/phoenix.yml`, `${HOME}/.ocis/phoenix.yml` or `$(pwd)/config/phoenix.yml`.
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-phoenix --help`.
|
||||
|
||||
### Server
|
||||
|
||||
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 >}}
|
||||
ocis-phoenix server --help
|
||||
{{< / 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 >}}
|
||||
ocis-phoenix health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
## Metrics
|
||||
|
||||
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `PHOENIX_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9104/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
10
docs/extensions/ocis-phoenix/license.md
Normal file
10
docs/extensions/ocis-phoenix/license.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/owncloud/ocis-phoenix
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: license.md
|
||||
---
|
||||
|
||||
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/ocis-phoenix/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
|
||||
47
docs/extensions/ocis-phoenix/releasing.md
Normal file
47
docs/extensions/ocis-phoenix/releasing.md
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: "Releasing"
|
||||
weight: 40
|
||||
geekdocRepo: https://github.com/owncloud/ocis-phoenix
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: releasing.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Releasing
|
||||
|
||||
The next generation Web Frontend is shipped as an ocis Extension. The `ocis-phoenix` extension is also embedded in the single binary and part of the `ocis server` command.
|
||||
|
||||
To update this package within all the deliveries, we need to update the package in the following chain from the bottom to the top.
|
||||
|
||||
### Package Hierarchy
|
||||
|
||||
- [ocis](https://githug.com/owncloud/ocis)
|
||||
- [ocis-phoenix](https://github.com/owncloud/ocis-phoenix)
|
||||
- [ocis-pkg](https://github.com/owncloud/ocis-pkg)
|
||||
- [phoenix](https://github.com/owncloud/phoenix)
|
||||
|
||||
#### Prerequisites
|
||||
|
||||
Before updating the assets, make sure that [Phoenix](https://github.com/owncloud/phoenix) has been released first
|
||||
and take note of its release tag name.
|
||||
|
||||
#### Updating ocis-phoenix
|
||||
|
||||
1. Create a branch `release-$version`. in <https://github.com/owncloud/ocis-phoenix>
|
||||
2. Create a Folder in `changelog` for the release version and date `mkdir $major.$minor.$patchVersion_YYYY-MM-DD`.
|
||||
3. Move all changelog items from the `changelog/unreleased/` folder to the `$major.$minor.$patchVersion_YYYY-MM-DD` folder.
|
||||
4. Update the go module `ocis-pkg` to the latest version <https://blog.golang.org/using-go-modules> .
|
||||
5. Update the phoenix asset by adjusting the value of `PHOENIX_ASSETS_VERSION` at the top of the Makefile and specify the tag name of the latest [Phoenix release](https://github.com/owncloud/phoenix/tags).
|
||||
6. Run `make clean generate`.
|
||||
7. Create a changelog item for the update in the `changelog/$major.$minor.$patchVersion_YYYY-MM-DD` folder.
|
||||
8. Commit your changes.
|
||||
9. After merging, wait for the CI to run on the merge commit.
|
||||
10. Go to "Releases" in GH click "Draft a new Release".
|
||||
11. Use `v$major.$minor.$patch` as a tag (the `v` prefix is important) and publish it.
|
||||
12. The tag and the Release artifacts will be created automatically.
|
||||
|
||||
#### Next steps
|
||||
|
||||
Next steps is usually updating the ocis-phoenix version in the [ocis](https://githug.com/owncloud/ocis) repository.
|
||||
|
||||
45
docs/extensions/ocis-reva/_index.md
Normal file
45
docs/extensions/ocis-reva/_index.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: "Reva"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
This service provides an ocis extension that wraps [reva](https://github.com/cs3org/reva/) and adds an opinionated configuration to it.
|
||||
|
||||
It uses the port range 9140-9179 to preconfigure several services.
|
||||
|
||||
| port | service |
|
||||
+------+---------+
|
||||
| 9109 | health? |
|
||||
| 9140 | frontend |
|
||||
| 9141 | frontend debug |
|
||||
| 9142 | gateway |
|
||||
| 9143 | gateway debug |
|
||||
| 9144 | users |
|
||||
| 9145 | users debug |
|
||||
| 9146 | authbasic |
|
||||
| 9147 | authbasic debug |
|
||||
| 9148 | authbearer |
|
||||
| 9149 | authbearer debug |
|
||||
| 9150 | sharing |
|
||||
| 9151 | sharing debug |
|
||||
| 9152 | storage root |
|
||||
| 9153 | storage root debug |
|
||||
| 9154 | storage home |
|
||||
| 9155 | storage home debug |
|
||||
| 9156 | storage home data |
|
||||
| 9157 | storage home data debug |
|
||||
| 9158 | storage eos |
|
||||
| 9159 | storage eos debug |
|
||||
| 9160 | storage eos data |
|
||||
| 9161 | storage eos data debug |
|
||||
| 9162 | storage oc |
|
||||
| 9163 | storage oc debug |
|
||||
| 9164 | storage oc data |
|
||||
| 9165 | storage oc data debug |
|
||||
| 9166-9177 | reserved for s3, wnd, custom + data providers |
|
||||
| 9178 | storage public link |
|
||||
| 9179 | storage public link data |
|
||||
26
docs/extensions/ocis-reva/building.md
Normal file
26
docs/extensions/ocis-reva/building.md
Normal file
@@ -0,0 +1,26 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: building.md
|
||||
---
|
||||
|
||||
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-reva.git
|
||||
cd ocis-reva
|
||||
{{< / 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 >}}
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
The above command should produce the binary within the `bin/` folder now, give it a try with `./bin/ocis-reva -h` to see all available options.
|
||||
656
docs/extensions/ocis-reva/configuration.md
Normal file
656
docs/extensions/ocis-reva/configuration.md
Normal file
@@ -0,0 +1,656 @@
|
||||
---
|
||||
title: "Configuration"
|
||||
date: "2020-09-21T13:14:49+0200"
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: configuration.md
|
||||
---
|
||||
|
||||
{{< 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.
|
||||
|
||||
### Configuration using config files
|
||||
|
||||
Out of the box extensions will attempt to read configuration details from:
|
||||
|
||||
```console
|
||||
/etc/ocis
|
||||
$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 ...`*.
|
||||
|
||||
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`.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
|
||||
|
||||
## Root Command
|
||||
|
||||
Example service for Reva/oCIS
|
||||
|
||||
Usage: `ocis-reva [global options] command [command options] [arguments...]`
|
||||
|
||||
--config-file | $REVA_CONFIG_FILE
|
||||
: Path to config file.
|
||||
|
||||
--log-level | $REVA_LOG_LEVEL
|
||||
: Set logging level. Default: `info`.
|
||||
|
||||
--log-pretty | $REVA_LOG_PRETTY
|
||||
: Enable pretty logging.
|
||||
|
||||
--log-color | $REVA_LOG_COLOR
|
||||
: Enable colored logging.
|
||||
|
||||
## Sub Commands
|
||||
|
||||
### ocis-reva auth-basic
|
||||
|
||||
Start reva authprovider for basic auth
|
||||
|
||||
Usage: `ocis-reva auth-basic [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_AUTH_BASIC_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9147`.
|
||||
|
||||
--auth-driver | $REVA_AUTH_DRIVER
|
||||
: auth driver: 'demo', 'json' or 'ldap'. Default: `ldap`.
|
||||
|
||||
--auth-json | $REVA_AUTH_JSON
|
||||
: Path to users.json file.
|
||||
|
||||
--network | $REVA_AUTH_BASIC_NETWORK
|
||||
: Network to use for the reva auth-basic service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_AUTH_BASIC_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_AUTH_BASIC_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9146`.
|
||||
|
||||
--url | $REVA_AUTH_BASIC_URL
|
||||
: URL to use for the reva service. Default: `localhost:9146`.
|
||||
|
||||
### ocis-reva frontend
|
||||
|
||||
Start reva frontend service
|
||||
|
||||
Usage: `ocis-reva frontend [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_FRONTEND_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9141`.
|
||||
|
||||
--transfer-secret | $REVA_TRANSFER_SECRET
|
||||
: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`.
|
||||
|
||||
--webdav-namespace | $WEBDAV_NAMESPACE
|
||||
: Namespace prefix for the /webdav endpoint. Default: `/home/`.
|
||||
|
||||
--dav-files-namespace | $DAV_FILES_NAMESPACE
|
||||
: Namespace prefix for the webdav /dav/files endpoint. Default: `/oc/`.
|
||||
|
||||
--network | $REVA_FRONTEND_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_FRONTEND_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `http`.
|
||||
|
||||
--addr | $REVA_FRONTEND_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9140`.
|
||||
|
||||
--url | $REVA_FRONTEND_URL
|
||||
: URL to use for the reva service. Default: `https://localhost:9200`.
|
||||
|
||||
--datagateway-prefix | $REVA_FRONTEND_DATAGATEWAY_PREFIX
|
||||
: datagateway prefix. Default: `data`.
|
||||
|
||||
--ocdav-prefix | $REVA_FRONTEND_OCDAV_PREFIX
|
||||
: owncloud webdav endpoint prefix.
|
||||
|
||||
--ocs-prefix | $REVA_FRONTEND_OCS_PREFIX
|
||||
: open collaboration services endpoint prefix. Default: `ocs`.
|
||||
|
||||
--gateway-url | $REVA_GATEWAY_URL
|
||||
: URL to use for the reva gateway service. Default: `localhost:9142`.
|
||||
|
||||
--upload-disable-tus | $REVA_FRONTEND_UPLOAD_DISABLE_TUS
|
||||
: Disables TUS upload mechanism. Default: `false`.
|
||||
|
||||
--upload-http-method-override | $REVA_FRONTEND_UPLOAD_HTTP_METHOD_OVERRIDE
|
||||
: Specify an HTTP method (ex: POST) that clients should to use when uploading instead of PATCH.
|
||||
|
||||
### ocis-reva gateway
|
||||
|
||||
Start reva gateway
|
||||
|
||||
Usage: `ocis-reva gateway [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_GATEWAY_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9143`.
|
||||
|
||||
--transfer-secret | $REVA_TRANSFER_SECRET
|
||||
: Transfer secret for datagateway. Default: `replace-me-with-a-transfer-secret`.
|
||||
|
||||
--network | $REVA_GATEWAY_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_GATEWAY_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_GATEWAY_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9142`.
|
||||
|
||||
--url | $REVA_GATEWAY_URL
|
||||
: URL to use for the reva service. Default: `localhost:9142`.
|
||||
|
||||
--commit-share-to-storage-grant | $REVA_GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT
|
||||
: Commit shares to the share manager. Default: `true`.
|
||||
|
||||
--commit-share-to-storage-ref | $REVA_GATEWAY_COMMIT_SHARE_TO_STORAGE_REF
|
||||
: Commit shares to the storage. Default: `true`.
|
||||
|
||||
--share-folder | $REVA_GATEWAY_SHARE_FOLDER
|
||||
: mount shares in this folder of the home storage provider. Default: `Shares`.
|
||||
|
||||
--disable-home-creation-on-login | $REVA_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN
|
||||
: Disable creation of home folder on login.
|
||||
|
||||
--storage-registry-driver | $REVA_STORAGE_REGISTRY_DRIVER
|
||||
: driver of the storage registry. Default: `static`.
|
||||
|
||||
--storage-home-provider | $REVA_STORAGE_HOME_PROVIDER
|
||||
: mount point of the storage provider for user homes in the global namespace. Default: `/home`.
|
||||
|
||||
--frontend-url | $REVA_FRONTEND_URL
|
||||
: URL to use for the reva service. Default: `https://localhost:9200`.
|
||||
|
||||
--datagateway-url | $REVA_DATAGATEWAY_URL
|
||||
: URL to use for the reva datagateway. Default: `https://localhost:9200/data`.
|
||||
|
||||
--users-url | $REVA_USERS_URL
|
||||
: URL to use for the reva service. Default: `localhost:9144`.
|
||||
|
||||
--auth-basic-url | $REVA_AUTH_BASIC_URL
|
||||
: URL to use for the reva service. Default: `localhost:9146`.
|
||||
|
||||
--auth-bearer-url | $REVA_AUTH_BEARER_URL
|
||||
: URL to use for the reva service. Default: `localhost:9148`.
|
||||
|
||||
--sharing-url | $REVA_SHARING_URL
|
||||
: URL to use for the reva service. Default: `localhost:9150`.
|
||||
|
||||
--storage-root-url | $REVA_STORAGE_ROOT_URL
|
||||
: URL to use for the reva service. Default: `localhost:9152`.
|
||||
|
||||
--storage-root-mount-path | $REVA_STORAGE_ROOT_MOUNT_PATH
|
||||
: mount path. Default: `/`.
|
||||
|
||||
--storage-root-mount-id | $REVA_STORAGE_ROOT_MOUNT_ID
|
||||
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009152`.
|
||||
|
||||
--storage-home-url | $REVA_STORAGE_HOME_URL
|
||||
: URL to use for the reva service. Default: `localhost:9154`.
|
||||
|
||||
--storage-home-mount-path | $REVA_STORAGE_HOME_MOUNT_PATH
|
||||
: mount path. Default: `/home`.
|
||||
|
||||
--storage-home-mount-id | $REVA_STORAGE_HOME_MOUNT_ID
|
||||
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009154`.
|
||||
|
||||
--storage-eos-url | $REVA_STORAGE_EOS_URL
|
||||
: URL to use for the reva service. Default: `localhost:9158`.
|
||||
|
||||
--storage-eos-mount-path | $REVA_STORAGE_EOS_MOUNT_PATH
|
||||
: mount path. Default: `/eos`.
|
||||
|
||||
--storage-eos-mount-id | $REVA_STORAGE_EOS_MOUNT_ID
|
||||
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`.
|
||||
|
||||
--storage-oc-url | $REVA_STORAGE_OC_URL
|
||||
: URL to use for the reva service. Default: `localhost:9162`.
|
||||
|
||||
--storage-oc-mount-path | $REVA_STORAGE_OC_MOUNT_PATH
|
||||
: mount path. Default: `/oc`.
|
||||
|
||||
--storage-oc-mount-id | $REVA_STORAGE_OC_MOUNT_ID
|
||||
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
|
||||
|
||||
--public-link-url | $REVA_STORAGE_PUBLIC_LINK_URL
|
||||
: URL to use for the public links service. Default: `localhost:9178`.
|
||||
|
||||
--storage-public-link-mount-path | $REVA_STORAGE_PUBLIC_LINK_MOUNT_PATH
|
||||
: mount path. Default: `/public/`.
|
||||
|
||||
### ocis-reva sharing
|
||||
|
||||
Start reva sharing service
|
||||
|
||||
Usage: `ocis-reva sharing [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_SHARING_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9151`.
|
||||
|
||||
--network | $REVA_SHARING_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_SHARING_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_SHARING_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9150`.
|
||||
|
||||
--url | $REVA_SHARING_URL
|
||||
: URL to use for the reva service. Default: `localhost:9150`.
|
||||
|
||||
--user-driver | $REVA_SHARING_USER_DRIVER
|
||||
: driver to use for the UserShareProvider. Default: `json`.
|
||||
|
||||
--user-json-file | $REVA_SHARING_USER_JSON_FILE
|
||||
: file used to persist shares for the UserShareProvider. Default: `/var/tmp/reva/shares.json`.
|
||||
|
||||
--public-driver | $REVA_SHARING_PUBLIC_DRIVER
|
||||
: driver to use for the PublicShareProvider. Default: `json`.
|
||||
|
||||
### ocis-reva storage-home-data
|
||||
|
||||
Start reva storage-home-data service
|
||||
|
||||
Usage: `ocis-reva storage-home-data [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_STORAGE_HOME_DATA_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9157`.
|
||||
|
||||
--network | $REVA_STORAGE_HOME_DATA_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_STORAGE_HOME_DATA_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `http`.
|
||||
|
||||
--addr | $REVA_STORAGE_HOME_DATA_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9156`.
|
||||
|
||||
--url | $REVA_STORAGE_HOME_DATA_URL
|
||||
: URL to use for the reva service. Default: `localhost:9156`.
|
||||
|
||||
--driver | $REVA_STORAGE_HOME_DATA_DRIVER
|
||||
: storage driver for home data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
|
||||
|
||||
--prefix | $REVA_STORAGE_HOME_DATA_PREFIX
|
||||
: prefix for the http endpoint, without leading slash. Default: `data`.
|
||||
|
||||
--temp-folder | $REVA_STORAGE_HOME_DATA_TEMP_FOLDER
|
||||
: temp folder. Default: `/var/tmp/`.
|
||||
|
||||
--enable-home | $REVA_STORAGE_HOME_ENABLE_HOME
|
||||
: enable the creation of home directories. Default: `true`.
|
||||
|
||||
--gateway-url | $REVA_GATEWAY_URL
|
||||
: URL to use for the reva gateway service. Default: `localhost:9142`.
|
||||
|
||||
--users-url | $REVA_USERS_URL
|
||||
: URL to use for the reva service. Default: `localhost:9144`.
|
||||
|
||||
### ocis-reva health
|
||||
|
||||
Check health status
|
||||
|
||||
Usage: `ocis-reva health [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_DEBUG_ADDR
|
||||
: Address to debug endpoint. Default: `0.0.0.0:9109`.
|
||||
|
||||
### ocis-reva storage-home
|
||||
|
||||
Start reva storage-home service
|
||||
|
||||
Usage: `ocis-reva storage-home [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_STORAGE_HOME_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9155`.
|
||||
|
||||
--network | $REVA_STORAGE_HOME_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_STORAGE_HOME_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_STORAGE_HOME_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9154`.
|
||||
|
||||
--url | $REVA_STORAGE_HOME_URL
|
||||
: URL to use for the reva service. Default: `localhost:9154`.
|
||||
|
||||
--driver | $REVA_STORAGE_HOME_DRIVER
|
||||
: storage driver for home mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
|
||||
|
||||
--mount-path | $REVA_STORAGE_HOME_MOUNT_PATH
|
||||
: mount path. Default: `/home`.
|
||||
|
||||
--mount-id | $REVA_STORAGE_HOME_MOUNT_ID
|
||||
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
|
||||
|
||||
--expose-data-server | $REVA_STORAGE_HOME_EXPOSE_DATA_SERVER
|
||||
: exposes a dedicated data server. Default: `false`.
|
||||
|
||||
--data-server-url | $REVA_STORAGE_HOME_DATA_SERVER_URL
|
||||
: data server url. Default: `http://localhost:9156/data`.
|
||||
|
||||
--enable-home | $REVA_STORAGE_HOME_ENABLE_HOME
|
||||
: enable the creation of home directories. Default: `true`.
|
||||
|
||||
--users-url | $REVA_USERS_URL
|
||||
: URL to use for the reva service. Default: `localhost:9144`.
|
||||
|
||||
### ocis-reva storage-eos-data
|
||||
|
||||
Start reva storage-eos-data service
|
||||
|
||||
Usage: `ocis-reva storage-eos-data [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_STORAGE_OC_DATA_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9161`.
|
||||
|
||||
--network | $REVA_STORAGE_EOS_DATA_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_STORAGE_EOS_DATA_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `http`.
|
||||
|
||||
--addr | $REVA_STORAGE_EOS_DATA_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9160`.
|
||||
|
||||
--url | $REVA_STORAGE_EOS_DATA_URL
|
||||
: URL to use for the reva service. Default: `localhost:9160`.
|
||||
|
||||
--driver | $REVA_STORAGE_EOS_DATA_DRIVER
|
||||
: storage driver for eos data mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`.
|
||||
|
||||
--prefix | $REVA_STORAGE_EOS_DATA_PREFIX
|
||||
: prefix for the http endpoint, without leading slash. Default: `data`.
|
||||
|
||||
--temp-folder | $REVA_STORAGE_EOS_DATA_TEMP_FOLDER
|
||||
: temp folder. Default: `/var/tmp/`.
|
||||
|
||||
--gateway-url | $REVA_GATEWAY_URL
|
||||
: URL to use for the reva gateway service. Default: `localhost:9142`.
|
||||
|
||||
--users-url | $REVA_USERS_URL
|
||||
: URL to use for the reva service. Default: `localhost:9144`.
|
||||
|
||||
### ocis-reva reva-storage-public-link
|
||||
|
||||
Start reva storage-public-link service
|
||||
|
||||
Usage: `ocis-reva reva-storage-public-link [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_STORAGE_PUBLIC_LINK_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9179`.
|
||||
|
||||
--network | $REVA_STORAGE_PUBLIC_LINK_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_STORAGE_PUBLIC_LINK_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_STORAGE_PUBLIC_LINK_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9178`.
|
||||
|
||||
--url | $REVA_STORAGE_PUBLIC_LINK_URL
|
||||
: Address to bind reva service. Default: `localhost:9178`.
|
||||
|
||||
--mount-path | $REVA_STORAGE_PUBLIC_LINK_MOUNT_PATH
|
||||
: mount path. Default: `/public/`.
|
||||
|
||||
--gateway-url | $REVA_GATEWAY_URL
|
||||
: URL to use for the reva gateway service. Default: `localhost:9142`.
|
||||
|
||||
### ocis-reva users
|
||||
|
||||
Start reva users service
|
||||
|
||||
Usage: `ocis-reva users [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_SHARING_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9145`.
|
||||
|
||||
--network | $REVA_USERS_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_USERS_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_USERS_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9144`.
|
||||
|
||||
--url | $REVA_USERS_URL
|
||||
: URL to use for the reva service. Default: `localhost:9144`.
|
||||
|
||||
--driver | $REVA_USERS_DRIVER
|
||||
: user driver: 'demo', 'json', 'ldap', or 'rest'. Default: `ldap`.
|
||||
|
||||
--json-config | $REVA_USERS_JSON
|
||||
: Path to users.json file.
|
||||
|
||||
--rest-client-id | $REVA_REST_CLIENT_ID
|
||||
: User rest driver Client ID.
|
||||
|
||||
--rest-client-secret | $REVA_REST_CLIENT_SECRET
|
||||
: User rest driver Client Secret.
|
||||
|
||||
--rest-redis-address | $REVA_REST_REDIS_ADDRESS
|
||||
: Address for redis server. Default: `localhost:6379`.
|
||||
|
||||
--rest-redis-username | $REVA_REST_REDIS_USERNAME
|
||||
: Username for redis server.
|
||||
|
||||
--rest-redis-password | $REVA_REST_REDIS_PASSWORD
|
||||
: Password for redis server.
|
||||
|
||||
--rest-id-provider | $REVA_REST_ID_PROVIDER
|
||||
: The OIDC Provider.
|
||||
|
||||
--rest-api-base-url | $REVA_REST_API_BASE_URL
|
||||
: Base API Endpoint.
|
||||
|
||||
--rest-oidc-token-endpoint | $REVA_REST_OIDC_TOKEN_ENDPOINT
|
||||
: Endpoint to generate token to access the API.
|
||||
|
||||
--rest-target-api | $REVA_REST_TARGET_API
|
||||
: The target application.
|
||||
|
||||
### ocis-reva auth-bearer
|
||||
|
||||
Start reva authprovider for bearer auth
|
||||
|
||||
Usage: `ocis-reva auth-bearer [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_AUTH_BEARER_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9149`.
|
||||
|
||||
--oidc-issuer | $REVA_OIDC_ISSUER
|
||||
: OIDC issuer. Default: `https://localhost:9200`.
|
||||
|
||||
--oidc-insecure | $REVA_OIDC_INSECURE
|
||||
: OIDC allow insecure communication. Default: `true`.
|
||||
|
||||
--oidc-id-claim | $REVA_OIDC_ID_CLAIM
|
||||
: OIDC id claim. Default: `preferred_username`.
|
||||
|
||||
--oidc-uid-claim | $REVA_OIDC_UID_CLAIM
|
||||
: OIDC uid claim.
|
||||
|
||||
--oidc-gid-claim | $REVA_OIDC_GID_CLAIM
|
||||
: OIDC gid claim.
|
||||
|
||||
--network | $REVA_AUTH_BEARER_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_AUTH_BEARER_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_AUTH_BEARER_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9148`.
|
||||
|
||||
--url | $REVA_AUTH_BEARER_URL
|
||||
: URL to use for the reva service. Default: `localhost:9148`.
|
||||
|
||||
### ocis-reva storage-eos
|
||||
|
||||
Start reva storage-eos service
|
||||
|
||||
Usage: `ocis-reva storage-eos [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_STORAGE_EOS_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9159`.
|
||||
|
||||
--network | $REVA_STORAGE_EOS_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_STORAGE_EOS_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_STORAGE_EOS_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9158`.
|
||||
|
||||
--url | $REVA_STORAGE_EOS_URL
|
||||
: URL to use for the reva service. Default: `localhost:9158`.
|
||||
|
||||
--driver | $REVA_STORAGE_EOS_DRIVER
|
||||
: storage driver for eos mount: eg. local, eos, owncloud, ocis or s3. Default: `eos`.
|
||||
|
||||
--mount-path | $REVA_STORAGE_EOS_MOUNT_PATH
|
||||
: mount path. Default: `/eos`.
|
||||
|
||||
--mount-id | $REVA_STORAGE_EOS_MOUNT_ID
|
||||
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009158`.
|
||||
|
||||
--expose-data-server | $REVA_STORAGE_EOS_EXPOSE_DATA_SERVER
|
||||
: exposes a dedicated data server. Default: `false`.
|
||||
|
||||
--data-server-url | $REVA_STORAGE_EOS_DATA_SERVER_URL
|
||||
: data server url. Default: `http://localhost:9160/data`.
|
||||
|
||||
### ocis-reva storage-oc
|
||||
|
||||
Start reva storage-oc service
|
||||
|
||||
Usage: `ocis-reva storage-oc [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_STORAGE_OC_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9163`.
|
||||
|
||||
--network | $REVA_STORAGE_OC_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_STORAGE_OC_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_STORAGE_OC_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9162`.
|
||||
|
||||
--url | $REVA_STORAGE_OC_URL
|
||||
: URL to use for the reva service. Default: `localhost:9162`.
|
||||
|
||||
--driver | $REVA_STORAGE_OC_DRIVER
|
||||
: storage driver for oc mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
|
||||
|
||||
--mount-path | $REVA_STORAGE_OC_MOUNT_PATH
|
||||
: mount path. Default: `/oc`.
|
||||
|
||||
--mount-id | $REVA_STORAGE_OC_MOUNT_ID
|
||||
: mount id. Default: `1284d238-aa92-42ce-bdc4-0b0000009162`.
|
||||
|
||||
--expose-data-server | $REVA_STORAGE_OC_EXPOSE_DATA_SERVER
|
||||
: exposes a dedicated data server. Default: `false`.
|
||||
|
||||
--data-server-url | $REVA_STORAGE_OC_DATA_SERVER_URL
|
||||
: data server url. Default: `http://localhost:9164/data`.
|
||||
|
||||
--users-url | $REVA_USERS_URL
|
||||
: URL to use for the reva service. Default: `localhost:9144`.
|
||||
|
||||
### ocis-reva storage-oc-data
|
||||
|
||||
Start reva storage-oc-data service
|
||||
|
||||
Usage: `ocis-reva storage-oc-data [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_STORAGE_OC_DATA_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9165`.
|
||||
|
||||
--network | $REVA_STORAGE_OC_DATA_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_STORAGE_OC_DATA_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `http`.
|
||||
|
||||
--addr | $REVA_STORAGE_OC_DATA_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9164`.
|
||||
|
||||
--url | $REVA_STORAGE_OC_DATA_URL
|
||||
: URL to use for the reva service. Default: `localhost:9164`.
|
||||
|
||||
--driver | $REVA_STORAGE_OC_DATA_DRIVER
|
||||
: storage driver for oc data mount: eg. local, eos, owncloud, ocis or s3. Default: `owncloud`.
|
||||
|
||||
--prefix | $REVA_STORAGE_OC_DATA_PREFIX
|
||||
: prefix for the http endpoint, without leading slash. Default: `data`.
|
||||
|
||||
--temp-folder | $REVA_STORAGE_OC_DATA_TEMP_FOLDER
|
||||
: temp folder. Default: `/var/tmp/`.
|
||||
|
||||
--gateway-url | $REVA_GATEWAY_URL
|
||||
: URL to use for the reva gateway service. Default: `localhost:9142`.
|
||||
|
||||
--users-url | $REVA_USERS_URL
|
||||
: URL to use for the reva service. Default: `localhost:9144`.
|
||||
|
||||
### ocis-reva storage-root
|
||||
|
||||
Start reva storage-root service
|
||||
|
||||
Usage: `ocis-reva storage-root [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $REVA_STORAGE_ROOT_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9153`.
|
||||
|
||||
--network | $REVA_STORAGE_ROOT_NETWORK
|
||||
: Network to use for the reva service, can be 'tcp', 'udp' or 'unix'. Default: `tcp`.
|
||||
|
||||
--protocol | $REVA_STORAGE_ROOT_PROTOCOL
|
||||
: protocol for reva service, can be 'http' or 'grpc'. Default: `grpc`.
|
||||
|
||||
--addr | $REVA_STORAGE_ROOT_ADDR
|
||||
: Address to bind reva service. Default: `0.0.0.0:9152`.
|
||||
|
||||
--url | $REVA_STORAGE_ROOT_URL
|
||||
: URL to use for the reva service. Default: `localhost:9152`.
|
||||
|
||||
--driver | $REVA_STORAGE_ROOT_DRIVER
|
||||
: storage driver for root mount: eg. local, eos, owncloud, ocis or s3. Default: `local`.
|
||||
|
||||
--mount-path | $REVA_STORAGE_ROOT_MOUNT_PATH
|
||||
: mount path. Default: `/`.
|
||||
|
||||
--mount-id | $REVA_STORAGE_ROOT_MOUNT_ID
|
||||
: mount id. Default: `123e4567-e89b-12d3-a456-426655440001`.
|
||||
|
||||
--expose-data-server | $REVA_STORAGE_ROOT_EXPOSE_DATA_SERVER
|
||||
: exposes a dedicated data server.
|
||||
|
||||
--data-server-url | $REVA_STORAGE_ROOT_DATA_SERVER_URL
|
||||
: data server url.
|
||||
|
||||
56
docs/extensions/ocis-reva/getting-started.md
Normal file
56
docs/extensions/ocis-reva/getting-started.md
Normal file
@@ -0,0 +1,56 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 15
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
Docker images for ocis-reva are hosted on https://hub.docker.com/r/owncloud/ocis-reva.
|
||||
|
||||
The `latest` tag always reflects the current master branch.
|
||||
|
||||
```console
|
||||
docker pull owncloud/ocis-reva
|
||||
```
|
||||
|
||||
#### Dependencies
|
||||
|
||||
- Running ocis-reva currently needs a working Redis caching server
|
||||
- The default storage location in the container is `/var/tmp/reva/data`. You may want to create a volume to persist the files in the primary storage
|
||||
|
||||
### Binaries
|
||||
|
||||
The pre-built binaries for different platforms are downloadable at https://download.owncloud.com/ocis/ocis-reva/ . 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/ocis-reva/testing/
|
||||
|
||||
```console
|
||||
curl https://download.owncloud.com/ocis/ocis/1.0.0-beta1/ocis-reva-1.0.0-beta1-darwin-amd64 --output ocis-reva
|
||||
chmod +x ocis
|
||||
./ocis-reva sharing
|
||||
```
|
||||
|
||||
#### Dependencies
|
||||
|
||||
- Running ocis currently needs a working Redis caching server
|
||||
- The default promary storage location is `/var/tmp/reva/data`. You can change that value by configuration.
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-reva --help`.
|
||||
|
||||
### 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 >}}
|
||||
ocis-reva health --help
|
||||
{{< / highlight >}}
|
||||
10
docs/extensions/ocis-reva/license.md
Normal file
10
docs/extensions/ocis-reva/license.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 40
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: license.md
|
||||
---
|
||||
|
||||
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/ocis-revablob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
|
||||
47
docs/extensions/ocis-reva/releasing.md
Normal file
47
docs/extensions/ocis-reva/releasing.md
Normal file
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: "Releasing"
|
||||
date: 2020-05-22T00:00:00+00:00
|
||||
weight: 60
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: releasing.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
To release a new version of ocis-reva, you have to follow a few simple steps.
|
||||
|
||||
## Preparation
|
||||
|
||||
1. Before releasing, make sure that reva has been [updated to the desired version]({{< ref "updating.md" >}})
|
||||
2. Create a new branch e.g. `release-x.x.x` where `x.x.x` is the version you want to release.
|
||||
3. Checkout the preparation branch.
|
||||
4. Create a new changelog folder and move the unreleased snippets there.
|
||||
{{< highlight txt >}}
|
||||
mkdir changelog/x.x.x_yyyy-MM-dd/ # yyyy-MM-dd is the current date
|
||||
mv changelog/unreleased/* changelog/x.x.x_yyyy-MM-dd/
|
||||
{{< / highlight >}}
|
||||
5. Commit and push the changes
|
||||
{{< highlight txt >}}
|
||||
git add --all
|
||||
git commit -m "prepare release x.x.x"
|
||||
git push origin release-x.x.x
|
||||
{{< / highlight >}}
|
||||
6. Create a pull request to the master branch.
|
||||
|
||||
## Release
|
||||
1. After the preparation branch has been merged update your local master.
|
||||
2. [Wait for CI](https://cloud.drone.io/owncloud/ocis-reva) to generate a commit for the changelog update
|
||||
3. Check out master (or make sure to check out the generated changelog commit in case of subsequent merges)
|
||||
{{< highlight txt >}}
|
||||
git checkout master
|
||||
git pull origin master
|
||||
{{< / highlight >}}
|
||||
4. Create a new tag (preferably signed) and replace the version number accordingly.
|
||||
{{< highlight txt >}}
|
||||
git tag -s vx.x.x -m "release vx.x.x"
|
||||
git push origin vx.x.x
|
||||
{{< / highlight >}}
|
||||
5. Wait for CI and check that the GitHub release was published.
|
||||
|
||||
Congratulations, you just released ocis-reva!
|
||||
194
docs/extensions/ocis-reva/storages.md
Normal file
194
docs/extensions/ocis-reva/storages.md
Normal file
@@ -0,0 +1,194 @@
|
||||
---
|
||||
title: "Storages"
|
||||
date: 2020-04-27T18:46:00+01:00
|
||||
weight: 37
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: storages.md
|
||||
---
|
||||
|
||||
## Storage commands
|
||||
|
||||
`ocis-reva` has multiple storage provider commands to preconfigure different default configurations for the reva *storage provider* service. While you could rerun `ocis-reva storage-oc` multiple times with different flags to get multiple instances we are giving the different commands the necessary default configuration to allow the `ocis` binary to simply start them and not deal with configuration.
|
||||
|
||||
## Storage providers
|
||||
|
||||
To manage the file tree ocis uses reva *storage providers* that are accessing the underlying storage using a *storage driver*. The driver can be used to change the implementation of a storage aspect to better reflect the actual underlying storage capabilities. As an example a move operation on a POSIX filesystem ([theoretically](https://danluu.com/deconstruct-files/)) is an atomic operation. When trying to implement a file tree on top of S3 there is no native move operation that can be used. A naive implementation might fall back on a COPY and DELETE. Some S3 implementations provide a COPY operation that uses an existing key as the source, so the file at least does not need to be reuploaded. In the worst case scenario, which is renaming a folder with hundreds of thousands of objects, a reupload for every file has to be made. Instead of hiding this complexity a better choice might be to disable renaming of files or at least folders on S3. There are however implementations of filesystems on top of S3 that store the tree metadata in dedicated objects or use a completely different persistence mechanism like a distributed key value store to implement the file tree aspect of a storage.
|
||||
|
||||
|
||||
{{< hint info >}}
|
||||
While the *storage provider* is responsible for managing the tree, file up and download is delegated to a dedicated *data provider*. See below.
|
||||
{{< /hint >}}
|
||||
|
||||
## Storage aspects
|
||||
A lot of different storage technologies exist, ranging from general purpose file systems with POSIX semantics to software defined storage with multiple APIs. Choosing any of them is making a tradeoff decision. Or, if a storage technology is already in place it automatically predetermines the capabilities that can be made available. *Not all storage systems are created equal.*
|
||||
|
||||
Unfortunately, no POSIX filesystem natively supports all storage aspects that ownCloud 10 requires:
|
||||
|
||||
|
||||
### A hierarchical file tree
|
||||
An important aspect of a filesystem is organizing files and directories in a file hierarchy, or tree. It allows you to create, move and delete nodes. Beside the name a node also has well known metadata like size and mtime that are persisted in the tree as well.
|
||||
|
||||
{{< hint info >}}
|
||||
**Folders are not directories**
|
||||
There is a difference between *folder* and *directory*: a *directory* is a file system concept. A *folder* is a metaphor for the concept of a physical file folder. There are also *virtual folders* or *smart folders* like the recent files folder which are no file system *directories*. So, every *directory* and every *virtual folder* is a *folder*, but not every *folder* is a *directory*. See [the folder metaphor in wikipedia](https://en.wikipedia.org/wiki/Directory_(computing)#Folder_metaphor). Also see the activity history below.
|
||||
{{< /hint >}}
|
||||
|
||||
#### Id based lookup
|
||||
While traditionally nodes in the tree are reached by traversing the path the tree persistence should be prepared to look up a node by an id. Think of an inode in a POSIX filesystem. If this operation needs to be cached for performance reasons keep in mind that cache invalidation is hard and crawling all files to update the inode to path mapping takes O(n), not O(1).
|
||||
|
||||
#### ETag propagation
|
||||
For the state based sync a client can discover changes by recursively descending the tree and comparing the ETag for every node. If the storage technology supports propagating ETag changes up the tree, only the root node of a tree needs to be checked to determine if a discovery needs to be started and which nodes need to be traversed. This allows using the storage technology itself to persist all metadata that is necessary for sync, without additional services or caches.
|
||||
|
||||
#### Subtree size accounting
|
||||
The tree can keep track of how many bytes are stored in a folder. Similar to ETag propagation a change in file size is propagated up the hierarchy.
|
||||
|
||||
{{< hint info >}}
|
||||
**ETag and Size propagation**
|
||||
When propagating the ETag (mtime) and size changes up the tree the question is where to stop. If all changes need to be propagated to the root of a storage then the root or busy folders will become a hotspot. There are two things to keep in mind: 1. propagation only happens up to the root of a single space (a user private drive or a single group drive), 2. no cross storage propagation. The latter was used in oc10 to let clients detect when a file in a received shared folder changed. This functionality is moving to the storage registry which caches the ETag for every root so clients can discover if and which storage changed.
|
||||
{{< /hint >}}
|
||||
|
||||
#### Rename
|
||||
Depending on the underlying storage technology some operations may either be slow, up to a point where it makes more sense to disable them entirely. One example is a folder rename: on S3 a *simple* folder rename translates to a copy and delete operation for every child of the renamed folder. There is an exception though: this restriction only applies if the S3 storage is treated like a filesystem, where the keys are the path and the value is the file content. There are smarter ways to implement file systems on top of S3, but again: there is always a tradeoff.
|
||||
|
||||
{{< hint info >}}
|
||||
**S3 has no rename**
|
||||
Technically, [S3 has no rename operation at all](https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/examples-s3-objects.html#copy-object). By design, the location of the value is determined by the key, so it always has to do a copy and delete. Another example is the [redis RENAME operation](https://redis.io/commands/rename): while being specified as O(1) it *executes an implicit DEL operation, so if the deleted key contains a very big value it may cause high latency...*
|
||||
{{< /hint >}}
|
||||
|
||||
#### Arbitrary metadata persistence
|
||||
In addition to well known metadata like name size and mtime, users might be able to add arbitrary metadata like tags, comments or [dublin core](https://en.wikipedia.org/wiki/Dublin_Core). In POSIX filesystems this maps to extended attributes.
|
||||
|
||||
### Grant persistence
|
||||
The CS3 API uses grants to describe access permissions. Storage systems have a wide range of permissions granularity and not all grants may be supported by every storage driver. POSIX ACLs for example have no expiry. If the storage system does not support certain grant properties, e.g. expiry, then the storage driver may choose to implement them in a different way. Expiries could be persisted in a different way and checked periodically to remove the grants. Again: every decision is a tradeoff.
|
||||
|
||||
### Trash persistence
|
||||
After deleting a node the storage allows listing the deleted nodes and has an undo mechanism for them.
|
||||
|
||||
### Versions persistence
|
||||
A user can restore a previous version of a file.
|
||||
|
||||
{{< hint info >}}
|
||||
**Snapshots are not versions**
|
||||
Modern POSIX filesystems support snapshotting of volumes. This is different from keeping track of versions to a file or folder, but might be another implementation strategy for a storage driver to allow users to restore content.
|
||||
{{< /hint >}}
|
||||
|
||||
### Activity History
|
||||
The storage keeps an activity history, tracking the different actions that have been performed. This does not only include file changes but also metadata changes like renames and permission changes.
|
||||
|
||||
## Storage drivers
|
||||
|
||||
Reva currently has four storage driver implementations that can be used for *storage providers* an well as *data providers*.
|
||||
|
||||
### Local Storage Driver
|
||||
|
||||
The *minimal* storage driver for a POSIX based filesystem. It literally supports none of the storage aspect other than basic file tree management. Sharing can - to a degree - be implemented using POSIX ACLs.
|
||||
|
||||
- tree provided by a POSIX filesystem
|
||||
- inefficient path by id lookup, currently uses the file path as id, so ids are not stable
|
||||
- can store a uuid in extended attributes and use a cache to look them up, similar to the ownCloud driver
|
||||
- no native ETag propagation, five options are available:
|
||||
- built in propagation (changes bypassing ocis are not picked up until a rescan)
|
||||
- built in inotify (requires 48 bytes of RAM per file, needs to keep track of every file and folder)
|
||||
- external inotify (same RAM requirement, but could be triggered by external tools, e.g. a workflow engine)
|
||||
- kernel audit log (use the linux kernel audit to capture file events on the storage and offload them to a queue)
|
||||
- fuse filesystem overlay
|
||||
- no subtree accounting, same options as for ETag propagation
|
||||
- efficient rename
|
||||
- arbitrary metadata using extended attributes
|
||||
- grant persistence
|
||||
- using POSIX ACLs
|
||||
- requires an LDAP server to make guest accounts available in the OS
|
||||
- OCIS has glauth which contains all users
|
||||
- an existing LDAP could be used if guests ar provisioned in another way
|
||||
- using extended attributes to implement expiry or sharing that does not require OS level integration
|
||||
- fuse filesystem overlay
|
||||
- no native trash
|
||||
- could use the [The FreeDesktop.org Trash specification](https://specifications.freedesktop.org/trash-spec/trashspec-latest.html)
|
||||
- fuse filesystem overlay
|
||||
- no native versions, multiple options possible
|
||||
- git for folders
|
||||
- rcs for single files
|
||||
- rsnapshot for hourly / daily / weekly / monthly backups ... but this is not versioning as known from oc10
|
||||
- design new freedesktop spec, basically what is done in oc10 without the limitations or borrow ideas from the freedesktop trash spec
|
||||
- fuse filesystem overlay
|
||||
|
||||
To provide the other storage aspects we plan to implement a FUSE overlay filesystem which will add the different aspects on top of local filesystems like ext4, btrfs or xfs. It should work on NFSv45 as well, although NFSv4 supports RichACLs and we will explore how to leverage them to implement sharing at a future date. The idea is to use the storages native capabilities to deliver the best user experience. But again: that means making the right tradeoffs.
|
||||
|
||||
### OwnCloud Storage Driver
|
||||
|
||||
This is the current default storage driver. While it implements the file tree (using redis, including id based lookup), ETag propagation, trash, versions and sharing (including expiry) using the data directory layout of ownCloud 10 it has [known limitations](https://github.com/owncloud/core/issues/28095) that cannot be fixed without changing the actual layout on disk.
|
||||
|
||||
To setup it up properly in a distributed fashion, the storage-home and the storage-oc need to share the same underlying FS. Their "data" counterparts also need access to the same shared FS.
|
||||
For a simple docker-compose setup, you can create a volume which will be used by the "ocis-reva-storage-home", "ocis-reva-storage-home-data", "ocis-reva-storage-oc" and "ocis-reva-storage-oc-data" containers. Using the `owncloud/ocis-reva` docker image, the volume would need to be hooked in the `/var/tmp/reva` folder insde the containers.
|
||||
|
||||
- tree provided by a POSIX filesystem
|
||||
- file layout is mapped to the old ownCloud 10 layout
|
||||
- the root of tree for a user on disk is prefixed with `/path/to/data/<username>/files/`
|
||||
- efficient path by id lookup
|
||||
- all files and folders get assigned a uuid in the extended attributes
|
||||
- when starting the storage provider it will walk all files to populate a redis kv store for uuid to path lookup
|
||||
- slow to boot trees with lots of nodes
|
||||
- build in ETag propagation
|
||||
- ETags are calculated based on mtime
|
||||
- mtime is propagated by the storage driver
|
||||
- changes bypassing ocis are not picked up until a restart of the storage provider
|
||||
- no subtree accounting, same options as for local storage
|
||||
- efficient rename
|
||||
- TODO [update the kv store for path lookup](https://github.com/cs3org/reva/issues/985), this is an O(n) operation
|
||||
- arbitrary metadata using extended attributes
|
||||
- grant persistence
|
||||
- using custom ACLs that are stored as extended attributes
|
||||
- a grant corresponds to one extended attribute of 40-100 bytes, effectively limiting the number of shares to ~100-40
|
||||
- extended attributes have varying limitations, based on the underlying filesystem
|
||||
- the linux kernel imposes a limit of 255bytes per name and 64KiB per value
|
||||
- ext2/3/4: total bytes for all attributes of a file is limited to 4KiB (a filesystem block)
|
||||
- xfs: limit of 64KiB per value
|
||||
- btrfs: total bytes used for the name, value, and implementation overhead bytes 16KiB (the default filesystem nodesize value)
|
||||
- does not require OS level integration
|
||||
- built in trash
|
||||
- trashed files are moved to `/path/to/data/<username>/files_trashbin/`
|
||||
- trashed files are appended a timestamp `.d<unixtime>`, which [breaks trashing of files that reach the filesystems specific name limit](https://github.com/owncloud/core/issues/28095)
|
||||
- built in versions
|
||||
- file versions are stored in `/path/to/data/<username>/files_versions/`
|
||||
- file versions are appended a timestamp `.d<unixtime>`, which [breaks versioning of files that reach the filesystems specific name limit](https://github.com/owncloud/core/issues/28095)
|
||||
|
||||
### EOS Storage Driver
|
||||
|
||||
The CERN eos storage has evolved with ownCloud and natively supports id based lookup, ETag propagation, subtree size accounting, sharing, trash and versions. To use it you need to change the default configuration of the `ocis-reva storage-home` command (or have a look at the Makefile ̀ eos-start` target):
|
||||
|
||||
```
|
||||
export REVA_STORAGE_HOME_DRIVER=eos
|
||||
export REVA_STORAGE_EOS_NAMESPACE=/eos
|
||||
export REVA_STORAGE_EOS_MASTER_URL="root://eos-mgm1.eoscluster.cern.ch:1094"
|
||||
export REVA_STORAGE_EOS_ENABLE_HOME=true
|
||||
export REVA_STORAGE_EOS_LAYOUT="dockertest/{{.Username}}"
|
||||
```
|
||||
|
||||
Running it locally also requires the `eos` and `xrootd` binaries. Running it using `make eos-start` will use CentOS based containers that already have the necessary packages installed.
|
||||
|
||||
{{< hint info >}}
|
||||
Pull requests to add explicit `reva storage-(s3|custom|...)` commands with working defaults are welcome.
|
||||
{{< /hint >}}
|
||||
|
||||
### S3 Storage Driver
|
||||
|
||||
A naive driver that treats the keys in an S3 capable storage as `/` delimited path names. While it does not support MOVE or ETag propagation it can be used to read and write files. Better integration with native capabilities like versioning is possible but depends on the Use Case. Several storage solutions that provide an S3 interface also support some form of notifications that can be used to implement ETag propagation.
|
||||
|
||||
## Data Providers
|
||||
|
||||
Clients using the CS3 API use an [InitiateFileDownload](https://cs3org.github.io/cs3apis/#cs3.storage.provider.v1beta1.InitiateFileDownloadRequest) and ]InitiateUpload](https://cs3org.github.io/cs3apis/#cs3.storage.provider.v1beta1.InitiateFileUploadRequest) request at the [reva gateway](https://cs3org.github.io/cs3apis/#cs3.gateway.v1beta1.GatewayAPI) to obtain a URL endpoint that can be used to either GET the file content or upload content using the resumable [tus.io](https://tus.io) protocol.
|
||||
|
||||
The *data provider* uses the same *storage driver* as the *storage provider* but can be scaled independently.
|
||||
|
||||
The dataprovider allows uploading the file to a quarantine area where further data analysis may happen before making the file accessible again. One use case for this is anti virus scanning for files coming from untrusted sources.
|
||||
|
||||
## Future work
|
||||
|
||||
### FUSE overlay filesystem
|
||||
We are planning to further separate the concerns and use a local storage provider with a FUSE filesystem overlaying the actual POSIX storage that can be used to capture deletes and writes that might happen outside of ocis/reva.
|
||||
|
||||
It would allow us to extend the local storage driver with missing storage aspects while keeping a tree like filesystem that end users are used to see when sshing into the machine.
|
||||
|
||||
### Upload to Quarantine area
|
||||
Antivirus scanning of random files uploaded from untrusted sources and executing metadata extraction or thumbnail generation should happen in a sandboxed system to prevent malicious users from gaining any information about the system. By spawning a new container with access to only the uploaded data we can further limit the attack surface.
|
||||
148
docs/extensions/ocis-reva/testing.md
Normal file
148
docs/extensions/ocis-reva/testing.md
Normal file
@@ -0,0 +1,148 @@
|
||||
---
|
||||
title: "Testing"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 37
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: testing.md
|
||||
---
|
||||
|
||||
|
||||
## API Acceptance tests
|
||||
|
||||
We are using the ownCloud 10 API acceptance testsuite against ocis. To set this up you need the owncloud 10 core repo, a ldap server that the acceptance tests can use to manage users, a redis server for file-versions and the ocis-reva code.
|
||||
|
||||
### Getting the tests
|
||||
|
||||
All you need to do to get the acceptance tests is check out the core repo:
|
||||
```
|
||||
git clone https://github.com/owncloud/core.git
|
||||
```
|
||||
|
||||
### Run a ldap server in a docker container
|
||||
|
||||
The ownCloud 10 acceptance tests will need write permission. You can start a suitable ldap server in a docker container with:
|
||||
|
||||
```
|
||||
docker run --hostname ldap.my-company.com \
|
||||
-e LDAP_TLS_VERIFY_CLIENT=never \
|
||||
-e LDAP_DOMAIN=owncloud.com \
|
||||
-e LDAP_ORGANISATION=ownCloud \
|
||||
-e LDAP_ADMIN_PASSWORD=admin \
|
||||
--name docker-slapd \
|
||||
-p 127.0.0.1:389:389 \
|
||||
-p 636:636 -d osixia/openldap
|
||||
```
|
||||
### Run a redis server in a docker container
|
||||
|
||||
File versions need a redis server. Start one with docker by using:
|
||||
|
||||
`docker run -e REDIS_DATABASES=1 -p 6379:6379 -d webhippie/redis:latest`
|
||||
|
||||
### Run ocis-reva with that ldap server
|
||||
|
||||
`ocis-reva` provides multiple subcommands. To configure them all via env vars you can export these environment variables.
|
||||
|
||||
```
|
||||
export REVA_USERS_DRIVER=ldap
|
||||
export REVA_LDAP_HOSTNAME=localhost
|
||||
export REVA_LDAP_PORT=636
|
||||
export REVA_LDAP_BASE_DN='dc=owncloud,dc=com'
|
||||
export REVA_LDAP_USERFILTER='(&(objectclass=posixAccount)(cn=%s))'
|
||||
export REVA_LDAP_GROUPFILTER='(&(objectclass=posixGroup)(cn=%s))'
|
||||
export REVA_LDAP_BIND_DN='cn=admin,dc=owncloud,dc=com'
|
||||
export REVA_LDAP_BIND_PASSWORD=admin
|
||||
export REVA_LDAP_SCHEMA_UID=uid
|
||||
export REVA_LDAP_SCHEMA_MAIL=mail
|
||||
export REVA_LDAP_SCHEMA_DISPLAYNAME=displayName
|
||||
export REVA_LDAP_SCHEMA_CN=cn
|
||||
export REVA_FRONTEND_URL=http://localhost:9140 # needed because the proxy is not started
|
||||
export REVA_DATAGATEWAY_URL=http://localhost:9140/data # needed because the proxy is not started
|
||||
```
|
||||
|
||||
Then you need to start the ocis-reva services
|
||||
```
|
||||
bin/ocis-reva frontend & \
|
||||
bin/ocis-reva gateway & \
|
||||
bin/ocis-reva auth-basic & \
|
||||
bin/ocis-reva auth-bearer & \
|
||||
bin/ocis-reva sharing & \
|
||||
bin/ocis-reva storage-home & \
|
||||
bin/ocis-reva storage-home-data & \
|
||||
bin/ocis-reva storage-oc & \
|
||||
bin/ocis-reva storage-oc-data & \
|
||||
bin/ocis-reva users &
|
||||
```
|
||||
|
||||
### Run the API acceptance tests
|
||||
|
||||
In the ownCloud 10 core repo run
|
||||
|
||||
```
|
||||
make test-acceptance-api \
|
||||
TEST_SERVER_URL=http://localhost:9140 \
|
||||
TEST_EXTERNAL_USER_BACKENDS=true \
|
||||
TEST_OCIS=true \
|
||||
OCIS_REVA_DATA_ROOT=/var/tmp/reva/ \
|
||||
BEHAT_FILTER_TAGS='~@notToImplementOnOCIS&&~@toImplementOnOCIS&&~@preview-extension-required' \
|
||||
SKELETON_DIR=apps/testing/data/apiSkeleton
|
||||
```
|
||||
|
||||
Make sure to adjust the settings `TEST_SERVER_URL`,`OCIS_REVA_DATA_ROOT` and `SKELETON_DIR` according to your environment.
|
||||
|
||||
This will run all tests that are relevant to OCIS.
|
||||
|
||||
To run a single test add `BEHAT_FEATURE=<feature file>` and specify the path to the feature file and an optional line number. For example: `BEHAT_FEATURE='tests/acceptance/features/apiWebdavUpload1/uploadFile.feature:12'`
|
||||
|
||||
### use existing tests for BDD
|
||||
|
||||
As a lot of scenarios are written for oC10, we can use those tests for Behaviour driven development in ocis.
|
||||
Every scenario that does not work in OCIS with OC storage, is listed in `tests/acceptance/expected-failures-on-OC-storage.txt` with a link to the related issue.
|
||||
Similarly, scenarios that do not work in OCIS with EOS storage are listed in `tests/acceptance/expected-failures-on-EOS-storage.txt`.
|
||||
Scenarios from the oC10 API acceptance tests are run in the ordinary acceptance test pipeline in CI. The scenarios that fail are checked against the
|
||||
expected failures. If there are any differences then the CI pipeline fails.
|
||||
|
||||
Additionally, some issues have scenarios that demonstrate the current buggy behaviour in ocis(reva).
|
||||
Those scenarios are in this ocis-reva repository in `tests/acceptance/features/apiOcisSpecific`.
|
||||
Have a look into the [documentation](https://doc.owncloud.com/server/developer_manual/testing/acceptance-tests.html#writing-scenarios-for-bugs) to understand why we are writing those tests.
|
||||
Also, ocis behaves partly differently with EOS-Storage and OC-Storage. There are scenarios that do not work in OCIS when run on EOS-storage, but works when on OC-Storage, and vice-versa. For those kind of scenarios, ` @skipOnOcis-EOS-Storage` and `@skipOnOcis-OC-Storage` tags are used. For instance, for a scenario that fails on EOS-Storage but passes on OC-Storage, we use `@skipOnOcis-EOS-Storage` tag to let it run on OC-Storage, where it works as expected, instead of skipping the test completely.
|
||||
|
||||
If you want to work on a specific issue
|
||||
|
||||
1. adjust the core commit id to the latest commit in core so that CI will run the latest test code and scenarios from core.
|
||||
For that change `coreCommit` in the `config` section:
|
||||
|
||||
config = {
|
||||
'apiTests': {
|
||||
'coreBranch': 'master',
|
||||
'coreCommit': 'a06b1bd5ba8e5244bfaf7fa04f441961e6fb0daa',
|
||||
'numberOfParts': 2
|
||||
}
|
||||
}
|
||||
|
||||
2. locally run each of the tests marked with that issue in the expected failures file:
|
||||
|
||||
E.g.:
|
||||
```
|
||||
make test-acceptance-api \
|
||||
TEST_SERVER_URL=http://localhost:9140 \
|
||||
TEST_EXTERNAL_USER_BACKENDS=true \
|
||||
TEST_OCIS=true \
|
||||
OCIS_REVA_DATA_ROOT=/var/tmp/reva/ \
|
||||
BEHAT_FEATURE='tests/acceptance/features/apiComments/comments.feature:123'
|
||||
```
|
||||
|
||||
3. the tests will fail, try to understand how and why they are failing
|
||||
4. fix the code
|
||||
5. go back to 2. and repeat till the tests are passing.
|
||||
6. remove those tests from the expected failures file.
|
||||
7. run each of the local tests that were demonstrating the **buggy** behavior. They should fail.
|
||||
8. delete each of the local tests that were demonstrating the **buggy** behavior.
|
||||
9. make a PR that has the fixed code, relevant lines removed from the expected failures file and bug demonstration tests deleted.
|
||||
|
||||
If the changes also affect the `ocis` repository make sure the changes get ported over there.
|
||||
That will need the fixed code in `ocis-reva` to be applied to `ocis` along with the test-related changes.
|
||||
|
||||
### Notes
|
||||
- in a normal case the test-code cleans up users after the test-run, but if a test-run is interrupted (e.g. by CTRL+C) users might have been left on the LDAP server. In that case rerunning the tests requires wiping the users in the ldap server, otherwise the tests will fail when trying to populate the users. This can be done by simply running `docker stop docker-slapd && docker rm docker-slapd` and [restarting the LDAP server container](#run-a-ldap-server-in-a-docker-container)
|
||||
- the tests usually create users in the OU `TestUsers` with usernames specified in the feature file. If not defined in the feature file, most users have the password `123456`, defined by `regularUserPassword` in `behat.yml`, but other passwords are also used, see [`\FeatureContext::getPasswordForUser()`](https://github.com/owncloud/core/blob/master/tests/acceptance/features/bootstrap/FeatureContext.php#L386) for mapping and [`\FeatureContext::__construct`](https://github.com/owncloud/core/blob/master/tests/acceptance/features/bootstrap/FeatureContext.php#L1668) for the password definitions.
|
||||
19
docs/extensions/ocis-reva/updating.md
Normal file
19
docs/extensions/ocis-reva/updating.md
Normal file
@@ -0,0 +1,19 @@
|
||||
---
|
||||
title: "Updating reva"
|
||||
date: 2020-05-22T00:00:00+00:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: updating.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Updating reva
|
||||
|
||||
1. Run `go get github.com/cs3org/reva@master`
|
||||
2. Create a changelog entry containing changes that were done in [reva](https://github.com/cs3org/reva/commits/master)
|
||||
3. Create a Pull Request to ocis-reva master with those changes
|
||||
4. If test issues appear, you might need to [adjust the tests]({{< ref "testing.md" >}})
|
||||
5. After the PR is merged, consider doing a [release of ocis-reva]({{< ref "releasing.md" >}})
|
||||
|
||||
52
docs/extensions/ocis-reva/users.md
Normal file
52
docs/extensions/ocis-reva/users.md
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: "Users"
|
||||
date: 2020-01-16T00:00:00+00:00
|
||||
weight: 35
|
||||
geekdocRepo: https://github.com/owncloud/ocis-reva
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: users.md
|
||||
---
|
||||
|
||||
### Demo driver
|
||||
|
||||
This is a simple user driver for testing. It contains three users:
|
||||
```
|
||||
einstein:relativity
|
||||
marie:radioactivty
|
||||
richard:superfluidity
|
||||
```
|
||||
In order to use the `demo` driver you need to export the relevant environment variable:
|
||||
```
|
||||
export REVA_USERS_DRIVER=demo
|
||||
```
|
||||
|
||||
### JSON driver
|
||||
|
||||
In order to switch from the `ldap` driver to JSON based users you need to export the relevant environment variables:
|
||||
```
|
||||
export REVA_USERS_DRIVER=json
|
||||
export REVA_USERS_JSON=/path/to/users.json
|
||||
```
|
||||
|
||||
For the format of the users.json have a look at the [reva examples](https://github.com/cs3org/reva/blob/master/examples/separate/users.demo.json)
|
||||
|
||||
### LDAP driver
|
||||
|
||||
This is the default user driver.
|
||||
|
||||
If the below defaults don't match your environment change them accordingly:
|
||||
```
|
||||
export REVA_LDAP_HOSTNAME=localhost
|
||||
export REVA_LDAP_PORT=9126
|
||||
export REVA_LDAP_BASE_DN='dc=example,dc=org'
|
||||
export REVA_LDAP_USERFILTER='(&(objectclass=posixAccount)(cn=%s))'
|
||||
export REVA_LDAP_GROUPFILTER='(&(objectclass=posixGroup)(cn=%s))'
|
||||
export REVA_LDAP_BIND_DN='cn=reva,ou=sysusers,dc=example,dc=org'
|
||||
export REVA_LDAP_BIND_PASSWORD=reva
|
||||
export REVA_LDAP_SCHEMA_UID=uid
|
||||
export REVA_LDAP_SCHEMA_MAIL=mail
|
||||
export REVA_LDAP_SCHEMA_DISPLAYNAME=sn
|
||||
export REVA_LDAP_SCHEMA_CN=cn
|
||||
```
|
||||
|
||||
Then restart the `bin/ocis-reva users` and `bin/ocis-reva auth-basic` services for the changes to take effect.
|
||||
10
docs/extensions/ocs/_index.md
Normal file
10
docs/extensions/ocs/_index.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Ocs"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-ocs
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
This service provides the OCS API which is required by some ownCloud clients.
|
||||
28
docs/extensions/ocs/building.md
Normal file
28
docs/extensions/ocs/building.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-ocs
|
||||
geekdocEditPath: edit/master/docs
|
||||
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
|
||||
cd ocis-ocs
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / 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.
|
||||
154
docs/extensions/ocs/getting-started.md
Normal file
154
docs/extensions/ocs/getting-started.md
Normal file
@@ -0,0 +1,154 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-ocs
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
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.
|
||||
|
||||
```console
|
||||
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/
|
||||
|
||||
```console
|
||||
curl https://download.owncloud.com/ocis/ocis-ocs/1.0.0-beta1/ocis-ocs-1.0.0-beta1-darwin-amd64 --output ocis-ocs
|
||||
chmod +x ocis-ocs
|
||||
./ocis-ocs server
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-ocs --help`.
|
||||
|
||||
### Server
|
||||
|
||||
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 >}}
|
||||
ocis-ocs server --help
|
||||
{{< / 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 >}}
|
||||
ocis-ocs health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
## Metrics
|
||||
|
||||
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `OCS_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9114/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
10
docs/extensions/ocs/license.md
Normal file
10
docs/extensions/ocs/license.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 40
|
||||
geekdocRepo: https://github.com/owncloud/ocis-ocs
|
||||
geekdocEditPath: edit/master/docs
|
||||
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.
|
||||
8
docs/extensions/proxy/_index.md
Normal file
8
docs/extensions/proxy/_index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Proxy
|
||||
geekdocRepo: https://github.com/owncloud/ocis-proxy
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
This service provides a basic proxy in front of the public ocis services.
|
||||
10
docs/extensions/proxy/about.md
Normal file
10
docs/extensions/proxy/about.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "About"
|
||||
date: 2020-02-07T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-proxy
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: about.md
|
||||
---
|
||||
|
||||
This service provides an proxy service that routes requests to the correct services.
|
||||
28
docs/extensions/proxy/building.md
Normal file
28
docs/extensions/proxy/building.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-proxy
|
||||
geekdocEditPath: edit/master/docs
|
||||
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.13. After the installation of the required tools you need to get the sources:
|
||||
|
||||
{{< highlight txt >}}
|
||||
git clone https://github.com/owncloud/ocis-proxy.git
|
||||
cd ocis-proxy
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-proxy -h` to see all available options and subcommands.
|
||||
134
docs/extensions/proxy/configuration.md
Normal file
134
docs/extensions/proxy/configuration.md
Normal file
@@ -0,0 +1,134 @@
|
||||
---
|
||||
title: "Configuration"
|
||||
date: "2020-09-21T13:14:51+0200"
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis-proxy
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: configuration.md
|
||||
---
|
||||
|
||||
{{< 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.
|
||||
|
||||
### Configuration using config files
|
||||
|
||||
Out of the box extensions will attempt to read configuration details from:
|
||||
|
||||
```console
|
||||
/etc/ocis
|
||||
$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 ...`*.
|
||||
|
||||
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`.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
|
||||
|
||||
## Root Command
|
||||
|
||||
proxy for Reva/oCIS
|
||||
|
||||
Usage: `ocis-proxy [global options] command [command options] [arguments...]`
|
||||
|
||||
--config-file | $PROXY_CONFIG_FILE
|
||||
: Path to config file.
|
||||
|
||||
--log-level | $PROXY_LOG_LEVEL
|
||||
: Set logging level. Default: `info`.
|
||||
|
||||
--log-pretty | $PROXY_LOG_PRETTY
|
||||
: Enable pretty logging. Default: `true`.
|
||||
|
||||
--log-color | $PROXY_LOG_COLOR
|
||||
: Enable colored logging. Default: `true`.
|
||||
|
||||
## Sub Commands
|
||||
|
||||
### ocis-proxy health
|
||||
|
||||
Check health status
|
||||
|
||||
Usage: `ocis-proxy health [command options] [arguments...]`
|
||||
|
||||
--debug-addr | $PROXY_DEBUG_ADDR
|
||||
: Address to debug endpoint. Default: `0.0.0.0:9109`.
|
||||
|
||||
### ocis-proxy server
|
||||
|
||||
Start integrated server
|
||||
|
||||
Usage: `ocis-proxy server [command options] [arguments...]`
|
||||
|
||||
--tracing-enabled | $PROXY_TRACING_ENABLED
|
||||
: Enable sending traces.
|
||||
|
||||
--tracing-type | $PROXY_TRACING_TYPE
|
||||
: Tracing backend type. Default: `jaeger`.
|
||||
|
||||
--tracing-endpoint | $PROXY_TRACING_ENDPOINT
|
||||
: Endpoint for the agent.
|
||||
|
||||
--tracing-collector | $PROXY_TRACING_COLLECTOR
|
||||
: Endpoint for the collector. Default: `http://localhost:14268/api/traces`.
|
||||
|
||||
--tracing-service | $PROXY_TRACING_SERVICE
|
||||
: Service name for tracing. Default: `proxy`.
|
||||
|
||||
--debug-addr | $PROXY_DEBUG_ADDR
|
||||
: Address to bind debug server. Default: `0.0.0.0:9205`.
|
||||
|
||||
--debug-token | $PROXY_DEBUG_TOKEN
|
||||
: Token to grant metrics access.
|
||||
|
||||
--debug-pprof | $PROXY_DEBUG_PPROF
|
||||
: Enable pprof debugging.
|
||||
|
||||
--debug-zpages | $PROXY_DEBUG_ZPAGES
|
||||
: Enable zpages debugging.
|
||||
|
||||
--http-addr | $PROXY_HTTP_ADDR
|
||||
: Address to bind http server. Default: `0.0.0.0:9200`.
|
||||
|
||||
--http-root | $PROXY_HTTP_ROOT
|
||||
: Root path of http server. Default: `/`.
|
||||
|
||||
--asset-path | $PROXY_ASSET_PATH
|
||||
: Path to custom assets.
|
||||
|
||||
--http-namespace | $PROXY_HTTP_NAMESPACE
|
||||
: Set the base namespace for the http namespace. Default: `com.owncloud`.
|
||||
|
||||
--transport-tls-cert | $PROXY_TRANSPORT_TLS_CERT
|
||||
: Certificate file for transport encryption.
|
||||
|
||||
--transport-tls-key | $PROXY_TRANSPORT_TLS_KEY
|
||||
: Secret file for transport encryption.
|
||||
|
||||
--tls | $PROXY_TLS
|
||||
: Use TLS (disable only if proxy is behind a TLS-terminating reverse-proxy).. Default: `true`.
|
||||
|
||||
--jwt-secret | $PROXY_JWT_SECRET
|
||||
: Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `Pive-Fumkiu4`.
|
||||
|
||||
--reva-gateway-addr | $PROXY_REVA_GATEWAY_ADDR
|
||||
: REVA Gateway Endpoint. Default: `127.0.0.1:9142`.
|
||||
|
||||
--oidc-issuer | $PROXY_OIDC_ISSUER
|
||||
: OIDC issuer. Default: `https://localhost:9200`.
|
||||
|
||||
--oidc-insecure | $PROXY_OIDC_INSECURE
|
||||
: OIDC allow insecure communication. Default: `true`.
|
||||
|
||||
46
docs/extensions/proxy/getting-started.md
Normal file
46
docs/extensions/proxy/getting-started.md
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 15
|
||||
geekdocRepo: https://github.com/owncloud/ocis-proxy
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
Docker images for ocis-reva are hosted on https://hub.docker.com/r/owncloud/ocis-proxy.
|
||||
|
||||
The `latest` tag always reflects the current master branch.
|
||||
|
||||
```console
|
||||
docker pull owncloud/ocis-proxy
|
||||
```
|
||||
|
||||
### Binaries
|
||||
|
||||
The pre-built binaries for different platforms are downloadable at https://download.owncloud.com/ocis/ocis-proxy/ . 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/ocis-proxy/testing/
|
||||
|
||||
```console
|
||||
curl https://download.owncloud.com/ocis/ocis-proxy/1.0.0-beta1/ocis-proxy-1.0.0-beta1-darwin-amd64 --output ocis-proxy
|
||||
chmod +x ocis-proxy
|
||||
./ocis-proxy server
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-proxy --help`.
|
||||
|
||||
### Server
|
||||
|
||||
The server command is used to start the http server. For further help please execute:
|
||||
|
||||
{{< highlight txt >}}
|
||||
ocis-proxy server --help
|
||||
{{< / highlight >}}
|
||||
46
docs/extensions/settings/_index.md
Normal file
46
docs/extensions/settings/_index.md
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: "Settings"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-settings
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
## Abstract
|
||||
|
||||
When using oCIS, the requirement to store settings arises. This extension provides functionality
|
||||
for other extensions to register new settings within oCIS. It is responsible for storing the respective
|
||||
settings values as well.
|
||||
|
||||
For ease of use, this extension provides an ocis-web extension which allows users to change their settings values.
|
||||
Please refer to the [ocis-web extension docs](https://owncloud.github.io/ocis/extensions/#external-phoenix-apps)
|
||||
for running ocis-web extensions.
|
||||
|
||||
{{< mermaid class="text-center">}}
|
||||
graph TD
|
||||
subgraph ow[ocis-web]
|
||||
ows[ocis-web-settings]
|
||||
owc[ocis-web-core]
|
||||
end
|
||||
ows ---|"listSettingsBundles(),<br>saveSettingsValue(value)"| os[ocis-settings]
|
||||
owc ---|"listSettingsValues()"| sdk[oC SDK]
|
||||
sdk --- sdks{ocis-settings<br>available?}
|
||||
sdks ---|"yes"| os
|
||||
sdks ---|"no"| defaults[Use set of<br>default values]
|
||||
oa[oCIS extensions<br>e.g. ocis-accounts] ---|"saveSettingsBundle(bundle)"| os
|
||||
{{< /mermaid >}}
|
||||
|
||||
The diagram shows how the settings service integrates into oCIS:
|
||||
|
||||
**Settings management:**
|
||||
- oCIS extensions can register *settings bundles* with the ocis-settings service.
|
||||
- The settings frontend can be plugged into ocis-web, showing forms for changing *settings values* as a user.
|
||||
The forms are generated from the registered *settings bundles*.
|
||||
|
||||
**Settings usage:**
|
||||
- Extensions can query ocis-settings for *settings values* of a user.
|
||||
- The ownCloud SDK, used as a data abstraction layer for ocis-web, will query ocis-settings for *settings values* of a user,
|
||||
if it's available. The SDK uses sensible defaults when ocis-settings is not part of the setup.
|
||||
|
||||
For compatibility with ownCloud 10, a migration of ownCloud 10 settings into the storage of ocis-settings will be available.
|
||||
28
docs/extensions/settings/building.md
Normal file
28
docs/extensions/settings/building.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-settings
|
||||
geekdocEditPath: edit/master/docs
|
||||
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-settings.git
|
||||
cd ocis-settings
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-settings -h` to see all available options.
|
||||
75
docs/extensions/settings/bundles.md
Normal file
75
docs/extensions/settings/bundles.md
Normal file
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: "Settings Bundles"
|
||||
date: 2020-05-04T00:00:00+00:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/owncloud/ocis-settings
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: bundles.md
|
||||
---
|
||||
|
||||
A **Settings Bundle** is a collection of settings, uniquely identified by the key of the
|
||||
extension registering the bundle and the key of the bundle itself. It's purpose is to let
|
||||
oCIS extensions define settings and make them available to users. They are dynamically
|
||||
rendered into forms, available in the frontend.
|
||||
|
||||
As of now we support five different types of settings:
|
||||
- boolean
|
||||
- integer
|
||||
- string
|
||||
- single choice list of integers or strings
|
||||
- multiple choice list of integers or strings
|
||||
|
||||
Each **Setting** is uniquely identified by a key within the bundle. Some attributes
|
||||
depend on the chosen type of setting. Through the information provided with the
|
||||
attributes of the setting, the settings frontend dynamically renders form elements,
|
||||
allowing users to change their settings individually.
|
||||
|
||||
## Example
|
||||
|
||||
```json
|
||||
{
|
||||
"identifier": {
|
||||
"extension": "ocis-accounts",
|
||||
"bundleKey": "profile"
|
||||
},
|
||||
"displayName": "Profile",
|
||||
"settings": [
|
||||
{
|
||||
"settingKey": "lastname",
|
||||
"displayName": "Lastname",
|
||||
"description": "Input for lastname",
|
||||
"stringValue": {
|
||||
"placeholder": "Set lastname"
|
||||
}
|
||||
},
|
||||
{
|
||||
"settingKey": "age",
|
||||
"displayName": "Age",
|
||||
"description": "Input for age",
|
||||
"intValue": {
|
||||
"min": "16",
|
||||
"max": "200",
|
||||
"step": "2",
|
||||
"placeholder": "Set age"
|
||||
}
|
||||
},
|
||||
{
|
||||
"settingKey": "timezone",
|
||||
"displayName": "Timezone",
|
||||
"description": "User timezone",
|
||||
"singleChoiceValue": {
|
||||
"options": [
|
||||
{
|
||||
"stringValue": "Europe/Berlin",
|
||||
"displayValue": "Europe/Berlin"
|
||||
},
|
||||
{
|
||||
"stringValue": "Asia/Kathmandu",
|
||||
"displayValue": "Asia/Kathmandu"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
272
docs/extensions/settings/getting-started.md
Normal file
272
docs/extensions/settings/getting-started.md
Normal file
@@ -0,0 +1,272 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 25
|
||||
geekdocRepo: https://github.com/owncloud/ocis-settings
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
TBD
|
||||
|
||||
### Binaries
|
||||
|
||||
TBD
|
||||
|
||||
## 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.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
SETTINGS_CONFIG_FILE
|
||||
: Path to config file, empty default value
|
||||
|
||||
SETTINGS_LOG_LEVEL
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
SETTINGS_LOG_COLOR
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
SETTINGS_LOG_PRETTY
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
SETTINGS_TRACING_ENABLED
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
SETTINGS_TRACING_TYPE
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
SETTINGS_TRACING_ENDPOINT
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
SETTINGS_TRACING_COLLECTOR
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
SETTINGS_TRACING_SERVICE
|
||||
: Service name for tracing, defaults to `settings`
|
||||
|
||||
SETTINGS_DEBUG_ADDR
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9194`
|
||||
|
||||
SETTINGS_DEBUG_TOKEN
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
SETTINGS_DEBUG_PPROF
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
SETTINGS_DEBUG_ZPAGES
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
SETTINGS_HTTP_ADDR
|
||||
: Address to bind http server, defaults to `0.0.0.0:9190`
|
||||
|
||||
SETTINGS_HTTP_NAMESPACE
|
||||
: The http namespace
|
||||
|
||||
SETTINGS_HTTP_ROOT
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
#### Health
|
||||
|
||||
SETTINGS_DEBUG_ADDR
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9194`
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
--config-file
|
||||
: Path to config file, empty default value
|
||||
|
||||
--log-level
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
--log-color
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
--log-pretty
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
--tracing-enabled
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
--tracing-type
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
--tracing-endpoint
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
--tracing-collector
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
--tracing-service
|
||||
: Service name for tracing, defaults to `settings`
|
||||
|
||||
--debug-addr
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9194`
|
||||
|
||||
--debug-token
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
--debug-pprof
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
--debug-zpages
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
--http-addr
|
||||
: Address to bind http server, defaults to `0.0.0.0:9190`
|
||||
|
||||
--http-namespace
|
||||
: Namespace for internal services communication, defaults to `com.owncloud.web`
|
||||
|
||||
--http-root
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
#### Health
|
||||
|
||||
--debug-addr
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9194`
|
||||
|
||||
### Configuration file
|
||||
|
||||
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/settings/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/settings.yml`, `${HOME}/.ocis/settings.yml` or `$(pwd)/config/settings.yml`.
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-settings --help`.
|
||||
|
||||
### Server
|
||||
|
||||
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 >}}
|
||||
ocis-settings server --help
|
||||
{{< / 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 >}}
|
||||
ocis-settings health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
## Metrics
|
||||
|
||||
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `SETTINGS_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9194/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
42
docs/extensions/settings/glossary.md
Normal file
42
docs/extensions/settings/glossary.md
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: "Glossary"
|
||||
date: 2020-05-04T12:35:00+01:00
|
||||
weight: 80
|
||||
geekdocRepo: https://github.com/owncloud/ocis-settings
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: glossary.md
|
||||
---
|
||||
|
||||
In the context of this extension and oCIS in general, we are using the following terminology.
|
||||
|
||||
### Configuration
|
||||
|
||||
- System configuration
|
||||
- e.g. service host names and ports
|
||||
- Changes need to be propagated to other services
|
||||
- Typically modified on the CLI
|
||||
|
||||
### Settings
|
||||
|
||||
- Application level settings
|
||||
- e.g. default language
|
||||
- Can be modified at runtime without restarting the service
|
||||
- Typically modified in the UI
|
||||
|
||||
### Preferences
|
||||
|
||||
- User settings
|
||||
- Subset of "Settings"
|
||||
- e.g. preferred language of a user
|
||||
|
||||
### Settings Bundle
|
||||
|
||||
- Collection of related settings
|
||||
- Registered by an ocis extension
|
||||
|
||||
### Settings Value
|
||||
|
||||
- Manifestation of a setting for a specific user
|
||||
- E.g. used for customization (at runtime) in `ocis-web`
|
||||
- `ocis-web-settings` extension for modifying settings values is provided by this service
|
||||
- Can be queried and modified by other ocis extensions
|
||||
10
docs/extensions/settings/license.md
Normal file
10
docs/extensions/settings/license.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 90
|
||||
geekdocRepo: https://github.com/owncloud/ocis-settings
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: license.md
|
||||
---
|
||||
|
||||
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/settings/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
|
||||
75
docs/extensions/settings/values.md
Normal file
75
docs/extensions/settings/values.md
Normal file
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: "Settings Values"
|
||||
date: 2020-05-04T00:00:00+00:00
|
||||
weight: 51
|
||||
geekdocRepo: https://github.com/owncloud/ocis-settings
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: values.md
|
||||
---
|
||||
|
||||
A **Settings Value** is the value an authenticated user has chosen for a specific setting, defined in a
|
||||
*settings bundle*. For choosing settings values as a user the sole entry point is the ocis-web extension
|
||||
provided by this service.
|
||||
|
||||
## Identifying settings values
|
||||
|
||||
A *settings value* is uniquely identified by four attributes. Three of them are coming from the definition of
|
||||
the setting within it's settings bundle (see [Settings Bundles](https://owncloud.github.io/extensions/ocis_settings/bundles/)
|
||||
for an example). The fourth identifies the user.
|
||||
- extension: Key of the extension that registered the settings bundle,
|
||||
- bundleKey: Key of the settings bundle,
|
||||
- settingKey: Key of the setting as defined within the bundle,
|
||||
- accountUuid: The UUID of the authenticated user who has saved the setting.
|
||||
|
||||
{{< hint info >}}
|
||||
When requests are going through `ocis-proxy`, the accountUuid attribute can be set to the static keyword `me`
|
||||
instead of using a real UUID. `ocis-proxy` will take care of minting the UUID of the authenticated user into
|
||||
a JWT, providing it in the HTTP header as `x-access-token`. That UUID is then used in this service, to replace
|
||||
`me` with the actual UUID of the authenticated user.
|
||||
{{< /hint >}}
|
||||
|
||||
## Example of stored settings values
|
||||
|
||||
```json
|
||||
{
|
||||
"values": {
|
||||
"language": {
|
||||
"identifier": {
|
||||
"extension": "ocis-accounts",
|
||||
"bundleKey": "profile",
|
||||
"settingKey": "language",
|
||||
"accountUuid": "5681371f-4a6e-43bc-8bb5-9c9237fa9c58"
|
||||
},
|
||||
"listValue": {
|
||||
"values": [
|
||||
{
|
||||
"stringValue": "de"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"timezone": {
|
||||
"identifier": {
|
||||
"extension": "ocis-accounts",
|
||||
"bundleKey": "profile",
|
||||
"settingKey": "timezone",
|
||||
"accountUuid": "5681371f-4a6e-43bc-8bb5-9c9237fa9c58"
|
||||
},
|
||||
"listValue": {
|
||||
"values": [
|
||||
{
|
||||
"stringValue": "Europe/Berlin"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## gRPC endpoints
|
||||
The obvious way of modifying settings is the ocis-web extension, as described earlier. However, services can
|
||||
use the respective gRPC endpoints of the `ValueService` to query and modify *settings values* as well.
|
||||
The gRPC endpoints require the same identifier attributes as described above, so for making a request to
|
||||
the `ValueService` you will have to make sure that the accountUuid of the authenticated user is available in
|
||||
your service at the time of the request.
|
||||
10
docs/extensions/store/_index.md
Normal file
10
docs/extensions/store/_index.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Store"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-store
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
This service provides ...
|
||||
28
docs/extensions/store/building.md
Normal file
28
docs/extensions/store/building.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-store
|
||||
geekdocEditPath: edit/master/docs
|
||||
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-store.git
|
||||
cd ocis-store
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-store -h` to see all available options.
|
||||
272
docs/extensions/store/getting-started.md
Normal file
272
docs/extensions/store/getting-started.md
Normal file
@@ -0,0 +1,272 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis-store
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
TBD
|
||||
|
||||
### Binaries
|
||||
|
||||
TBD
|
||||
|
||||
## 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.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
STORE_CONFIG_FILE
|
||||
: Path to config file, empty default value
|
||||
|
||||
STORE_LOG_LEVEL
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
STORE_LOG_COLOR
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
STORE_LOG_PRETTY
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
STORE_TRACING_ENABLED
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
STORE_TRACING_TYPE
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
STORE_TRACING_ENDPOINT
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
STORE_TRACING_COLLECTOR
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
STORE_TRACING_SERVICE
|
||||
: Service name for tracing, defaults to `store`
|
||||
|
||||
STORE_DEBUG_ADDR
|
||||
: Address to bind debug server
|
||||
|
||||
STORE_DEBUG_TOKEN
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
STORE_DEBUG_PPROF
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
STORE_DEBUG_ZPAGES
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
STORE_HTTP_ADDR
|
||||
: Address to bind http server, defaults to `0.0.0.0:9461`
|
||||
|
||||
STORE_HTTP_NAMESPACE
|
||||
: The http namespace
|
||||
|
||||
STORE_HTTP_ROOT
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
#### Health
|
||||
|
||||
STORE_DEBUG_ADDR
|
||||
: Address to debug endpoint
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
--config-file
|
||||
: Path to config file, empty default value
|
||||
|
||||
--log-level
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
--log-color
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
--log-pretty
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
--tracing-enabled
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
--tracing-type
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
--tracing-endpoint
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
--tracing-collector
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
--tracing-service
|
||||
: Service name for tracing, defaults to `store`
|
||||
|
||||
--debug-addr
|
||||
: Address to bind debug server
|
||||
|
||||
--debug-token
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
--debug-pprof
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
--debug-zpages
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
--http-addr
|
||||
: Address to bind http server, defaults to `0.0.0.0:9461`
|
||||
|
||||
--http-namespace
|
||||
: Namespace for internal services communication, defaults to `com.owncloud.web`
|
||||
|
||||
--http-root
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
#### Health
|
||||
|
||||
--debug-addr
|
||||
: Address to debug endpoint
|
||||
|
||||
### Configuration file
|
||||
|
||||
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/store/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/store.yml`, `${HOME}/.ocis/store.yml` or `$(pwd)/config/store.yml`.
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-store --help`.
|
||||
|
||||
### Server
|
||||
|
||||
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 >}}
|
||||
ocis-store server --help
|
||||
{{< / 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 >}}
|
||||
ocis-store health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
## Metrics
|
||||
|
||||
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `STORE_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9460/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
10
docs/extensions/store/license.md
Normal file
10
docs/extensions/store/license.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 40
|
||||
geekdocRepo: https://github.com/owncloud/ocis-store
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: license.md
|
||||
---
|
||||
|
||||
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/store/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
|
||||
10
docs/extensions/thumbnails/_index.md
Normal file
10
docs/extensions/thumbnails/_index.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "Thumbnails"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 10
|
||||
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: _index.md
|
||||
---
|
||||
|
||||
This service provides an ocis extensions which generates thumbnails for image files.
|
||||
28
docs/extensions/thumbnails/building.md
Normal file
28
docs/extensions/thumbnails/building.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 30
|
||||
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
|
||||
geekdocEditPath: edit/master/docs
|
||||
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-thubnails.git
|
||||
cd {{ Name }}
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-thumbnails -h` to see all available options.
|
||||
290
docs/extensions/thumbnails/getting-started.md
Normal file
290
docs/extensions/thumbnails/getting-started.md
Normal file
@@ -0,0 +1,290 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 20
|
||||
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: getting-started.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
TBD
|
||||
|
||||
### Binaries
|
||||
|
||||
TBD
|
||||
|
||||
## 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.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
THUMBNAILS_CONFIG_FILE
|
||||
: Path to config file, empty default value
|
||||
|
||||
THUMBNAILS_LOG_LEVEL
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
THUMBNAILS_LOG_COLOR
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
THUMBNAILS_LOG_PRETTY
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
THUMBNAILS_TRACING_ENABLED
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
THUMBNAILS_TRACING_TYPE
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
THUMBNAILS_TRACING_ENDPOINT
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
THUMBNAILS_TRACING_COLLECTOR
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
THUMBNAILS_TRACING_SERVICE
|
||||
: Service name for tracing, defaults to `ocis-thumbnails`
|
||||
|
||||
THUMBNAILS_DEBUG_ADDR
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9114`
|
||||
|
||||
THUMBNAILS_DEBUG_TOKEN
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
THUMBNAILS_DEBUG_PPROF
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
THUMBNAILS_DEBUG_ZPAGES
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
THUMBNAILS_GRPC_NAME
|
||||
: Name of the service, defaults to `thumbnails`
|
||||
|
||||
THUMBNAILS_GRPC_ADDR
|
||||
: Address to bind grpc server, defaults to `0.0.0.0:9185`
|
||||
|
||||
THUMBNAILS_GRPC_NAMESPACE
|
||||
: Set the base namespace for the grpc namespace", defaults to `com.owncloud.api`
|
||||
|
||||
THUMBNAILS_FILESYSTEMSTORAGE_ROOT
|
||||
: Root path of the filesystem storage directory, defaults to `<os tempdir>/ocis-thumbnails/`
|
||||
|
||||
THUMBNAILS_WEBDAVSOURCE_BASEURL
|
||||
: Base url for a webdav api, defaults to `https://localhost:9200/remote.php/webdav/`
|
||||
|
||||
THUMBNAILS_RESOLUTIONS
|
||||
: List of resolutions supported by the service, defaults to `["16x16", "32x32", "64x64", "128x128"]
|
||||
|
||||
#### Health
|
||||
|
||||
THUMBNAILS_DEBUG_ADDR
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9189`
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
--config-file
|
||||
: Path to config file, empty default value
|
||||
|
||||
--log-level
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
--log-color
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
--log-pretty
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
--tracing-enabled
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
--tracing-type
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
--tracing-endpoint
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
--tracing-collector
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
--tracing-service
|
||||
: Service name for tracing, defaults to `thumbnails`
|
||||
|
||||
--debug-addr
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9189`
|
||||
|
||||
--debug-token
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
--debug-pprof
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
--debug-zpages
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
--grpc-name
|
||||
: Name of the service, defaults to `thumbnails`
|
||||
|
||||
--grpc-addr
|
||||
: Address to bind grpc server, defaults to `0.0.0.0:9185`
|
||||
|
||||
--grpc-namespace
|
||||
: Set the base namespace for the grpc namespace", defaults to `com.owncloud.api`
|
||||
|
||||
--filesystemstorage-root
|
||||
: Root path of the filesystem storage directory, defaults to `<os tempdir>/ocis-thumbnails/`
|
||||
|
||||
--webdavsource-baseurl
|
||||
: Base url for a webdav api, defaults to `https://localhost:9200/remote.php/webdav/`
|
||||
|
||||
--thumbnail-resolution
|
||||
: List of resolutions supported by the service, defaults to `["16x16", "32x32", "64x64", "128x128"]
|
||||
|
||||
#### Health
|
||||
|
||||
--debug-addr
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9189`
|
||||
|
||||
### Configuration file
|
||||
|
||||
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/thumbnails/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/thumbnails.yml`, `${HOME}/.ocis/thumbnails.yml` or `$(pwd)/config/thumbnails.yml`.
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-thumbnails --help`.
|
||||
|
||||
### Server
|
||||
|
||||
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 >}}
|
||||
{{ Name }} server --help
|
||||
{{< / 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 >}}
|
||||
{{ Name }} health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
## Metrics
|
||||
|
||||
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `THUMBNAILS_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9114/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
71
docs/extensions/thumbnails/grpc.md
Normal file
71
docs/extensions/thumbnails/grpc.md
Normal file
@@ -0,0 +1,71 @@
|
||||
---
|
||||
title: "GRPC API"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 50
|
||||
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: grpc.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
## pkg/proto/v0/thumbnails.proto
|
||||
|
||||
### GetRequest
|
||||
|
||||
A request to retrieve a thumbnail
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| filepath | [string](#string) | | The path to the source image |
|
||||
| filetype | [GetRequest.FileType](#getrequestfiletype) | | The type to which the thumbnail should get encoded to. |
|
||||
| etag | [string](#string) | | The etag of the source image |
|
||||
| width | [int32](#int32) | | The width of the thumbnail |
|
||||
| height | [int32](#int32) | | The height of the thumbnail |
|
||||
| authorization | [string](#string) | | The authorization token |
|
||||
|
||||
### GetResponse
|
||||
|
||||
The service response
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| thumbnail | [bytes](#bytes) | | The thumbnail as a binary |
|
||||
| mimetype | [string](#string) | | The mimetype of the thumbnail |
|
||||
|
||||
### GetRequest.FileType
|
||||
|
||||
The file types to which the thumbnail cna get encoded to.
|
||||
|
||||
| Name | Number | Description |
|
||||
| ---- | ------ | ----------- |
|
||||
| PNG | 0 | Represents PNG type |
|
||||
| JPG | 1 | Represents JPG type |
|
||||
|
||||
### ThumbnailService
|
||||
|
||||
A Service for handling thumbnail generation
|
||||
|
||||
| Method Name | Request Type | Response Type | Description |
|
||||
| ----------- | ------------ | ------------- | ------------|
|
||||
| GetThumbnail | [GetRequest](#getrequest) | [GetResponse](#getresponse) | Generates the thumbnail and returns it. |
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ | Java |
|
||||
| ----------- | ----- | --- | ---- |
|
||||
| {{< div id="double" content="double" >}} | | double | double |
|
||||
| {{< div id="float" content="float" >}} | | float | float |
|
||||
| {{< div id="int32" content="int32" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int |
|
||||
| {{< div id="int64" content="int64" >}} | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long |
|
||||
| {{< div id="uint32" content="uint32" >}} | Uses variable-length encoding. | uint32 | int |
|
||||
| {{< div id="uint64" content="uint64" >}} | Uses variable-length encoding. | uint64 | long |
|
||||
| {{< div id="sint32" content="sint32" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int |
|
||||
| {{< div id="sint64" content="sint64" >}} | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long |
|
||||
| {{< div id="fixed32" content="fixed32" >}} | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int |
|
||||
| {{< div id="fixed64" content="fixed64" >}} | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long |
|
||||
| {{< div id="sfixed32" content="sfixed32" >}} | Always four bytes. | int32 | int |
|
||||
| {{< div id="sfixed64" content="sfixed64" >}} | Always eight bytes. | int64 | long |
|
||||
| {{< div id="bool" content="bool" >}} | | bool | boolean |
|
||||
| {{< div id="string" content="string" >}} | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String |
|
||||
| {{< div id="bytes" content="bytes" >}} | May contain any arbitrary sequence of bytes. | string | ByteString |
|
||||
10
docs/extensions/thumbnails/license.md
Normal file
10
docs/extensions/thumbnails/license.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 60
|
||||
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: license.md
|
||||
---
|
||||
|
||||
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/thumbnails/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
|
||||
45
docs/extensions/thumbnails/releasing.md
Normal file
45
docs/extensions/thumbnails/releasing.md
Normal file
@@ -0,0 +1,45 @@
|
||||
---
|
||||
title: "Releasing"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
weight: 40
|
||||
geekdocRepo: https://github.com/owncloud/ocis-thumbnails
|
||||
geekdocEditPath: edit/master/docs
|
||||
geekdocFilePath: releasing.md
|
||||
---
|
||||
|
||||
{{< toc >}}
|
||||
|
||||
To release a new version of ocis-thumbnails, you have to follow a few simple steps.
|
||||
|
||||
## Preperation
|
||||
|
||||
1. Create a new branch e.g. `release-x.x.x` where `x.x.x` is the version you want to release.
|
||||
2. Checkout the preparation branch.
|
||||
3. Create a new changelog folder and move the unreleased snippets there.
|
||||
{{< highlight txt >}}
|
||||
mkdir changelog/x.x.x_yyyy-MM-dd/ # yyyy-MM-dd is the current date
|
||||
mv changelog/unreleased/* changelog/x.x.x_yyyy-MM-dd/
|
||||
{{< / highlight >}}
|
||||
4. Commit and push the changes
|
||||
{{< highlight txt >}}
|
||||
git add --all
|
||||
git commit -m "prepare release x.x.x"
|
||||
git push
|
||||
{{< / highlight >}}
|
||||
5. Create a pull request to the master branch.
|
||||
|
||||
## Release
|
||||
1. After the preparation branch has been merged update your local master.
|
||||
{{< highlight txt >}}
|
||||
git checkout master
|
||||
git pull
|
||||
{{< / highlight >}}
|
||||
2. Create a new tag (preferably signed).
|
||||
{{< highlight txt >}}
|
||||
git tag -s vx.x.x -m "release vx.x.x"
|
||||
git push --tags
|
||||
{{< / highlight >}}
|
||||
3. Wait for CI and check that the GitHub release was published.
|
||||
|
||||
|
||||
Congratulations, you just released ocis-thumbnails!
|
||||
1
docs/extensions/webdav/.gitignore
vendored
Normal file
1
docs/extensions/webdav/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
public/
|
||||
6
docs/extensions/webdav/archetypes/default.md
Normal file
6
docs/extensions/webdav/archetypes/default.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
anchor: "{{ replace .TranslationBaseName "-" " " | title | urlize }}"
|
||||
weight:
|
||||
---
|
||||
18
docs/extensions/webdav/config.toml
Normal file
18
docs/extensions/webdav/config.toml
Normal file
@@ -0,0 +1,18 @@
|
||||
baseURL = "https://owncloud.github.io/ocis-webdav/"
|
||||
languageCode = "en-us"
|
||||
title = "ownCloud Infinite Scale: WebDAV"
|
||||
pygmentsUseClasses = true
|
||||
|
||||
disableKinds = ["taxonomy", "taxonomyTerm", "RSS", "sitemap"]
|
||||
|
||||
[blackfriday]
|
||||
angledQuotes = true
|
||||
fractions = false
|
||||
plainIDAnchors = true
|
||||
smartlists = true
|
||||
extensions = ["hardLineBreak"]
|
||||
|
||||
[params]
|
||||
author = "ownCloud GmbH"
|
||||
description = "Serve WebDAV API for oCIS"
|
||||
keywords = "reva, ocis"
|
||||
8
docs/extensions/webdav/content/about.md
Normal file
8
docs/extensions/webdav/content/about.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "About"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "about"
|
||||
weight: 10
|
||||
---
|
||||
|
||||
This service provides the WebDAV API which is required by some ownCloud clients.
|
||||
24
docs/extensions/webdav/content/building.md
Normal file
24
docs/extensions/webdav/content/building.md
Normal file
@@ -0,0 +1,24 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "building"
|
||||
weight: 30
|
||||
---
|
||||
|
||||
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-webdav.git
|
||||
cd ocis-webdav
|
||||
{{< / 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 >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-webdav -h` to see all available options.
|
||||
265
docs/extensions/webdav/content/getting-started.md
Normal file
265
docs/extensions/webdav/content/getting-started.md
Normal file
@@ -0,0 +1,265 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "getting-started"
|
||||
weight: 20
|
||||
---
|
||||
|
||||
### Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
#### Docker
|
||||
|
||||
TBD
|
||||
|
||||
#### Binaries
|
||||
|
||||
TBD
|
||||
|
||||
### 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.
|
||||
|
||||
#### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
##### Global
|
||||
|
||||
WEBDAV_CONFIG_FILE
|
||||
: Path to config file, empty default value
|
||||
|
||||
WEBDAV_LOG_LEVEL
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
WEBDAV_LOG_COLOR
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
WEBDAV_LOG_PRETTY
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
##### Server
|
||||
|
||||
WEBDAV_TRACING_ENABLED
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
WEBDAV_TRACING_TYPE
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
WEBDAV_TRACING_ENDPOINT
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
WEBDAV_TRACING_COLLECTOR
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
WEBDAV_TRACING_SERVICE
|
||||
: Service name for tracing, defaults to `webdav`
|
||||
|
||||
WEBDAV_DEBUG_ADDR
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9119`
|
||||
|
||||
WEBDAV_DEBUG_TOKEN
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
WEBDAV_DEBUG_PPROF
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
WEBDAV_DEBUG_ZPAGES
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
WEBDAV_HTTP_ADDR
|
||||
: Address to bind http server, defaults to `0.0.0.0:9115`
|
||||
|
||||
WEBDAV_HTTP_ROOT
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
##### Health
|
||||
|
||||
WEBDAV_DEBUG_ADDR
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9119`
|
||||
|
||||
#### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below.
|
||||
|
||||
##### Global
|
||||
|
||||
--config-file
|
||||
: Path to config file, empty default value
|
||||
|
||||
--log-level
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
--log-color
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
--log-pretty
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
##### Server
|
||||
|
||||
--tracing-enabled
|
||||
: Enable sending traces, defaults to `false`
|
||||
|
||||
--tracing-type
|
||||
: Tracing backend type, defaults to `jaeger`
|
||||
|
||||
--tracing-endpoint
|
||||
: Endpoint for the agent, empty default value
|
||||
|
||||
--tracing-collector
|
||||
: Endpoint for the collector, empty default value
|
||||
|
||||
--tracing-service
|
||||
: Service name for tracing, defaults to `webdav`
|
||||
|
||||
--debug-addr
|
||||
: Address to bind debug server, defaults to `0.0.0.0:9119`
|
||||
|
||||
--debug-token
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
--debug-pprof
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
--debug-zpages
|
||||
: Enable zpages debugging, defaults to `false`
|
||||
|
||||
--http-addr
|
||||
: Address to bind http server, defaults to `0.0.0.0:9115`
|
||||
|
||||
--http-namespace
|
||||
: Namespace for internal services communication, defaults to `com.owncloud.web`
|
||||
|
||||
--http-root
|
||||
: Root path of http server, defaults to `/`
|
||||
|
||||
##### Health
|
||||
|
||||
--debug-addr
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:9119`
|
||||
|
||||
#### Configuration file
|
||||
|
||||
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/webdav/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/webdav.yml`, `${HOME}/.ocis/webdav.yml` or `$(pwd)/config/webdav.yml`.
|
||||
|
||||
### Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-webdav --help`.
|
||||
|
||||
#### Server
|
||||
|
||||
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 >}}
|
||||
ocis-webdav server --help
|
||||
{{< / 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 >}}
|
||||
ocis-webdav health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
### Metrics
|
||||
|
||||
This service provides some [Prometheus](https://prometheus.io/) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `WEBDAV_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:9119/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
8
docs/extensions/webdav/content/license.md
Normal file
8
docs/extensions/webdav/content/license.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "license"
|
||||
weight: 40
|
||||
---
|
||||
|
||||
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/webdav/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
|
||||
0
docs/extensions/webdav/layouts/_default/list.html
Normal file
0
docs/extensions/webdav/layouts/_default/list.html
Normal file
0
docs/extensions/webdav/layouts/_default/single.html
Normal file
0
docs/extensions/webdav/layouts/_default/single.html
Normal file
57
docs/extensions/webdav/layouts/index.html
Normal file
57
docs/extensions/webdav/layouts/index.html
Normal file
@@ -0,0 +1,57 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html id="html" lang="{{ with .Site.LanguageCode }}{{ . }}{{ else }}en-US{{ end }}">
|
||||
<head>
|
||||
<meta http-equiv="content-type" content="text/html;charset=utf-8">
|
||||
<meta name="viewport" content="width=device-width"/>
|
||||
|
||||
<title>
|
||||
{{ .Site.Title }}
|
||||
</title>
|
||||
|
||||
<meta name="description" content="{{ with .Site.Params.description }}{{ . }}{{ end }}">
|
||||
<meta name="author" content="{{ with .Site.Params.author }}{{ . }}{{ end }}">
|
||||
|
||||
{{ partial "style.html" . }}
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<section id="Menu">
|
||||
<header>
|
||||
<h1>
|
||||
{{ .Site.Title }}
|
||||
</h1>
|
||||
|
||||
<p>
|
||||
{{ .Site.Params.description }}
|
||||
</p>
|
||||
</header>
|
||||
|
||||
<nav>
|
||||
{{ range .Data.Pages.ByWeight }}
|
||||
<a href="#{{ .Params.anchor }}">
|
||||
{{ .Title }}
|
||||
</a>
|
||||
{{ end }}
|
||||
</nav>
|
||||
</section>
|
||||
|
||||
{{ range .Data.Pages.ByWeight }}
|
||||
<section id="{{ .Params.anchor }}">
|
||||
<h2>
|
||||
<a href="#{{ .Params.anchor }}">
|
||||
{{ .Title }}
|
||||
</a>
|
||||
|
||||
<small>
|
||||
<a href="#html">
|
||||
Back to Top
|
||||
</a>
|
||||
</small>
|
||||
</h2>
|
||||
|
||||
{{ .Content | markdownify }}
|
||||
</section>
|
||||
{{ end }}
|
||||
</body>
|
||||
</html>
|
||||
2
docs/extensions/webdav/layouts/partials/style.html
Normal file
2
docs/extensions/webdav/layouts/partials/style.html
Normal file
@@ -0,0 +1,2 @@
|
||||
<link rel="stylesheet" href="syntax.css" />
|
||||
<link rel="stylesheet" href="styles.css" />
|
||||
338
docs/extensions/webdav/static/styles.css
Normal file
338
docs/extensions/webdav/static/styles.css
Normal file
@@ -0,0 +1,338 @@
|
||||
body,
|
||||
html {
|
||||
cursor: default;
|
||||
}
|
||||
|
||||
body,
|
||||
div,
|
||||
dl,
|
||||
dt,
|
||||
dd,
|
||||
ul,
|
||||
ol,
|
||||
li,
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6,
|
||||
pre,
|
||||
form,
|
||||
fieldset,
|
||||
input,
|
||||
textarea,
|
||||
p,
|
||||
blockquote,
|
||||
th,
|
||||
td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
* {
|
||||
-webkit-box-sizing: border-box;
|
||||
-moz-box-sizing: border-box;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
:before,
|
||||
:after {
|
||||
-webkit-box-sizing: border-box;
|
||||
-moz-box-sizing: border-box;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
img,
|
||||
object,
|
||||
embed {
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
object,
|
||||
embed {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
img {
|
||||
margin: 1.25% 0;
|
||||
-ms-interpolation-mode: bicubic;
|
||||
}
|
||||
|
||||
html {
|
||||
background-color: #F0F1F3;
|
||||
padding: 2%;
|
||||
}
|
||||
|
||||
body {
|
||||
font-size: 16px;
|
||||
line-height: 1.6;
|
||||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
|
||||
color: #242424;
|
||||
max-width: 800px;
|
||||
margin: 5% auto;
|
||||
}
|
||||
|
||||
body::after {
|
||||
clear: both;
|
||||
content: "";
|
||||
display: table;
|
||||
}
|
||||
|
||||
header {
|
||||
margin-bottom: 8%;
|
||||
}
|
||||
|
||||
footer {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h2 a {
|
||||
color: #263A48;
|
||||
font-weight: 500;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2 {
|
||||
font-size: 36px;
|
||||
padding-bottom: 0.3em;
|
||||
margin-bottom: 0.4em;
|
||||
border-bottom: 1px solid #eee
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 22px;
|
||||
padding-bottom: 0.6em;
|
||||
margin-bottom: 0.6em;
|
||||
margin-top: 2.5em;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 18px;
|
||||
margin-bottom: 0.3em;
|
||||
}
|
||||
|
||||
h2 small a {
|
||||
color: #98999C;
|
||||
font-size: 15px;
|
||||
font-weight: normal;
|
||||
float: right;
|
||||
position: absolute;
|
||||
top: 15px;
|
||||
right: 20px;
|
||||
}
|
||||
|
||||
section {
|
||||
background: #fff;
|
||||
margin-bottom: 1%;
|
||||
position: relative;
|
||||
padding: 6% 8%;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
border-left: 3px solid #d54e21;
|
||||
font-size: 16px;
|
||||
padding: 0 0 0 20px;
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
blockquote a {
|
||||
color: #d54e21;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
blockquote code {
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
.highlight pre {
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
.highlight {
|
||||
margin-bottom: 4%;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #1e8cbe;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
ol {
|
||||
list-style: number;
|
||||
}
|
||||
|
||||
ol li {
|
||||
color: #98999C;
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
ol li:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p,
|
||||
ul,
|
||||
ol,
|
||||
blockquote {
|
||||
margin-bottom: 4%;
|
||||
}
|
||||
|
||||
ul ul {
|
||||
padding-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 4%;
|
||||
}
|
||||
|
||||
ul ul li:before {
|
||||
content: '-';
|
||||
display: inline-block;
|
||||
padding-right: 2%;
|
||||
}
|
||||
|
||||
ul.col-2 {
|
||||
color: #98999C;
|
||||
-webkit-column-count: 2;
|
||||
-moz-column-count: 2;
|
||||
column-count: 2;
|
||||
-webkit-column-gap: 20px;
|
||||
-moz-column-gap: 20px;
|
||||
column-gap: 20px;
|
||||
}
|
||||
|
||||
dl dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
dl dd {
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
@media screen and (min-width: 500px) {
|
||||
ul.col-2 {
|
||||
-webkit-column-count: 3;
|
||||
-moz-column-count: 3;
|
||||
column-count: 3;
|
||||
-webkit-column-gap: 20px;
|
||||
-moz-column-gap: 20px;
|
||||
column-gap: 20px;
|
||||
}
|
||||
}
|
||||
|
||||
nav {
|
||||
background: #F0F1F3;
|
||||
min-width: 215px;
|
||||
margin-bottom: 5px;
|
||||
margin-top: 15px;
|
||||
}
|
||||
|
||||
nav:first-of-type a {
|
||||
color: #d54e21;
|
||||
border-radius: 0;
|
||||
}
|
||||
|
||||
nav:first-of-type a:hover {
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
nav:first-of-type a:before {
|
||||
background-color: #d54e21;
|
||||
}
|
||||
|
||||
nav.affix {
|
||||
position: fixed;
|
||||
top: 20px;
|
||||
}
|
||||
|
||||
nav.affix-bottom {
|
||||
position: absolute;
|
||||
}
|
||||
|
||||
nav a {
|
||||
border-radius: 3px;
|
||||
font-size: 15px;
|
||||
display: block;
|
||||
cursor: pointer;
|
||||
font-weight: 500;
|
||||
position: relative;
|
||||
text-decoration: none;
|
||||
padding: 10px 12px;
|
||||
width: 100%;
|
||||
padding-right: 3px;
|
||||
border-bottom: 2px solid #fff;
|
||||
}
|
||||
|
||||
nav a:before {
|
||||
content: '';
|
||||
width: 4px;
|
||||
display: block;
|
||||
left: 0;
|
||||
position: absolute;
|
||||
height: 100%;
|
||||
display: none;
|
||||
background: #1e8cbe;
|
||||
top: 0;
|
||||
}
|
||||
|
||||
nav a:hover {
|
||||
background-color: #E6E8EA;
|
||||
color: #1e8cbe;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
nav a:hover:before {
|
||||
display: block;
|
||||
}
|
||||
|
||||
nav a:last-of-type {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
.gist {
|
||||
margin-top: 5.1%;
|
||||
margin-bottom: 5%;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 1050px) {
|
||||
body {
|
||||
margin: 0 auto;
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: 767px) {
|
||||
header span {
|
||||
display: none;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 26px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 20px;
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: 514px) {
|
||||
p,
|
||||
ul,
|
||||
ol,
|
||||
blockquote {
|
||||
margin-bottom: 8%;
|
||||
}
|
||||
}
|
||||
59
docs/extensions/webdav/static/syntax.css
Normal file
59
docs/extensions/webdav/static/syntax.css
Normal file
@@ -0,0 +1,59 @@
|
||||
/* Background */ .chroma { color: #f8f8f2; background-color: #272822 }
|
||||
/* Error */ .chroma .err { color: #960050; background-color: #1e0010 }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; }
|
||||
/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc }
|
||||
/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em; }
|
||||
/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em; }
|
||||
/* Keyword */ .chroma .k { color: #66d9ef }
|
||||
/* KeywordConstant */ .chroma .kc { color: #66d9ef }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #66d9ef }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #f92672 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #66d9ef }
|
||||
/* KeywordReserved */ .chroma .kr { color: #66d9ef }
|
||||
/* KeywordType */ .chroma .kt { color: #66d9ef }
|
||||
/* NameAttribute */ .chroma .na { color: #a6e22e }
|
||||
/* NameClass */ .chroma .nc { color: #a6e22e }
|
||||
/* NameConstant */ .chroma .no { color: #66d9ef }
|
||||
/* NameDecorator */ .chroma .nd { color: #a6e22e }
|
||||
/* NameException */ .chroma .ne { color: #a6e22e }
|
||||
/* NameFunction */ .chroma .nf { color: #a6e22e }
|
||||
/* NameOther */ .chroma .nx { color: #a6e22e }
|
||||
/* NameTag */ .chroma .nt { color: #f92672 }
|
||||
/* Literal */ .chroma .l { color: #ae81ff }
|
||||
/* LiteralDate */ .chroma .ld { color: #e6db74 }
|
||||
/* LiteralString */ .chroma .s { color: #e6db74 }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #e6db74 }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #e6db74 }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #e6db74 }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #e6db74 }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #e6db74 }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #e6db74 }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #ae81ff }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #e6db74 }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #e6db74 }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #e6db74 }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #e6db74 }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #e6db74 }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #e6db74 }
|
||||
/* LiteralNumber */ .chroma .m { color: #ae81ff }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ae81ff }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ae81ff }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ae81ff }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ae81ff }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ae81ff }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ae81ff }
|
||||
/* Operator */ .chroma .o { color: #f92672 }
|
||||
/* OperatorWord */ .chroma .ow { color: #f92672 }
|
||||
/* Comment */ .chroma .c { color: #75715e }
|
||||
/* CommentHashbang */ .chroma .ch { color: #75715e }
|
||||
/* CommentMultiline */ .chroma .cm { color: #75715e }
|
||||
/* CommentSingle */ .chroma .c1 { color: #75715e }
|
||||
/* CommentSpecial */ .chroma .cs { color: #75715e }
|
||||
/* CommentPreproc */ .chroma .cp { color: #75715e }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #75715e }
|
||||
/* GenericDeleted */ .chroma .gd { color: #f92672 }
|
||||
/* GenericEmph */ .chroma .ge { font-style: italic }
|
||||
/* GenericInserted */ .chroma .gi { color: #a6e22e }
|
||||
/* GenericStrong */ .chroma .gs { font-weight: bold }
|
||||
/* GenericSubheading */ .chroma .gu { color: #75715e }
|
||||
Reference in New Issue
Block a user