ownCloud
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
Edit page

Service Configuration

Example YAML Config

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# Autogenerated
# Filename: storage-users-config-example.yaml

tracing:
  enabled: false
  type: ""
  endpoint: ""
  collector: ""
log:
  level: ""
  pretty: false
  color: false
  file: ""
debug:
  addr: 127.0.0.1:9159
  token: ""
  pprof: false
  zpages: false
grpc:
  addr: 127.0.0.1:9157
  protocol: tcp
http:
  addr: 127.0.0.1:9158
  protocol: tcp
  prefix: data
token_manager:
  jwt_secret: ""
reva:
  address: 127.0.0.1:9142
skip_user_groups_in_token: false
driver: ocis
drivers:
  ocis:
    root: ~/.ocis/storage/users
    user_layout: '{{.Id.OpaqueId}}'
    permissions_endpoint: 127.0.0.1:9191
    personalspacealias_template: '{{.SpaceType}}/{{.User.Username | lower}}'
    generalspacealias_template: '{{.SpaceType}}/{{.SpaceName | replace " " "-" | lower}}'
    share_folder: /Shares
  s3ng:
    root: ~/.ocis/storage/users
    user_layout: '{{.Id.OpaqueId}}'
    permissions_endpoint: 127.0.0.1:9191
    region: default
    access_key: ""
    secret_key: ""
    endpoint: ""
    bucket: ""
    personalspacealias_template: '{{.SpaceType}}/{{.User.Username | lower}}'
    generalspacealias_template: '{{.SpaceType}}/{{.SpaceName | replace " " "-" | lower}}'
    share_folder: /Shares
  owncloudsql:
    root: ~/.ocis/storage/owncloud
    share_folder: /Shares
    user_layout: '{{.Username}}'
    upload_info_dir: ~/.ocis/storage/uploadinfo
    db_username: owncloud
    db_password: owncloud
    db_host: ""
    db_port: 3306
    db_name: owncloud
    users_provider_endpoint: localhost:9144
data_server_url: http://localhost:9158/data
temp_folder: ~/.ocis/tmp/users
data_provider_insecure: false
events:
  endpoint: 127.0.0.1:9233
  cluster: ocis-cluster
mount_id: 1284d238-aa92-42ce-bdc4-0b0000009157
expose_data_server: false
readonly: false

Environment Variables

