diff --git a/docs/env-var-deltas/4.0.0-5.0.0-added.adoc b/docs/env-var-deltas/4.0.0-5.0.0-added.adoc index d4a4a066b..7498bf465 100644 --- a/docs/env-var-deltas/4.0.0-5.0.0-added.adoc +++ b/docs/env-var-deltas/4.0.0-5.0.0-added.adoc @@ -1,4 +1,4 @@ -// # Added Variables between oCIS 4.0.5 and oCIS 5.0.0-rc +// # Added Variables between oCIS 4.0.0 and oCIS 5.0.0 // commenting the headline to make it better includable // table created based on the .md file per 2024.02.06 diff --git a/docs/env-var-deltas/4.0.0-5.0.0-added.md b/docs/env-var-deltas/4.0.0-5.0.0-added.md index 41bcf5b87..f2105f1f7 100644 --- a/docs/env-var-deltas/4.0.0-5.0.0-added.md +++ b/docs/env-var-deltas/4.0.0-5.0.0-added.md @@ -1,4 +1,4 @@ -# Added Variables between oCIS 4.0.5 and oCIS 5.0.0-rc1 +# Added Variables between oCIS 4.0.0 and oCIS 5.0.0 | File | Variable | Description | Default | |-----------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------| diff --git a/docs/env-var-deltas/4.0.0-5.0.0-removed.adoc b/docs/env-var-deltas/4.0.0-5.0.0-removed.adoc new file mode 100644 index 000000000..38225205a --- /dev/null +++ b/docs/env-var-deltas/4.0.0-5.0.0-removed.adoc @@ -0,0 +1,40 @@ +// Removed Variables between oCIS 4.0.0 and oCIS 5.0.0 +// commenting the headline to make it better includable + +// table created based on the .md file per 2024.02.07 +// the table should be recreated/updated based on the final .md file + +[width="100%",cols="~,~,~,~",options="header"] +|=== +| File| Variable| Replacement| Description + +| xref:{s-path}/auth-basic.adoc[auth-basic] +| `LDAP_BIND_PASSWORD` +| `OCIS_LDAP_BIND_PASSWORD` +| Password to use for authenticating the 'bind_dn'. + +| xref:{s-path}/graph.adoc[graph] +| `LDAP_BIND_PASSWORD` +| `OCIS_LDAP_BIND_PASSWORD` +| Password to use for authenticating the 'bind_dn'. + +| xref:{s-path}/groups.adoc[groups] +| `LDAP_BIND_PASSWORD` +| `OCIS_LDAP_BIND_PASSWORD` +| Password to use for authenticating the 'bind_dn'. + +| xref:{s-path}/idp.adoc[idp] +| `LDAP_BIND_PASSWORD` +| `OCIS_LDAP_BIND_PASSWORD` +| Password to use for authenticating the 'bind_dn'. + +| xref:{s-path}/users.adoc[users] +| `LDAP_BIND_PASSWORD` +| `OCIS_LDAP_BIND_PASSWORD` +| Password to use for authenticating the 'bind_dn'. + +| +| `LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` +| `OCIS_LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` +| Set this to true if the defined 'ID' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the user ID's. +|=== diff --git a/docs/env-var-deltas/4.0.0-5.0.0-removed.md b/docs/env-var-deltas/4.0.0-5.0.0-removed.md index a571c8e00..2869d71e8 100644 --- a/docs/env-var-deltas/4.0.0-5.0.0-removed.md +++ b/docs/env-var-deltas/4.0.0-5.0.0-removed.md @@ -1,4 +1,4 @@ -# Removed Variables between oCIS 4.0.5 and oCIS 5.0.0-rc1 +# Removed Variables between oCIS 4.0.0 and oCIS 5.0.0 | File | Variable | Replacement | Description | |------------------------------------------|--------------------------------------|-------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| diff --git a/docs/env-var-deltas/make-adoc-table-from-md.txt b/docs/env-var-deltas/make-adoc-table-from-md.txt index 47ffef568..f2f256ea6 100644 --- a/docs/env-var-deltas/make-adoc-table-from-md.txt +++ b/docs/env-var-deltas/make-adoc-table-from-md.txt @@ -1,8 +1,8 @@ make the markdown a asciidoc table -cp 4.0.5-5.0.0.md 4.0.5-5.0.0.adoc copy file -sed -i 's/.$//g' 4.0.5-5.0.0.adoc remove last character of each line which is | -sed -i 's/ \+//g' 4.0.5-5.0.0.adoc remove any double spaces +cp 4.0.0-5.0.0.md 4.0.0-5.0.0.adoc copy file +sed -i 's/.$//g' 4.0.0-5.0.0.adoc remove last character of each line which is | +sed -i 's/ \+//g' 4.0.0-5.0.0.adoc remove any double spaces fully remove the line containing |----...| rename: | File| Variable| Description| Default --> | Service| Variable| Description| Default @@ -18,28 +18,28 @@ check WEB_OPTION_LOGIN_URL, there is one | missing check WEB_OPTION_DISABLED_EXTENSIONS, in the line before, there is one | too much -sed -i "s/\;/\` \+\n\`/g" 4.0.5-5.0.0.adoc make each envvar a single line for ease of readability -sed -i "s/\`|/\`\n|/g" 4.0.5-5.0.0.adoc put the next | after the last envvar in a line into a new line -sed -i "s/|| \`/|\n|\`/g" 4.0.5-5.0.0.adoc split the || before an envvar into two lines -sed -i "s/services\/(.*)\//xref\:\{s-path\}\/\1\.adoc/g" 4.0.5-5.0.0.adoc make "service" a xref +sed -i "s/\;/\` \+\n\`/g" 4.0.0-5.0.0.adoc make each envvar a single line for ease of readability +sed -i "s/\`|/\`\n|/g" 4.0.0-5.0.0.adoc put the next | after the last envvar in a line into a new line +sed -i "s/|| \`/|\n|\`/g" 4.0.0-5.0.0.adoc split the || before an envvar into two lines +sed -i "s/services\/(.*)\//xref\:\{s-path\}\/\1\.adoc/g" 4.0.0-5.0.0.adoc make "service" a xref -sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/config.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.5-5.0.0.adoc -sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/reva.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.5-5.0.0.adoc -sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/debug.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.5-5.0.0.adoc -sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/log.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.5-5.0.0.adoc -sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/tracing.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.5-5.0.0.adoc -sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/cache.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.5-5.0.0.adoc -sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/content.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.5-5.0.0.adoc -sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/search.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.5-5.0.0.adoc -sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/options.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.5-5.0.0.adoc +sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/config.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.0-5.0.0.adoc +sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/reva.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.0-5.0.0.adoc +sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/debug.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.0-5.0.0.adoc +sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/log.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.0-5.0.0.adoc +sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/tracing.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.0-5.0.0.adoc +sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/cache.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.0-5.0.0.adoc +sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/content.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.0-5.0.0.adoc +sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/search.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.0-5.0.0.adoc +sed -i "s/\(services\/\)\(.*\)\(\/pkg\/config\/options.go\)/xref\:\{s-path\}\/\2.adoc\[\2\]/g" 4.0.0-5.0.0.adoc services/antivirus/pkg/config/config.go --> xref:{s-path}/antivirus.adoc[antivirus] change: ocis-pkg/shared/shared_types.go --> Available in multiple services -sed -i "s/\]|/\]\n|/g" 4.0.5-5.0.0.adoc put tab separator of service and envvar into a new line -sed -i "s/|\`/| \`/g" 4.0.5-5.0.0.adoc |`OCIS --> | `OCIS +sed -i "s/\]|/\]\n|/g" 4.0.0-5.0.0.adoc put tab separator of service and envvar into a new line +sed -i "s/|\`/| \`/g" 4.0.0-5.0.0.adoc |`OCIS --> | `OCIS -sed -i 's/\.\./\./g' 4.0.5-5.0.0.adoc remove trailing double dots in sentences +sed -i 's/\.\./\./g' 4.0.0-5.0.0.adoc remove trailing double dots in sentences manually fix (remove) any double occurrences if a service like clientlog, auth-service, graph, ocm, policies, postprocessing, search, sse. this is because the origin path points to different go routines inside the same service.