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. Settings for the other source can stay unset. With no source configured, the service starts and logs a warning.

Source

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

Connections

Key Default Description
wikishift.env.DB2_HOSTNAME — Connections DB2 host
wikishift.env.DB2_PORT — DB2 port, usually 50000
wikishift.env.DB2_DATABASE — Wikis database, usually WIKIS
wikishift.env.DB2_UID / DB2_PWD — DB2 user and password
wikishift.env.DB2_PROTOCOL TCPIP DB2 connection protocol
wikishift.env.DB2_POOL_SIZE 10 DB2 connections at once
wikishift.env.WIKIS_CONTENT_DIR — Connections Wikis upload folder (page bodies and attachments), mounted read-only from the shared drive, e.g. /data/wikis/upload
wikishift.env.CNX_HOSTNAME — Connections URL, e.g. https://[CONNECTIONS_HOST]. Used to link a migrated community wiki back to its community

Confluence

Key Default Description
wikishift.env.CONFLUENCE_BASE_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_ATTACHMENTS_DIR — Required when reading the database: read-only mount of <confluence-home>/attachments. Attachments are on the Confluence filesystem, not in its database. Not used with CONFLUENCE_EXPORT_DIR
wikishift.env.CONFLUENCE_JIRA_URL — Jira URL for jira macros. Unset leaves issue keys as text
wikishift.env.CONFLUENCE_DB_TYPE — postgres, mysql, mssql or oracle
wikishift.env.CONFLUENCE_DB_HOST — Database host
wikishift.env.CONFLUENCE_DB_PORT per engine Default 5432, 3306, 1433 or 1521
wikishift.env.CONFLUENCE_DB_DATABASE — Database name
wikishift.env.CONFLUENCE_DB_USER / CONFLUENCE_DB_PASSWORD — Database user and password. Read-only access is enough
wikishift.env.CONFLUENCE_DB_SCHEMA — Postgres search_path, or the Oracle table owner
wikishift.env.CONFLUENCE_DB_POOL_SIZE 5 Database connections at once
wikishift.env.CONFLUENCE_DB_STATEMENT_TIMEOUT_MS 30000 Longest one query may run
wikishift.env.CONFLUENCE_DB_ENCRYPT "true" SQL Server only: encrypt the connection
wikishift.env.CONFLUENCE_EXPORT_DIR — Instead of a database: a folder of Confluence space export zips, or one unpacked export. Wins over CONFLUENCE_DB_* when both are set
wikishift.env.CONFLUENCE_EXPORT_TIMEZONE pod's zone 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

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
wikishift.env.STARTUP_QUERY — A read-only SQL query run against the source database, with the result in the pod log. For diagnosis

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