Name Type Default Value Description
OCIS_TRACING_ENABLED
STORAGE_USERS_TRACING_ENABLED
bool false Activates tracing.
OCIS_TRACING_TYPE
STORAGE_USERS_TRACING_TYPE
string
OCIS_TRACING_ENDPOINT
STORAGE_USERS_TRACING_ENDPOINT
string The endpoint to the tracing collector.
OCIS_TRACING_COLLECTOR
STORAGE_USERS_TRACING_COLLECTOR
string
OCIS_LOG_LEVEL
STORAGE_USERS_LOG_LEVEL
string The log level.
OCIS_LOG_PRETTY
STORAGE_USERS_LOG_PRETTY
bool false Activates pretty log output.
OCIS_LOG_COLOR
STORAGE_USERS_LOG_COLOR
bool false Activates colorized log output.
OCIS_LOG_FILE
STORAGE_USERS_LOG_FILE
string The target log file.
STORAGE_USERS_DEBUG_ADDR string 127.0.0.1:9159 Bind address of the debug server, where metrics, health, config and debug endpoints will be exposed.
STORAGE_USERS_DEBUG_TOKEN string Token to secure the metrics endpoint
STORAGE_USERS_DEBUG_PPROF bool false Enables pprof, which can be used for profiling
STORAGE_USERS_DEBUG_ZPAGES bool false Enables zpages, which can be used for collecting and viewing traces in-me
STORAGE_USERS_GRPC_ADDR string 127.0.0.1:9157 The address of the grpc service.
STORAGE_USERS_GRPC_PROTOCOL string tcp The transport protocol of the grpc service.
STORAGE_USERS_HTTP_ADDR string 127.0.0.1:9158 The address of the http service.
STORAGE_USERS_HTTP_PROTOCOL string tcp The transport protocol of the http service.
OCIS_JWT_SECRET
STORAGE_USERS_JWT_SECRET
string
REVA_GATEWAY string 127.0.0.1:9142
STORAGE_USERS_SKIP_USER_GROUPS_IN_TOKEN bool false
STORAGE_USERS_DRIVER string ocis The storage driver which should be used by the service
STORAGE_USERS_OCIS_ROOT string ~/.ocis/storage/users
STORAGE_USERS_OCIS_USER_LAYOUT string {{.Id.OpaqueId}}
STORAGE_USERS_PERMISSION_ENDPOINT,STORAGE_USERS_OCIS_PERMISSIONS_ENDPOINT string 127.0.0.1:9191
STORAGE_USERS_OCIS_PERSONAL_SPACE_ALIAS_TEMPLATE string {{.SpaceType}}/{{.User.Username | lower}}
STORAGE_USERS_OCIS_GENERAL_SPACE_ALIAS_TEMPLATE string {{.SpaceType}}/{{.SpaceName | replace " " "-" | lower}}
STORAGE_USERS_OCIS_SHARE_FOLDER string /Shares
STORAGE_USERS_S3NG_ROOT string ~/.ocis/storage/users
STORAGE_USERS_S3NG_USER_LAYOUT string {{.Id.OpaqueId}}
STORAGE_USERS_PERMISSION_ENDPOINT
STORAGE_USERS_S3NG_PERMISSIONS_ENDPOINT
string 127.0.0.1:9191
STORAGE_USERS_S3NG_REGION string default
STORAGE_USERS_S3NG_ACCESS_KEY string
STORAGE_USERS_S3NG_SECRET_KEY string
STORAGE_USERS_S3NG_ENDPOINT string
STORAGE_USERS_S3NG_BUCKET string
STORAGE_USERS_S3NG_PERSONAL_SPACE_ALIAS_TEMPLATE string {{.SpaceType}}/{{.User.Username | lower}}
STORAGE_USERS_S3NG_GENERAL_SPACE_ALIAS_TEMPLATE string {{.SpaceType}}/{{.SpaceName | replace " " "-" | lower}}
STORAGE_USERS_S3NG_SHARE_FOLDER string /Shares
STORAGE_USERS_OWNCLOUDSQL_DATADIR string ~/.ocis/storage/owncloud
STORAGE_USERS_OWNCLOUDSQL_SHARE_FOLDER string /Shares
STORAGE_USERS_OWNCLOUDSQL_LAYOUT string {{.Username}} path layout to use to navigate into a users folder in an owncloud data dir
STORAGE_USERS_OWNCLOUDSQL_UPLOADINFO_DIR string ~/.ocis/storage/uploadinfo
STORAGE_USERS_OWNCLOUDSQL_DB_USERNAME string owncloud
STORAGE_USERS_OWNCLOUDSQL_DB_PASSWORD string owncloud
STORAGE_USERS_OWNCLOUDSQL_DB_HOST string
STORAGE_USERS_OWNCLOUDSQL_DB_PORT int 3306
STORAGE_USERS_OWNCLOUDSQL_DB_NAME string owncloud
STORAGE_USERS_OWNCLOUDSQL_USERS_PROVIDER_ENDPOINT string localhost:9144
STORAGE_USERS_DATA_SERVER_URL string http://localhost:9158/data
STORAGE_USERS_TEMP_FOLDER string ~/.ocis/tmp/users
OCIS_INSECURE
STORAGE_USERS_DATAPROVIDER_INSECURE
bool false
STORAGE_USERS_EVENTS_ENDPOINT string 127.0.0.1:9233 the address of the streaming service
STORAGE_USERS_EVENTS_CLUSTER string ocis-cluster the clusterID of the streaming service. Mandatory when using nats
STORAGE_USERS_MOUNT_ID string 1284d238-aa92-42ce-bdc4-0b0000009157
STORAGE_USERS_EXPOSE_DATA_SERVER bool false
STORAGE_USERS_READ_ONLY bool false