Skip to content

WikiShift Configuration

wikishift.enabled: true deploys the Wikis migration utility. It reads one source, chosen by SOURCE_PROVIDER: HCL Connections Wikis from DB2, or Confluence from its database or from space exports. The service checks the settings for that source when it starts and stops with an error naming any that are missing. Settings for the other source can stay unset.

Source

Key Default Description
wikishift.env.SOURCE_PROVIDER connections connections or confluence

Source database

Used by Connections, and by Confluence when it reads the database rather than exports.

Key Default Description
wikishift.env.DB_TYPE db2 db2 for Connections. For Confluence: postgres, mysql, mssql or oracle
wikishift.env.DB_HOST — Required: database host
wikishift.env.DB_PORT per engine Default 50000, 5432, 3306, 1433 or 1521
wikishift.env.DB_DATABASE WIKIS for Connections Database name. Required for Confluence
wikishift.env.DB_USER / DB_PASSWORD — Required: database user and password. Read-only access is enough
wikishift.env.DB_POOL_SIZE 10 Connections, 5 Confluence Database connections at once
wikishift.env.DB_PROTOCOL TCPIP DB2 only: connection protocol
wikishift.env.DB_SCHEMA — Postgres search_path, or the Oracle table owner
wikishift.env.DB_STATEMENT_TIMEOUT_MS 30000 Longest one query may run
wikishift.env.DB_ENCRYPT "true" SQL Server only: encrypt the connection
wikishift.env.TZ UTC Set it: IANA time zone of the source database server, e.g. Europe/London or Australia/Hobart (list). Connections and Confluence store dates without an offset, so a wrong zone shifts every migrated date by the difference
wikishift.env.SOURCE_FILES_DIR — Required: read-only mount of the source's files. Connections: the Wikis upload folder from the shared drive, e.g. /data/wikis/upload. Confluence: <confluence-home>/attachments, since attachments are on the Confluence filesystem, not in its database

Connections

Key Default Description
wikishift.env.CONNECTIONS_HOSTNAME ic-host from connections-env Connections host name, without https://. Component Pack sets it from the connections-env ConfigMap
wikishift.env.CONNECTIONS_URL https://[CONNECTIONS_HOSTNAME] Connections URL. Content goes to the organisation of the connections client with this URL, and migrated community wikis link back to their community through it. Set it only if user.env.CONNECTIONS_URL is not https:// plus the host name, and then to the same value

Confluence

Key Default Description
wikishift.env.CONFLUENCE_URL — Required: Confluence site URL, e.g. https://confluence.example.com. Register a confluence client with this base URL in the target organisation before you migrate: migrated users are created on it, and it decides which organisation the content goes to
wikishift.env.CONFLUENCE_EXPORT_DIR — Instead of a database: a folder of Confluence space export zips, or one unpacked export. With it set, the source database settings and SOURCE_FILES_DIR are not needed
wikishift.env.CONFLUENCE_EXPORT_TIMEZONE TZ IANA time zone of the Confluence server that made the exports, e.g. Europe/Zurich. Exports store times without an offset, so a wrong zone shifts every migrated date
wikishift.env.CONFLUENCE_JIRA_URL — Jira URL for jira macros. Unset leaves issue keys as text

Run on startup

Each boot reads the source's wiki list and logs the count, so an unreachable source shows up at once. These keys also start work on boot; remove them after the run, or the next restart repeats it.

Key Default Description
wikishift.env.IMMEDIATELY_PROCESS_ALL "false" "true" migrates every wiki in the source
wikishift.env.IMMEDIATELY_MIGRATE_IDS — Comma-separated source wiki IDs to migrate
wikishift.env.PURGE_MIGRATED_IDS — Comma-separated source wiki IDs whose migrated wiki is deleted first, to migrate it again

Tuning

Key Default Description
wikishift.env.CONCURRENCY_WIKIS 5 Wikis migrated at once
wikishift.env.CONCURRENCY_PAGES_PER_WIKI 3 Pages at once within one wiki
wikishift.env.CONCURRENCY_FILES_PER_WIKI 3 Attachments at once within one wiki
wikishift.env.CONCURRENCY_COMMENTS_PER_WIKI 5 Comments at once within one wiki
wikishift.env.CONCURRENCY_ACL_PER_WIKI 5 Access entries at once within one wiki
wikishift.env.TRANSACTION_TIMEOUT_MINS 5 Longest one migration database transaction may take, in minutes