Skip to content

Commit 33de0a2

Browse files
mmattelmmattel
committed
[docs-only] Add new tables for added/deprecated/removed envvars for 7.1
1 parent 9501a0e commit 33de0a2

File tree

4 files changed

+179
-5
lines changed

4 files changed

+179
-5
lines changed

‎docs/helpers/changed_envvars.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,21 @@
2222
# new is the target version to compare to
2323
# tagged versions must be of format: 'tags/v6.0.0'
2424
# master is different, it must be: 'heads/master'
25-
versionOld = 'tags/v6.0.0'
25+
versionOld = 'tags/v7.0.0'
2626
versionNew = 'heads/master'
2727

2828
# CHANGE according your needs
29-
from_version = '5.0.0'
30-
to_version = '7.0.0'
29+
from_version = '7.0.0'
30+
to_version = '7.1.0'
3131

3232
# CHANGE according your needs
3333
# this will create files like 5.0.0-7.0.0-added and 5.0.0-7.0.0-removed
3434
# this should match which versions you compare. master is ok if that is the base for a named release
35-
nameComponent = '5.0.0-7.0.0'
35+
nameComponent = '7.0.0-7.1.0'
3636

3737
# ADD new elements when a new version has been published so that it gets excluded
3838
# array of version patterns to be excluded for added items. we dont need patch versions
39-
excludePattern = ['pre5.0', '5.0', '6.0']
39+
excludePattern = ['pre5.0', '5.0', '6.0', '6.0.0', '6.0.1', '6.1.0', '6.7', '7.0', '7.0.0']
4040

4141
# DO NOT CHANGE
4242
# this is the path the added/removed result is written to

‎docs/services/general-info/env-var-deltas/7.0.0-7.1.0-added.adoc‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// # Added Variables between oCIS 7.0.0 and oCIS 7.1.0
2+
// commenting the headline to make it better includable
3+
4+
// table created per 2025.01.10
5+
// the table should be recreated/updated on source () changes
6+
7+
[width="100%",cols="~,~,~,~",options="header"]
8+
|===
9+
| Service | Variable | Description | Default
10+
11+
| xref:{s-path}/frontend.adoc[Fontend]
12+
| FRONTEND_CONFIGURABLE_NOTIFICATIONS
13+
| Allow configuring notifications via web client.
14+
| false
15+
16+
| xref:{s-path}/notifications.adoc[Notifications]
17+
| NOTIFICATIONS_STORE
18+
| The type of the store. Supported values are: 'memory', 'nats-js-kv', 'redis-sentinel', 'noop'. See the text description for details.
19+
| nats-js-kv
20+
21+
|
22+
| NOTIFICATIONS_STORE_AUTH_PASSWORD
23+
| The password to authenticate with the store. Only applies when store type 'nats-js-kv' is configured.
24+
|
25+
26+
|
27+
| NOTIFICATIONS_STORE_AUTH_USERNAME
28+
| The username to authenticate with the store. Only applies when store type 'nats-js-kv' is configured.
29+
|
30+
31+
|
32+
| NOTIFICATIONS_STORE_DATABASE
33+
| The database name the configured store should use.
34+
| notifications
35+
36+
|
37+
| NOTIFICATIONS_STORE_NODES
38+
| A list of nodes to access the configured store. This has no effect when 'memory' store is configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details.
39+
| [127.0.0.1:9233]
40+
41+
|
42+
| NOTIFICATIONS_STORE_TABLE
43+
| The database table the store should use.
44+
|
45+
46+
|
47+
| NOTIFICATIONS_STORE_TTL
48+
| Time to live for notifications in the store. Defaults to '336h' (2 weeks). See the Environment Variable Types description for more details.
49+
| 336h0m0s
50+
51+
| xref:{s-path}/settings.adoc[Settings]
52+
| SETTINGS_TRANSLATION_PATH
53+
| (optional) Set this to a path with custom translations to overwrite the builtin translations. Note that file and folder naming rules apply, see the documentation for more details.
54+
|
55+
56+
|===
57+

