The term “locked-down” in this article mainly refers to networking, where network configuration in an environment prohibits WikiTraccs from calling anything else than Confluence and Microsoft 365-related endpoints.
How Is the Migration Affected by Limited Endpoint Access?
The following migration tasks would need endpoints other than Confluence and Microsoft 365:
- Logging in to Confluence using Interactive authentication (requires downloading Chrome Webdriver)
- Migrating external images (requires downloading those external images)
- Migrating Confluence Cloud whiteboards (requires Chrome Webdriver)
- Creating draw.io preview images (requires downloading the draw.io diagram viewer and potentially linked resources like images and fonts, as well as the Chrome Webdriver)
- Migrating Jira macros (requires reaching out to Jira)
- Checking for WikiTraccs updates (requires reaching out to GitHub)
The following sections describe implications, related WikiTraccs settings, and workarounds for any of the above points.
Major Impact: Blocking Chrome Webdriver Download
Several migration tasks need to be run in a real Chrome browser which is remote-controlled by WikiTraccs.
To remote-control the browser, WikiTraccs will automatically download the required tool, the Chrome Webdriver.
Required endpoints are documented here: Endpoints - Automatic Chrome Webdriver Download.
If any of the required endpoints is blocked, you can manually provide the correct configuration values and Chrome Webdriver version as described here: How to handle blocked Google Chrome Webdriver Endpoints.
Note that if you cannot provide the Chrome Webdriver to WikiTraccs, you’ll lose several features like interactive authentication, whiteboard migration, draw.io preview image generation, and access to some Confluence APIs that are not accessible otherwise (mostly Cloud-related).
Refer to some of the following sections for details.
Blocking Interactive Authentication
When choosing Interactive authentication for Confluence, WikiTraccs needs to open and remote-control a browser for you to be able to log in to Confluence, and to get the session cookies.
When Chrome Webdriver download is blocked, Interactive Authentication is not possible anymore.
Use Personal Access Token or one of the workarounds reserved for harder cases.
Blocking Migration of External Images
Confluence allows using images from external (non-Confluence) locations in wiki pages. When such a page opens, the browser will load the image from the external location.
SharePoint Online doesn’t allow loading images from external locations due to privacy concerns. That’s why WikiTraccs, when migrating such a page, downloads the external image and uploads it as page attachment to SharePoint.
If external endpoints are blocked, those external images will be missing in SharePoint.
Note that you can explicitly turn off downloading of external images in WikiTraccs’ settings, speeding up the migration, as WikiTraccs then won’t reach out to external hosts.
Blocking Whiteboard Download (Confluence Cloud)
Whiteboard download needs to be done in a browser that is remote-controlled by WikiTraccs, which requires the Chrome Webdriver to be in place.
See above section Blocking Interactive Authentication, the same reasoning applies.
Note that you can explicitly turn off whiteboard migration in WikiTraccs’ settings.
Blocking Draw.io Image Generation
Draw.io image generation needs to be done in a browser that is remote-controlled by WikiTraccs, which requires the Chrome Webdriver to be in place.
See above section Blocking Interactive Authentication, the same reasoning applies.
Furthermore, at least one additional endpoint is required to download the draw.io viewer application. See Prerequisites for Draw.io Preview Image Generation for details.
When starting a migration run, WikiTraccs tests if draw.io images can be generated. If not, the feature is automatically disabled during this migration run.
Blocking Jira Access
You can prevent WikiTraccs from reaching out to Jira by using this configuration snippet: Prevent WikiTraccs from reaching out to Jira.
Proxy Configuration
When configuring *_PROXY environment variables, make sure to add http://localhost to the NO_PROXY environment variable. This is required for the automated Chrome browser to work properly.