use OC_ env prefix
Signed-off-by: Jörn Friedrich Dreyer <jfd@butonic.de>
This commit is contained in:
Jörn Friedrich Dreyer
@@ -169,24 +169,24 @@ This is a desired use case that is yet not supported due to lacking of flags for
|
||||
|
||||
- Variadic runtime extensions to run (development mostly)
|
||||
- Arg forwarding to command (when running in supervised mode, forward any --config-file flag to supervised subcommands)
|
||||
- Ability to set `OCIS_URL` from a config file (this would require to extend the ocis-pkg/config/config.go file).
|
||||
- Ability to set `OC_URL` from a config file (this would require to extend the ocis-pkg/config/config.go file).
|
||||
|
||||
#### The case for `OCIS_URL`
|
||||
#### The case for `OC_URL`
|
||||
|
||||
`OCIS_URL` is a jack-of-all trades configuration. It is meant to ease up providing defaults and ensuring dependant services are well configured. It is an override to the following env vars:
|
||||
`OC_URL` is a jack-of-all trades configuration. It is meant to ease up providing defaults and ensuring dependant services are well configured. It is an override to the following env vars:
|
||||
|
||||
```
|
||||
OCIS_IDM_ADDRESS
|
||||
OC_IDM_ADDRESS
|
||||
PROXY_OIDC_ISSUER
|
||||
STORAGE_OIDC_ISSUER
|
||||
STORAGE_FRONTEND_PUBLIC_URL
|
||||
STORAGE_LDAP_IDP
|
||||
WEB_UI_CONFIG_SERVER
|
||||
WEB_OIDC_AUTHORITY
|
||||
OCIS_PUBLIC_URL
|
||||
OC_PUBLIC_URL
|
||||
```
|
||||
|
||||
Because this functionality is only available as an env var, there is no current way to "normalize" its usage with a config file. That is, there is no way to individually set `OCIS_URL` via config file. This is clear technical debt, and should be added functionality.
|
||||
Because this functionality is only available as an env var, there is no current way to "normalize" its usage with a config file. That is, there is no way to individually set `OC_URL` via config file. This is clear technical debt, and should be added functionality.
|
||||
|
||||
#### State of the Art
|
||||
- [Kubernetes proposal on this very same topic](https://docs.google.com/document/d/1Dvct469xfjkgy3tjWMAKvRAJo4CmGH4cgSVGTDpay6A)
|
||||
|
||||
+6
-6
@@ -13,9 +13,9 @@ Note, as a prerequisite backing up Infinite Scale, the instance has to be fully
|
||||
|
||||
## Ocis Data Structure
|
||||
|
||||
Ocis stores its data in a folder that can be configured via the environment variable `OCIS_BASE_DATA_PATH`. Without further configuration, services derive from that path when they store data, though individual settings for certain data types can be configured.
|
||||
Ocis stores its data in a folder that can be configured via the environment variable `OC_BASE_DATA_PATH`. Without further configuration, services derive from that path when they store data, though individual settings for certain data types can be configured.
|
||||
|
||||
The default value for the `OCIS_BASE_DATA_PATH` variable is `$HOME/.ocis` (or `/var/lib/ocis` when using the docker container. Note: Configuration data is by default stored in `/etc/ocis/` in the container.).
|
||||
The default value for the `OC_BASE_DATA_PATH` variable is `$HOME/.ocis` (or `/var/lib/ocis` when using the docker container. Note: Configuration data is by default stored in `/etc/ocis/` in the container.).
|
||||
|
||||
Inside this folder, Infinite Scale will store all its data in separate subdirectories. That includes metadata, configurations, queues and stores etc. The actual bytes of files (blobs) are handled by a so called blobstore, which also stores here by default. Depending on the used blobstore, the blobs need to be backed up separately, for example if S3 is used. Note: See special case for the `config` folder in a docker container.
|
||||
|
||||
@@ -42,7 +42,7 @@ The following sections describe the content and background of the subdirectories
|
||||
|
||||
### `config`
|
||||
|
||||
Contains basic Infinite Scale configuration created by `ocis init`(Note: The location of the configuration folder can be specified with the `OCIS_CONFIG_DIR` environment variable, but for this document we will assume this variable is not set and the default is used.)
|
||||
Contains basic Infinite Scale configuration created by `ocis init`(Note: The location of the configuration folder can be specified with the `OC_CONFIG_DIR` environment variable, but for this document we will assume this variable is not set and the default is used.)
|
||||
|
||||
```bash
|
||||
~/.ocis/config/:tree
|
||||
@@ -57,9 +57,9 @@ BACKUP RECOMMENDED. Holds Infinite Scale configuration data. The contents can va
|
||||
|
||||
| Field Name | Envvar Name | Description | If not backed up |
|
||||
| --- | --- | --- | --- |
|
||||
| `idp.ldap.bind_password` | `OCIS_LDAP_BIND_PASSWORD` | Password for the idp | no logins possible |
|
||||
| `idp.ldap.bind_password` | `OC_LDAP_BIND_PASSWORD` | Password for the idp | no logins possible |
|
||||
| `idm.service_user_passwords.idp_password`| `IDM_IDPSVC_PASSWORD` | Same as above | no logins possible |
|
||||
| `system_user_id` | `OCIS_SYSTEM_USER_ID` | The id of storage-system user | no logins possible |
|
||||
| `system_user_id` | `OC_SYSTEM_USER_ID` | The id of storage-system user | no logins possible |
|
||||
| `idm.service_user_passwords.reva_password`| `IDM_REVASVC_PASSWORD` | The reva password | no logins possible |
|
||||
| `auth_basic.auth_providers.ldap.bind_password` | `AUTH_BASIC_LDAP_BIND_PASSWORD` | Same as above | no logins possible |
|
||||
| `users.drivers.ldap.bind_password` | `USERS_LDAP_BIND_PASSWORD` | Same as above | no logins possible |
|
||||
@@ -179,7 +179,7 @@ Contains Infinite Scale meta (and blob) data, depending on the blobstore. See th
|
||||
```
|
||||
|
||||
* `metadata`:\
|
||||
BACKUP REQUIRED. Contains system data. Path can be specified via `STORAGE_SYSTEM_OCIS_ROOT`. Not backing it up will remove shares from the system and will also remove custom settings.
|
||||
BACKUP REQUIRED. Contains system data. Path can be specified via `STORAGE_SYSTEM_OC_ROOT`. Not backing it up will remove shares from the system and will also remove custom settings.
|
||||
* `ocm`:\
|
||||
BACKUP REQUIRED/OMITABLE. Contains ocm share data. When not using ocm sharing, this folder does not need to be backed up.
|
||||
* `users`:\
|
||||
|
||||
+1
-1
@@ -46,7 +46,7 @@ Let's explore with examples this approach.
|
||||
|
||||
followed by the `<extension name>.yaml`, e.g. `proxy.yaml` for the extension configuration. You also can put an `ocis.yaml` config file to the expected loading location to use a single config file.
|
||||
|
||||
You can set another directory as config path in the environment variable `OCIS_CONFIG_DIR`. It will then pick the same file names, but from the folder you configured.
|
||||
You can set another directory as config path in the environment variable `OC_CONFIG_DIR`. It will then pick the same file names, but from the folder you configured.
|
||||
|
||||
#### Only config files
|
||||
|
||||
|
||||
@@ -23,12 +23,12 @@ For the following examples you need to have the oCIS binary in your current work
|
||||
|
||||
### Using automatically generated certificates
|
||||
|
||||
In order to run oCIS with automatically generated and self-signed certificates please execute following command. You need to replace `your-host` with an IP or hostname. Since you have only self-signed certificates you need to have `OCIS_INSECURE` set to `true`.
|
||||
In order to run oCIS with automatically generated and self-signed certificates please execute following command. You need to replace `your-host` with an IP or hostname. Since you have only self-signed certificates you need to have `OC_INSECURE` set to `true`.
|
||||
|
||||
```bash
|
||||
OCIS_INSECURE=true \
|
||||
OC_INSECURE=true \
|
||||
PROXY_HTTP_ADDR=0.0.0.0:9200 \
|
||||
OCIS_URL=https://your-host:9200 \
|
||||
OC_URL=https://your-host:9200 \
|
||||
./ocis server
|
||||
```
|
||||
|
||||
@@ -37,15 +37,15 @@ OCIS_URL=https://your-host:9200 \
|
||||
If you have your own certificates already in place, you may want to make oCIS use them:
|
||||
|
||||
```bash
|
||||
OCIS_INSECURE=false \
|
||||
OC_INSECURE=false \
|
||||
PROXY_HTTP_ADDR=0.0.0.0:9200 \
|
||||
OCIS_URL=https://your-host:9200 \
|
||||
OC_URL=https://your-host:9200 \
|
||||
PROXY_TRANSPORT_TLS_KEY=./certs/your-host.key \
|
||||
PROXY_TRANSPORT_TLS_CERT=./certs/your-host.crt \
|
||||
./ocis server
|
||||
```
|
||||
|
||||
If you generated these certificates on your own, you might need to set `OCIS_INSECURE` to `true`.
|
||||
If you generated these certificates on your own, you might need to set `OC_INSECURE` to `true`.
|
||||
|
||||
For more configuration options check the configuration section in [oCIS]({{< ref "../config" >}}) and the oCIS services.
|
||||
|
||||
|
||||
@@ -93,7 +93,7 @@ basedn = "dc=ocis,dc=test" # base dn to construct
|
||||
{{< hint >}}
|
||||
There is a bug in the config merging for environment variables, cli flags and config files causing log settings not to be picked up from the config file when specifying `--extensions`. That is why I will
|
||||
* configure most of the config in a file,
|
||||
* adjust logging using `OCIS_LOG_*` environment variables and
|
||||
* adjust logging using `OC_LOG_*` environment variables and
|
||||
* specify which extension to run using `ocis/bin/ocis server --extensions "comma, separated, list, of, extensions"`.
|
||||
{{< /hint >}}
|
||||
|
||||
@@ -101,7 +101,7 @@ There is a bug in the config merging for environment variables, cli flags and co
|
||||
|
||||
For now, we only start the glauth extension:
|
||||
```console
|
||||
$ OCIS_LOG_PRETTY=true OCIS_LOG_COLOR=true ocis/bin/ocis server --extensions "glauth"
|
||||
$ OC_LOG_PRETTY=true OC_LOG_COLOR=true ocis/bin/ocis server --extensions "glauth"
|
||||
```
|
||||
|
||||
#### Check it is up and running
|
||||
@@ -138,7 +138,7 @@ userschema = { uid = "uid", displayname = "givenname" } # TODO make glauth retur
|
||||
Now we can start all necessary services.
|
||||
|
||||
```console
|
||||
$ OCIS_LOG_PRETTY=true OCIS_LOG_COLOR=true ocis/bin/ocis server --extensions "glauth, storage-gateway, storage-authbasic, storage-userprovider"
|
||||
$ OC_LOG_PRETTY=true OC_LOG_COLOR=true ocis/bin/ocis server --extensions "glauth, storage-gateway, storage-authbasic, storage-userprovider"
|
||||
```
|
||||
|
||||
|
||||
@@ -148,7 +148,7 @@ Here I ran out of time. I tried to verify this step with the reva cli:
|
||||
`login basic`
|
||||
but it tries to create the user home, which cannot be disabled in a config file: https://github.com/owncloud/ocis/issues/2416#issuecomment-901197053
|
||||
|
||||
starting `STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN=true OCIS_LOG_LEVEL=debug OCIS_LOG_PRETTY=true OCIS_LOG_COLOR=true ocis/bin/ocis server --extensions "storage-gateway, storage-authbasic, storage-userprovider"` let me login:
|
||||
starting `STORAGE_GATEWAY_DISABLE_HOME_CREATION_ON_LOGIN=true OC_LOG_LEVEL=debug OC_LOG_PRETTY=true OC_LOG_COLOR=true ocis/bin/ocis server --extensions "storage-gateway, storage-authbasic, storage-userprovider"` let me login:
|
||||
|
||||
```console
|
||||
✗ cmd/reva/reva -insecure -host localhost:9142
|
||||
@@ -193,7 +193,7 @@ ERROR:
|
||||
|
||||
The built-in [libregraph/lico](https://github.com/libregraph/lico) needs environment variables to configure the LDAP server:
|
||||
```console
|
||||
export OCIS_URL=https://ocis.ocis.test
|
||||
export OC_URL=https://ocis.ocis.test
|
||||
export IDP_LDAP_URI=ldap://127.0.0.1:9125
|
||||
export IDP_LDAP_BASE_DN="dc=ocis,dc=test"
|
||||
export IDP_LDAP_BIND_DN="cn=admin,dc=ocis,dc=test"
|
||||
|
||||
@@ -75,13 +75,13 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
### oCIS settings ###
|
||||
# oCIS version. Defaults to "latest"
|
||||
OCIS_DOCKER_TAG=
|
||||
OC_DOCKER_TAG=
|
||||
# JWT secret which is used for the storage provider. Must be changed in order to have a secure oCIS. Defaults to "Pive-Fumkiu4"
|
||||
OCIS_JWT_SECRET=
|
||||
OC_JWT_SECRET=
|
||||
# JWT secret which is used for uploads to create transfer tokens. Must be changed in order to have a secure oCIS. Defaults to "replace-me-with-a-transfer-secret"
|
||||
STORAGE_TRANSFER_SECRET=
|
||||
# Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please"
|
||||
OCIS_MACHINE_AUTH_API_KEY=
|
||||
OC_MACHINE_AUTH_API_KEY=
|
||||
|
||||
### oCIS settings ###
|
||||
# oC10 version. Defaults to "latest"
|
||||
@@ -118,7 +118,7 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
Traefik will issue certificates with LetsEncrypt and therefore you must set an email address in `TRAEFIK_ACME_MAIL=`.
|
||||
|
||||
By default oCIS will be started in the `latest` version. If you want to start a specific version of oCIS set the version to `OCIS_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated).
|
||||
By default oCIS will be started in the `latest` version. If you want to start a specific version of oCIS set the version to `OC_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated).
|
||||
|
||||
Set your domain for the oC10 and oCIS frontend in `CLOUD_DOMAIN=`, e.g. `CLOUD_DOMAIN=cloud.owncloud.test`.
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 92 KiB |
@@ -120,13 +120,13 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
# For production releases: "owncloud/ocis"
|
||||
# For rolling releases: "owncloud/ocis-rolling"
|
||||
# Defaults to production if not set otherwise
|
||||
OCIS_DOCKER_IMAGE=owncloud/ocis-rolling
|
||||
OC_DOCKER_IMAGE=owncloud/ocis-rolling
|
||||
# The oCIS container version.
|
||||
# Defaults to "latest" and points to the latest stable tag.
|
||||
OCIS_DOCKER_TAG=
|
||||
OC_DOCKER_TAG=
|
||||
# Domain of oCIS, where you can find the frontend.
|
||||
# Defaults to "ocis.owncloud.test"
|
||||
OCIS_DOMAIN=
|
||||
OC_DOMAIN=
|
||||
# oCIS admin user password. Defaults to "admin".
|
||||
ADMIN_PASSWORD=
|
||||
# Demo users should not be created on a production instance,
|
||||
@@ -147,8 +147,8 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
# Leaving it default stores data in docker internal volumes.
|
||||
# For more details see:
|
||||
# https://doc.owncloud.com/ocis/next/deployment/general/general-info.html#default-paths
|
||||
# OCIS_CONFIG_DIR=/your/local/ocis/config
|
||||
# OCIS_DATA_DIR=/your/local/ocis/data
|
||||
# OC_CONFIG_DIR=/your/local/ocis/config
|
||||
# OC_DATA_DIR=/your/local/ocis/data
|
||||
|
||||
# S3 Storage configuration - optional
|
||||
# Infinite Scale supports S3 storage as primary storage.
|
||||
@@ -247,13 +247,13 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
By default oCIS will be started in the `latest` rolling version. Please note that this deployment does currently not work with the 5.x productions releases.
|
||||
The oCIS "collaboration" service, which is required by this deployment, is not part of the 5.x releases.
|
||||
|
||||
If you want to use a specific version of oCIS, set the version to a dedicated tag like `OCIS_DOCKER_TAG=6.3.0`. The minimal required oCIS Version to run this deployment is 6.3.0. Available production versions can be found on [Docker Hub Production](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated) and available rolling releases can be found on [Docker Hub Rolling](https://hub.docker.com/r/owncloud/ocis-rolling/tags?page=1&ordering=last_updated)
|
||||
If you want to use a specific version of oCIS, set the version to a dedicated tag like `OC_DOCKER_TAG=6.3.0`. The minimal required oCIS Version to run this deployment is 6.3.0. Available production versions can be found on [Docker Hub Production](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated) and available rolling releases can be found on [Docker Hub Rolling](https://hub.docker.com/r/owncloud/ocis-rolling/tags?page=1&ordering=last_updated)
|
||||
|
||||
{{< hint type=info title="oCIS Releases" >}}
|
||||
You can read more about the different oCIS releases in the [oCIS Release Lifecycle](../release_roadmap.md).
|
||||
{{< /hint >}}
|
||||
|
||||
Set your domain for the oCIS frontend in `OCIS_DOMAIN=`, e.g. `OCIS_DOMAIN=ocis.owncloud.test`.
|
||||
Set your domain for the oCIS frontend in `OC_DOMAIN=`, e.g. `OC_DOMAIN=ocis.owncloud.test`.
|
||||
|
||||
Set the initial admin user password in `ADMIN_PASSWORD=`, it defaults to `admin`.
|
||||
|
||||
|
||||
@@ -63,9 +63,9 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
### oCIS settings ###
|
||||
# oCIS version. Defaults to "latest"
|
||||
OCIS_DOCKER_TAG=
|
||||
OC_DOCKER_TAG=
|
||||
# Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test"
|
||||
OCIS_DOMAIN=
|
||||
OC_DOMAIN=
|
||||
# oCIS admin user password. Defaults to "admin".
|
||||
ADMIN_PASSWORD=
|
||||
# The demo users should not be created on a production instance
|
||||
@@ -74,7 +74,7 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
### oCIS Hello settings ###
|
||||
# oCIS Hello version. Defaults to "latest"
|
||||
OCIS_HELLO_DOCKER_TAG=
|
||||
OC_HELLO_DOCKER_TAG=
|
||||
```
|
||||
|
||||
You are installing oCIS on a server and Traefik will obtain valid certificates for you so please remove `INSECURE=true` or set it to `false`.
|
||||
@@ -85,13 +85,13 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
Traefik will issue certificates with LetsEncrypt and therefore you must set an email address in `TRAEFIK_ACME_MAIL=`.
|
||||
|
||||
By default oCIS will be started in the `latest` version. If you want to start a specific version of oCIS set the version to `OCIS_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated).
|
||||
By default oCIS will be started in the `latest` version. If you want to start a specific version of oCIS set the version to `OC_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated).
|
||||
|
||||
Set your domain for the oCIS frontend in `OCIS_DOMAIN=`, e.g. `OCIS_DOMAIN=ocis.owncloud.test`.
|
||||
Set your domain for the oCIS frontend in `OC_DOMAIN=`, e.g. `OC_DOMAIN=ocis.owncloud.test`.
|
||||
|
||||
Set the initial admin user password in `ADMIN_PASSWORD=`, it defaults to `admin`.
|
||||
|
||||
By default the oCIS Hello extension will be started in the `latest` version. If you want to start a specific version of oCIS Hello set the version to `OCIS_HELLO_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis-hello/tags?page=1&ordering=last_updated).
|
||||
By default the oCIS Hello extension will be started in the `latest` version. If you want to start a specific version of oCIS Hello set the version to `OC_HELLO_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis-hello/tags?page=1&ordering=last_updated).
|
||||
|
||||
Now you have configured everything and can save the file.
|
||||
|
||||
|
||||
@@ -68,11 +68,11 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
### oCIS settings ###
|
||||
# oCIS version. Defaults to "latest"
|
||||
OCIS_DOCKER_TAG=
|
||||
OC_DOCKER_TAG=
|
||||
# Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test"
|
||||
OCIS_DOMAIN=
|
||||
OC_DOMAIN=
|
||||
# ownCloud Web openid connect client id. Defaults to "ocis-web"
|
||||
OCIS_OIDC_CLIENT_ID=
|
||||
OC_OIDC_CLIENT_ID=
|
||||
|
||||
### Keycloak ###
|
||||
# Domain of Keycloak, where you can find the management and authentication frontend. Defaults to "keycloak.owncloud.test"
|
||||
@@ -94,11 +94,11 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
Traefik will issue certificates with LetsEncrypt and therefore you must set an email address in `TRAEFIK_ACME_MAIL=`.
|
||||
|
||||
By default oCIS will be started in the `latest` version. If you want to start a specific version of oCIS set the version to `OCIS_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated).
|
||||
By default oCIS will be started in the `latest` version. If you want to start a specific version of oCIS set the version to `OC_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated).
|
||||
|
||||
Set your domain for the oCIS frontend in `OCIS_DOMAIN=`, e.g. `OCIS_DOMAIN=ocis.owncloud.test`.
|
||||
Set your domain for the oCIS frontend in `OC_DOMAIN=`, e.g. `OC_DOMAIN=ocis.owncloud.test`.
|
||||
|
||||
If you want to change the OIDC client id of th ownCloud Web frontend, you can do this by setting the name to `OCIS_OIDC_CLIENT_ID=`.
|
||||
If you want to change the OIDC client id of th ownCloud Web frontend, you can do this by setting the name to `OC_OIDC_CLIENT_ID=`.
|
||||
|
||||
Set your domain for the Keycloak administration panel and authentication endpoints to `KEYCLOAK_DOMAIN=` e.g. `KEYCLOAK_DOMAIN=keycloak.owncloud.test`.
|
||||
|
||||
|
||||
@@ -63,15 +63,15 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
### oCIS settings ###
|
||||
# oCIS version. Defaults to "latest"
|
||||
OCIS_DOCKER_TAG=
|
||||
OC_DOCKER_TAG=
|
||||
# Domain of oCIS, where you can find the frontend. Defaults to "ocis.owncloud.test"
|
||||
OCIS_DOMAIN=
|
||||
OC_DOMAIN=
|
||||
# JWT secret which is used for the storage provider. Must be changed in order to have a secure oCIS. Defaults to "Pive-Fumkiu4"
|
||||
OCIS_JWT_SECRET=
|
||||
OC_JWT_SECRET=
|
||||
# JWT secret which is used for uploads to create transfer tokens. Must be changed in order to have a secure oCIS. Defaults to "replace-me-with-a-transfer-secret"
|
||||
STORAGE_TRANSFER_SECRET=
|
||||
# Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please"
|
||||
OCIS_MACHINE_AUTH_API_KEY=
|
||||
OC_MACHINE_AUTH_API_KEY=
|
||||
|
||||
### LDAP server settings ###
|
||||
# Password of LDAP user "cn=admin,dc=owncloud,dc=com". Defaults to "admin"
|
||||
@@ -90,15 +90,15 @@ See also [example server setup]({{< ref "preparing_server" >}})
|
||||
|
||||
Traefik will issue certificates with LetsEncrypt and therefore you must set an email address in `TRAEFIK_ACME_MAIL=`.
|
||||
|
||||
By default oCIS will be started in the `latest` version. If you want to start a specific version of oCIS set the version to `OCIS_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated).
|
||||
By default oCIS will be started in the `latest` version. If you want to start a specific version of oCIS set the version to `OC_DOCKER_TAG=`. Available versions can be found on [Docker Hub](https://hub.docker.com/r/owncloud/ocis/tags?page=1&ordering=last_updated).
|
||||
|
||||
Set your domain for the oCIS frontend in `OCIS_DOMAIN=`, e.g. `OCIS_DOMAIN=cloud.owncloud.test`.
|
||||
Set your domain for the oCIS frontend in `OC_DOMAIN=`, e.g. `OC_DOMAIN=cloud.owncloud.test`.
|
||||
|
||||
The OpenLDAP server in this example deployment has an admin users, which is also used as bind user in order to keep these examples simple. You can change the default password "admin" to a different one by setting it to `LDAP_ADMIN_PASSWORD=...`.
|
||||
|
||||
Set your domain for the LDAP manager UI in `LDAP_MANAGER_DOMAIN=`, e.g. `ldap.owncloud.test`.
|
||||
|
||||
Grant the oCIS Admin role to the admin user from your LDAP in `OCIS_ADMIN_USER_ID:`. You need to enter the uuid of LDAP user.
|
||||
Grant the oCIS Admin role to the admin user from your LDAP in `OC_ADMIN_USER_ID:`. You need to enter the uuid of LDAP user.
|
||||
|
||||
{{< hint type=tip title=Encoding >}}
|
||||
In the .ldif file in this example, the admin user id is base64 encoded. You need to decode it to make it work.
|
||||
|
||||
@@ -45,21 +45,21 @@ In the service definition we referenced `/etc/ocis/ocis.env` as our file contain
|
||||
In order to create the file we need first to create the folder `/etc/ocis/` and then we can add the actual `/etc/ocis/ocis.env` with following content:
|
||||
|
||||
```bash
|
||||
OCIS_URL=https://some-hostname-or-ip:9200
|
||||
OC_URL=https://some-hostname-or-ip:9200
|
||||
PROXY_HTTP_ADDR=0.0.0.0:9200
|
||||
OCIS_INSECURE=false
|
||||
OC_INSECURE=false
|
||||
|
||||
OCIS_LOG_LEVEL=error
|
||||
OC_LOG_LEVEL=error
|
||||
|
||||
OCIS_CONFIG_DIR=/etc/ocis
|
||||
OCIS_BASE_DATA_PATH=/var/lib/ocis
|
||||
OC_CONFIG_DIR=/etc/ocis
|
||||
OC_BASE_DATA_PATH=/var/lib/ocis
|
||||
```
|
||||
|
||||
Since we set `OCIS_CONFIG_DIR` to `/etc/ocis` you can also place configuration files in this directory.
|
||||
Since we set `OC_CONFIG_DIR` to `/etc/ocis` you can also place configuration files in this directory.
|
||||
|
||||
Please change your `OCIS_URL` in order to reflect your actual deployment. If you are using self-signed certificates you need to set `OCIS_INSECURE=true` in `/etc/ocis/ocis.env`.
|
||||
Please change your `OC_URL` in order to reflect your actual deployment. If you are using self-signed certificates you need to set `OC_INSECURE=true` in `/etc/ocis/ocis.env`.
|
||||
|
||||
oCIS will store all data in `/var/lib/ocis`, because we configured it so by setting `OCIS_BASE_DATA_PATH`. Therefore you need to create that directory and make it accessible to the user, you use to start oCIS.
|
||||
oCIS will store all data in `/var/lib/ocis`, because we configured it so by setting `OC_BASE_DATA_PATH`. Therefore you need to create that directory and make it accessible to the user, you use to start oCIS.
|
||||
|
||||
## Starting the oCIS service
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ chmod +x ocis
|
||||
* Set some environment variables related to Uberspace (**Make sure you fill in YOUR domain!**)
|
||||
```
|
||||
uberspace web backend set / --http --port 9200
|
||||
export OCIS_URL=https://ocis.uber.space
|
||||
export OC_URL=https://ocis.uber.space
|
||||
export PROXY_TLS=false
|
||||
export PROXY_HTTP_ADDR=0.0.0.0:9200
|
||||
export PROXY_LOG_LEVEL=debug
|
||||
@@ -55,7 +55,7 @@ To make it easier (and faster), here's the commands in a script called `ocis.ins
|
||||
curl https://download.owncloud.com/ocis/ocis/stable/4.0.3/ocis-4.0.3-linux-amd64 --output ocis
|
||||
chmod +x ocis
|
||||
uberspace web backend set / --http --port 9200
|
||||
export OCIS_URL=https://ocis.uber.space
|
||||
export OC_URL=https://ocis.uber.space
|
||||
export PROXY_TLS=false
|
||||
export PROXY_HTTP_ADDR=0.0.0.0:9200
|
||||
export PROXY_LOG_LEVEL=debug
|
||||
@@ -82,7 +82,7 @@ startsecs=60
|
||||
# This file is named ocis.start.
|
||||
# It sets environment variables needed for uber.space needed for Infinite Scale
|
||||
/usr/bin/uberspace web backend set / --http --port 9200 &
|
||||
export OCIS_URL=https://ocis.uber.space
|
||||
export OC_URL=https://ocis.uber.space
|
||||
export PROXY_TLS=false
|
||||
export PROXY_HTTP_ADDR=0.0.0.0:9200
|
||||
export PROXY_LOG_LEVEL=debug
|
||||
@@ -122,7 +122,7 @@ rm -rf .ocis
|
||||
curl https://download.owncloud.com/ocis/ocis/stable/4.0.3/ocis-4.0.3-linux-amd64 --output ocis
|
||||
chmod +x ocis
|
||||
uberspace web backend set / --http --port 9200
|
||||
export OCIS_URL=https://ocis.uber.space
|
||||
export OC_URL=https://ocis.uber.space
|
||||
export PROXY_TLS=false
|
||||
export PROXY_HTTP_ADDR=0.0.0.0:9200
|
||||
export PROXY_LOG_LEVEL=debug
|
||||
|
||||
@@ -32,7 +32,7 @@ to access oCIS remotely please refer to the [Basic Remote Setup]({{< ref "../dep
|
||||
|
||||
## additional tips
|
||||
- to allow basic auth (e.g. to easily access oCIS using curl commands) you have to set `PROXY_ENABLE_BASIC_AUTH=true` environment variable
|
||||
- if you cannot use real SSL Certificates set `OCIS_INSECURE=true` as environment variable
|
||||
- if you cannot use real SSL Certificates set `OC_INSECURE=true` as environment variable
|
||||
|
||||
|
||||
# Testplan
|
||||
|
||||
@@ -21,7 +21,7 @@ For debugging there are two workflows that work well, depending on your preferen
|
||||
|
||||
#### Use the debug binary and attach to the process as needed
|
||||
|
||||
Run the debug binary with `OCIS_LOG_LEVEL=debug bin/ocis-debug server` and then find the service you want to debug using:
|
||||
Run the debug binary with `OC_LOG_LEVEL=debug bin/ocis-debug server` and then find the service you want to debug using:
|
||||
|
||||
```console
|
||||
# ps ax | grep ocis
|
||||
@@ -145,7 +145,7 @@ make debug-docker
|
||||
```
|
||||
2. Change the tag label:
|
||||
```bash
|
||||
export OCIS_DOCKER_TAG=debug
|
||||
export OC_DOCKER_TAG=debug
|
||||
```
|
||||
3. Run docker compose
|
||||
Building the docker compose command depends on what you want to debug, for example `ocis` and `collaboration` with the `collabora` supports.
|
||||
|
||||
@@ -96,8 +96,8 @@ To run the tests that require an antivirus service (tests tagged with `@antiviru
|
||||
|
||||
```bash
|
||||
START_ANTIVIRUS=true \
|
||||
OCIS_ASYNC_UPLOADS=true \
|
||||
OCIS_ADD_RUN_SERVICES=antivirus \
|
||||
OC_ASYNC_UPLOADS=true \
|
||||
OC_ADD_RUN_SERVICES=antivirus \
|
||||
POSTPROCESSING_STEPS=virusscan \
|
||||
BEHAT_FEATURE='tests/acceptance/features/apiAntivirus/antivirus.feature' \
|
||||
make -C tests/acceptance/docker test-ocis-feature-ocis-storage
|
||||
@@ -167,10 +167,10 @@ The test suites transferred from ownCloud core have `coreApi` prefixed
|
||||
|
||||
### oCIS Image to Be Tested (Skip Local Image Build)
|
||||
|
||||
By default, the tests will be run against the docker image built from your current working state of the oCIS repository. For some purposes it might also be handy to use an oCIS image from Docker Hub. Therefore, you can provide the optional flag `OCIS_IMAGE_TAG=...` which must contain an available docker tag of the [owncloud/ocis registry on Docker Hub](https://hub.docker.com/r/owncloud/ocis) (e.g. 'latest').
|
||||
By default, the tests will be run against the docker image built from your current working state of the oCIS repository. For some purposes it might also be handy to use an oCIS image from Docker Hub. Therefore, you can provide the optional flag `OC_IMAGE_TAG=...` which must contain an available docker tag of the [owncloud/ocis registry on Docker Hub](https://hub.docker.com/r/owncloud/ocis) (e.g. 'latest').
|
||||
|
||||
```bash
|
||||
OCIS_IMAGE_TAG=latest \
|
||||
OC_IMAGE_TAG=latest \
|
||||
make -C tests/acceptance/docker localApiTests-apiGraph-ocis
|
||||
```
|
||||
|
||||
@@ -206,7 +206,7 @@ To start oCIS:
|
||||
IDM_ADMIN_PASSWORD=admin \
|
||||
ocis/bin/ocis init --insecure true
|
||||
|
||||
OCIS_INSECURE=true PROXY_ENABLE_BASIC_AUTH=true \
|
||||
OC_INSECURE=true PROXY_ENABLE_BASIC_AUTH=true \
|
||||
ocis/bin/ocis server
|
||||
```
|
||||
|
||||
@@ -319,7 +319,7 @@ PROXY_ENABLE_BASIC_AUTH=true \
|
||||
### Run the Tests
|
||||
|
||||
```bash
|
||||
OCIS_WRAPPER_URL=http://localhost:5200 \
|
||||
OC_WRAPPER_URL=http://localhost:5200 \
|
||||
TEST_SERVER_URL="https://localhost:9200" \
|
||||
BEHAT_FEATURE=tests/acceptance/features/apiAsyncUpload/delayPostprocessing.feature \
|
||||
make test-acceptance-api
|
||||
@@ -356,7 +356,7 @@ ocis/bin/ocis init --insecure true
|
||||
|
||||
# run oCIS
|
||||
PROXY_ENABLE_BASIC_AUTH=true \
|
||||
OCIS_ADD_RUN_SERVICES=notifications \
|
||||
OC_ADD_RUN_SERVICES=notifications \
|
||||
NOTIFICATIONS_SMTP_HOST=localhost \
|
||||
NOTIFICATIONS_SMTP_PORT=2500 \
|
||||
NOTIFICATIONS_SMTP_INSECURE=true \
|
||||
@@ -399,7 +399,7 @@ ocis/bin/ocis init --insecure true
|
||||
|
||||
# run oCIS
|
||||
PROXY_ENABLE_BASIC_AUTH=true \
|
||||
OCIS_INSECURE=true \
|
||||
OC_INSECURE=true \
|
||||
SEARCH_EXTRACTOR_TYPE=tika \
|
||||
SEARCH_EXTRACTOR_TIKA_TIKA_URL=http://localhost:9998 \
|
||||
SEARCH_EXTRACTOR_CS3SOURCE_INSECURE=true \
|
||||
@@ -481,8 +481,8 @@ PROXY_ENABLE_BASIC_AUTH=true \
|
||||
ANTIVIRUS_SCANNER_TYPE="clamav" \
|
||||
ANTIVIRUS_CLAMAV_SOCKET="tcp://host.docker.internal:3310" \
|
||||
POSTPROCESSING_STEPS="virusscan" \
|
||||
OCIS_ASYNC_UPLOADS=true \
|
||||
OCIS_ADD_RUN_SERVICES="antivirus"
|
||||
OC_ASYNC_UPLOADS=true \
|
||||
OC_ADD_RUN_SERVICES="antivirus"
|
||||
ocis/bin/ocis server
|
||||
```
|
||||
|
||||
@@ -516,11 +516,11 @@ IDM_ADMIN_PASSWORD=admin \
|
||||
ocis/bin/ocis init --insecure true
|
||||
|
||||
# run oCIS
|
||||
OCIS_URL="https://localhost:9200" \
|
||||
OC_URL="https://localhost:9200" \
|
||||
PROXY_ENABLE_BASIC_AUTH=true \
|
||||
OCIS_ENABLE_OCM=true \
|
||||
OC_ENABLE_OCM=true \
|
||||
OCM_OCM_PROVIDER_AUTHORIZER_PROVIDERS_FILE="tests/config/local/providers.json" \
|
||||
OCIS_ADD_RUN_SERVICES="ocm" \
|
||||
OC_ADD_RUN_SERVICES="ocm" \
|
||||
OCM_OCM_INVITE_MANAGER_INSECURE=true \
|
||||
OCM_OCM_SHARE_PROVIDER_INSECURE=true \
|
||||
OCM_OCM_STORAGE_PROVIDER_INSECURE=true \
|
||||
@@ -552,8 +552,8 @@ The second oCIS instance should be available at: https://localhost:10200/
|
||||
|
||||
{{< hint info >}}
|
||||
To enable ocm in the web interface, you need to set the following envs:
|
||||
`OCIS_ENABLE_OCM="true"`
|
||||
`OCIS_ADD_RUN_SERVICES="ocm"`
|
||||
`OC_ENABLE_OCM="true"`
|
||||
`OC_ADD_RUN_SERVICES="ocm"`
|
||||
{{< /hint>}}
|
||||
|
||||
#### Run the Acceptance Test
|
||||
|
||||
@@ -37,13 +37,13 @@ to get started:
|
||||
```
|
||||
2. Enabling and configuring tracing on oCIS itself will forward the configuration to all services:
|
||||
```console
|
||||
OCIS_TRACING_ENABLED=true \
|
||||
OCIS_TRACING_ENDPOINT=localhost:6831 \
|
||||
OCIS_TRACING_COLLECTOR=http://localhost:14268/api/traces \
|
||||
OC_TRACING_ENABLED=true \
|
||||
OC_TRACING_ENDPOINT=localhost:6831 \
|
||||
OC_TRACING_COLLECTOR=http://localhost:14268/api/traces \
|
||||
./bin/ocis server
|
||||
```
|
||||
If you want to set individual tracing configuration for each service, make sure to set
|
||||
`OCIS_TRACING_ENABLED=false`.
|
||||
`OC_TRACING_ENABLED=false`.
|
||||
3. Make the actual request that you want to trace.
|
||||
4. Open up the [Jaeger UI](http://localhost:16686) to analyze request traces.
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ We are distributing oCIS as binaries and Docker images.
|
||||
{{< hint warning >}}
|
||||
The examples in this document assume that oCIS is accessed from the same host as it is running on (`localhost`). If you would like
|
||||
to access oCIS remotely please refer to the [Basic Remote Setup]({{< ref "../deployment/basic-remote-setup" >}}) section. Especially
|
||||
to the notes about setting the `PROXY_HTTP_ADDR` and `OCIS_URL` environment variables.
|
||||
to the notes about setting the `PROXY_HTTP_ADDR` and `OC_URL` environment variables.
|
||||
{{< /hint >}}
|
||||
|
||||
You can find more deployment examples in the [deployment section]({{< ref "../deployment" >}}).
|
||||
@@ -53,7 +53,7 @@ IDM_CREATE_DEMO_USERS=true ./ocis server
|
||||
The default primary storage location is `~/.ocis` or `/var/lib/ocis` depending on the packaging format and your operating system user. You can change that value by configuration.
|
||||
|
||||
{{< hint info >}}
|
||||
When you're using oCIS with self-signed certificates, you need to answer the question for certificate checking with "yes" or set the environment variable `OCIS_INSECURE=true`, in order to make oCIS work.
|
||||
When you're using oCIS with self-signed certificates, you need to answer the question for certificate checking with "yes" or set the environment variable `OC_INSECURE=true`, in order to make oCIS work.
|
||||
{{< /hint >}}
|
||||
|
||||
{{< hint warning >}}
|
||||
@@ -80,7 +80,7 @@ docker run --rm -p 9200:9200 -v ocis-config:/etc/ocis -v ocis-data:/var/lib/ocis
|
||||
```
|
||||
|
||||
{{< hint info >}}
|
||||
When you're using oCIS with self-signed certificates, you need to set the environment variable `OCIS_INSECURE=true`, in order to make oCIS work.
|
||||
When you're using oCIS with self-signed certificates, you need to set the environment variable `OC_INSECURE=true`, in order to make oCIS work.
|
||||
{{< /hint >}}
|
||||
|
||||
{{< hint warming >}}
|
||||
|
||||
@@ -37,13 +37,13 @@ services:
|
||||
image: owncloud/ocis:latest
|
||||
environment:
|
||||
# INSECURE: needed if oCIS / Traefik is using self generated certificates
|
||||
OCIS_INSECURE: "true"
|
||||
OC_INSECURE: "true"
|
||||
|
||||
# OCIS_URL: the external domain / ip address of oCIS (with protocol, must always be https)
|
||||
OCIS_URL: "https://localhost:9200"
|
||||
# OC_URL: the external domain / ip address of oCIS (with protocol, must always be https)
|
||||
OC_URL: "https://localhost:9200"
|
||||
|
||||
# OCIS_LOG_LEVEL: error / info / ... / debug
|
||||
OCIS_LOG_LEVEL: info
|
||||
# OC_LOG_LEVEL: error / info / ... / debug
|
||||
OC_LOG_LEVEL: info
|
||||
```
|
||||
|
||||
### Initialize
|
||||
@@ -275,13 +275,13 @@ services:
|
||||
# see also https://docs.docker.com/engine/reference/commandline/images/#list-image-digests
|
||||
environment:
|
||||
# INSECURE: needed if oCIS / Traefik is using self generated certificates
|
||||
OCIS_INSECURE: "true"
|
||||
OC_INSECURE: "true"
|
||||
|
||||
# OCIS_URL: the external domain / ip address of oCIS (with protocol, must always be https)
|
||||
OCIS_URL: "https://localhost:9200"
|
||||
# OC_URL: the external domain / ip address of oCIS (with protocol, must always be https)
|
||||
OC_URL: "https://localhost:9200"
|
||||
|
||||
# OCIS_LOG_LEVEL: error / info / ... / debug
|
||||
OCIS_LOG_LEVEL: info
|
||||
# OC_LOG_LEVEL: error / info / ... / debug
|
||||
OC_LOG_LEVEL: info
|
||||
volumes:
|
||||
# mount the ocis config file inside the container
|
||||
- "./ocis.yaml:/etc/ocis/ocis.yaml"
|
||||
|
||||
@@ -17,26 +17,26 @@ oCIS can be configured using Active Directory as identity provider.
|
||||
This configuration is an _example_ for using Samba4 AD as well as a Windows Server 2022 as the LDAP backend for oCIS. It is intended as guideline and first starting point.
|
||||
|
||||
```text
|
||||
OCIS_LDAP_URI=ldaps://xxxxxxxxx
|
||||
OCIS_LDAP_INSECURE="true"
|
||||
OCIS_LDAP_BIND_DN="cn=administrator,cn=users,xxxxxxxxxx"
|
||||
OCIS_LDAP_BIND_PASSWORD=xxxxxxx
|
||||
OCIS_LDAP_DISABLE_USER_MECHANISM="none"
|
||||
OCIS_LDAP_GROUP_BASE_DN="dc=owncloud,dc=test"
|
||||
OCIS_LDAP_GROUP_OBJECTCLASS="group"
|
||||
OCIS_LDAP_GROUP_SCHEMA_ID="objectGUID"
|
||||
OCIS_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING="true"
|
||||
OCIS_LDAP_GROUP_SCHEMA_GROUPNAME="cn"
|
||||
OCIS_LDAP_USER_BASE_DN="dc=owncloud,dc=test"
|
||||
OCIS_LDAP_USER_OBJECTCLASS="user"
|
||||
OCIS_LDAP_USER_SCHEMA_ID="objectGUID"
|
||||
OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING="true"
|
||||
OCIS_LDAP_USER_SCHEMA_USERNAME="sAMAccountName"
|
||||
OCIS_LDAP_LOGIN_ATTRIBUTES="sAMAccountName"
|
||||
OC_LDAP_URI=ldaps://xxxxxxxxx
|
||||
OC_LDAP_INSECURE="true"
|
||||
OC_LDAP_BIND_DN="cn=administrator,cn=users,xxxxxxxxxx"
|
||||
OC_LDAP_BIND_PASSWORD=xxxxxxx
|
||||
OC_LDAP_DISABLE_USER_MECHANISM="none"
|
||||
OC_LDAP_GROUP_BASE_DN="dc=owncloud,dc=test"
|
||||
OC_LDAP_GROUP_OBJECTCLASS="group"
|
||||
OC_LDAP_GROUP_SCHEMA_ID="objectGUID"
|
||||
OC_LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING="true"
|
||||
OC_LDAP_GROUP_SCHEMA_GROUPNAME="cn"
|
||||
OC_LDAP_USER_BASE_DN="dc=owncloud,dc=test"
|
||||
OC_LDAP_USER_OBJECTCLASS="user"
|
||||
OC_LDAP_USER_SCHEMA_ID="objectGUID"
|
||||
OC_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING="true"
|
||||
OC_LDAP_USER_SCHEMA_USERNAME="sAMAccountName"
|
||||
OC_LDAP_LOGIN_ATTRIBUTES="sAMAccountName"
|
||||
IDP_LDAP_LOGIN_ATTRIBUTE="sAMAccountName"
|
||||
IDP_LDAP_UUID_ATTRIBUTE="objectGUID"
|
||||
IDP_LDAP_UUID_ATTRIBUTE_TYPE=binary
|
||||
GRAPH_LDAP_SERVER_WRITE_ENABLED="false"
|
||||
OCIS_EXCLUDE_RUN_SERVICES=idm
|
||||
OCIS_ADMIN_USER_ID="<objectGUID-value-of-the-default-admin-user>"
|
||||
OC_EXCLUDE_RUN_SERVICES=idm
|
||||
OC_ADMIN_USER_ID="<objectGUID-value-of-the-default-admin-user>"
|
||||
```
|
||||
|
||||
@@ -10,7 +10,7 @@ geekdocFilePath: metrics.md
|
||||
|
||||
## 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 has to be configured either through the flag `--debug-token` or the environment variable `OCIS_DEBUG_TOKEN` mentioned above. By default, the metrics endpoint is bound to `http://0.0.0.0:8001/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 has to be configured either through the flag `--debug-token` or the environment variable `OC_DEBUG_TOKEN` mentioned above. By default, the metrics endpoint is bound to `http://0.0.0.0:8001/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
@@ -49,13 +49,13 @@ The NFS server setup can be optimized considering system administrative-, perfor
|
||||
|
||||
## oCIS Start using the NFS Share
|
||||
|
||||
The oCIS server can be instructed to set up the decomposed FS at a certain path by setting the environment variable `OCIS_BASE_DATA_PATH`.
|
||||
The oCIS server can be instructed to set up the decomposed FS at a certain path by setting the environment variable `OC_BASE_DATA_PATH`.
|
||||
|
||||
The test setup started an oCIS tech preview single binary release using this start command:
|
||||
|
||||
```bash
|
||||
./ocis init
|
||||
OCIS_BASE_DATA_PATH=/mnt/ocisdata/ OCIS_LOG_LEVEL=debug OCIS_INSECURE=true PROXY_HTTP_ADDR=0.0.0.0:9200 OCIS_URL=https://hostname:9200 ./ocis server
|
||||
OC_BASE_DATA_PATH=/mnt/ocisdata/ OC_LOG_LEVEL=debug OC_INSECURE=true PROXY_HTTP_ADDR=0.0.0.0:9200 OC_URL=https://hostname:9200 ./ocis server
|
||||
```
|
||||
|
||||
This starts oCIS and a decomposed FS skeleton file system structure is set up on the NFS share.
|
||||
|
||||
Reference in New Issue
Block a user