‎docs/services/general-info/env-var-deltas/7.0.0-7.1.0-deprecated.adoc‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
// # Deprecated Variables between oCIS 7.0.0 and oCIS 7.1.0
2+
// commenting the headline to make it better includable
3+
4+
// table created per 2025.01.10
5+
// the table should be recreated/updated on source () changes
6+
7+
Note that these environment variables were listed for deprecation in 7.0.0 already. Removal has been delayed for an upcoming production version. They are listed here for consistency.
8+
9+
10+
[width="100%",cols="~,~,~,~,~",options="header"]
11+
|===
12+
| Service | Variable | Description | Removal Version | Deprecation Info
13+
14+
| xref:{s-path}/clientlog.adoc[Clientlog]
15+
| CLIENTLOG_REVA_GATEWAY
16+
| CS3 gateway used to look up user metadata
17+
| %%NEXT_PRODUCTION_VERSION%%
18+
| CLIENTLOG_REVA_GATEWAY removed for simplicity.
19+
20+
| xref:{s-path}/frontend.adoc[Frontend]
21+
| FRONTEND_OCS_ADDITIONAL_INFO_ATTRIBUTE
22+
| Additional information attribute for the user like {{.Mail}}.
23+
| %%NEXT_PRODUCTION_VERSION%%
24+
| The OCS API is deprecated
25+
26+
|
27+
| FRONTEND_OCS_ENABLE_DENIALS
28+
| EXPERIMENTAL: enable the feature to deny access on folders.
29+
| %%NEXT_PRODUCTION_VERSION%%
30+
| The OCS API is deprecated
31+
32+
|
33+
| FRONTEND_OCS_INCLUDE_OCM_SHAREES
34+
| Include OCM sharees when listing sharees.
35+
| %%NEXT_PRODUCTION_VERSION%%
36+
| FRONTEND_OCS_INCLUDE_OCM_SHAREES, the OCS API is deprecated
37+
38+
|
39+
| FRONTEND_OCS_LIST_OCM_SHARES
40+
| Include OCM shares when listing shares. See the OCM service documentation for more details.
41+
| %%NEXT_PRODUCTION_VERSION%%
42+
| FRONTEND_OCS_LIST_OCM_SHARES, the OCS API is deprecated
43+
44+
|
45+
| FRONTEND_OCS_PERSONAL_NAMESPACE
46+
| Home namespace identifier.
47+
| %%NEXT_PRODUCTION_VERSION%%
48+
| The OCS API is deprecated
49+
50+
|
51+
| FRONTEND_OCS_PREFIX
52+
| URL path prefix for the OCS service. Note that the string must not start with '/'.
53+
| %%NEXT_PRODUCTION_VERSION%%
54+
| The OCS API is deprecated
55+
56+
|
57+
| FRONTEND_OCS_SHARE_PREFIX
58+
| Path prefix for shares as part of an ocis resource. Note that the path must start with '/'.
59+
| %%NEXT_PRODUCTION_VERSION%%
60+
| The OCS API is deprecated
61+
62+
|
63+
| FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD
64+
| The password to use for authentication. Only applies when using the 'nats-js-kv' store type.
65+
| %%NEXT_PRODUCTION_VERSION%%
66+
| FRONTEND_OCS_STAT_CACHE_AUTH_PASSWORD, the OCS API is deprecated
67+
68+
|
69+
| FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME
70+
| The username to use for authentication. Only applies when using the 'nats-js-kv' store type.
71+
| %%NEXT_PRODUCTION_VERSION%%
72+
| FRONTEND_OCS_STAT_CACHE_AUTH_USERNAME, the OCS API is deprecated
73+
74+
|
75+
| FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE
76+
| Disable persistence of the cache. Only applies when using the 'nats-js-kv' store type. Defaults to false.
77+
| %%NEXT_PRODUCTION_VERSION%%
78+
| FRONTEND_OCS_STAT_CACHE_DISABLE_PERSISTENCE, the OCS API is deprecated
79+
80+
|
81+
| FRONTEND_OCS_STAT_CACHE_STORE
82+
| The type of the cache store. Supported values are: 'memory', 'redis-sentinel', 'nats-js-kv', 'noop'. See the text description for details.
83+
| %%NEXT_PRODUCTION_VERSION%%
84+
| FRONTEND_OCS_STAT_CACHE_STORE, the OCS API is deprecated
85+
86+
|
87+
| FRONTEND_OCS_STAT_CACHE_STORE_NODES
88+
| A list of nodes to access the configured store. This has no effect when 'memory' store is configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. See the Environment Variable Types description for more details.
89+
| %%NEXT_PRODUCTION_VERSION%%
90+
| FRONTEND_OCS_STAT_CACHE_STORE_NODES, the OCS API is deprecated
91+
92+
|
93+
| FRONTEND_OCS_STAT_CACHE_TABLE
94+
| The database table the store should use.
95+
| %%NEXT_PRODUCTION_VERSION%%
96+
| The OCS API is deprecated
97+
98+
|
99+
| FRONTEND_OCS_STAT_CACHE_TTL
100+
| Default time to live for user info in the cache. Only applied when access tokens has no expiration. See the Environment Variable Types description for more details.
101+
| %%NEXT_PRODUCTION_VERSION%%
102+
| FRONTEND_OCS_STAT_CACHE_TTL, the OCS API is deprecated
103+
104+
|===
105+

‎docs/services/general-info/env-var-deltas/7.0.0-7.1.0-removed.adoc‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
// # Removed Variables between oCIS 7.0.0 and oCIS 7.1.0
2+
// commenting the headline to make it better includable
3+
4+
// table created per 2025.01.10
5+
// the table should be recreated/updated on source () changes
6+
7+
[width="100%",cols="~,~,~,~",options="header"]
8+
|===
9+
| Service | Variable | Description | Default
10+
11+
|===
12+

0 commit comments

Comments
 (0)