OptimiDoc Server Help Center
OptimiDoc Server Help Center
Breadcrumbs

Changing the Web Port

The OptimiDoc web console and API are hosted in IIS, so the port they listen on is simply the IIS site binding. You might change it to avoid a conflict with another web application or to satisfy a network policy. This guide walks through changing the binding and — just as importantly — updating everything that refers back to the server on the old port.

How OptimiDoc Uses the Web Port

Everything that talks to OptimiDoc over HTTP(S) uses this one port: browsers reaching the admin console, the API consumed by the React UI, device agents calling home, printing nodes submitting jobs, and OAuth providers redirecting back after sign-in. Because the console is served from IIS:

  • The default binding is HTTPS on 443 (and optionally HTTP on 80).

  • Browsing the root URL redirects to the React UI at /ui (the primary admin interface); the legacy console remains available at /old.

  • This web port is separate from the driverless-print IPP port (631) and from any printing-node ports — changing one does not change the others.

Changing the port affects every client, so plan it into a maintenance window and work through the follow-up steps below, not just the binding itself.

Before You Begin

  • Changing the web port affects how all clients (browsers, devices, printing nodes, OAuth callbacks) connect to OptimiDoc.

  • You will need to update device agent URLs, printing-node configuration, OAuth redirect URIs, firewall rules, and any bookmarks.

  • Schedule the change during a maintenance window, as it briefly disrupts service.

Step 1 — Open IIS Manager

  1. On the OptimiDoc server, open IIS Manager (run inetmgr).

  2. In the left pane, expand the server node and then Sites.

  3. Select the OptimiDoc site.

Step 2 — Edit Site Bindings

  1. In the Actions pane, click Bindings.

  2. Select the binding you want to change (for example https on port 443) and click Edit.

  3. Change the Port field to the desired value (e.g. 8443 for HTTPS).

  4. Click OK. If you have both HTTP and HTTPS bindings, update both as needed.

  5. Confirm the correct SSL certificate is still selected on the HTTPS binding.

  6. Close the dialogue.

Step 3 — Update Firewall Rules

  1. Open Windows Firewall with Advanced Security on the server.

  2. Under Inbound Rules, modify (or add) a rule to allow TCP on the new port:

    • Rule type: Port

    • Protocol: TCP

    • Specific local port: the new port (e.g. 8443)

    • Action: Allow

  3. If a network firewall sits between clients/devices and the server, update it too.

Step 4 — Update Components That Reference the Server URL

The port lives in the address that other components use to reach OptimiDoc, so update each of them:

Component

What to update

Device agents

Each device's OptimiDoc server URL must include the new port. Update the affected devices (or reinstall their agents) from the Devices page.

Printing nodes

On every printing node, set optimidoc.url in its App.config to the new server URL, then restart the node service.

OAuth redirect URIs

For cloud connectors and mailboxes that use OAuth, the redirect URI registered with the provider must match the new host and port.

Cluster addressing

In a cluster, each server node's binding is picked up from IIS automatically on restart; verify the Cluster address / Local DNS under Settings > Cluster Configuration still resolve to the new port where they include one.

Bookmarks & links

Update any saved links or documentation that hard-code the old port.

Step 5 — Restart and Verify

  1. Restart the OptimiDoc site in IIS Manager (Restart in the Actions pane).

  2. Browse to the OptimiDoc URL with the new port, e.g. https://optimidoc.company.com:8443 — it should redirect to /ui and show the login page.

  3. Log in as administrator.

  4. Confirm devices show as online under Devices (this is the clearest sign agents can still reach the server).

  5. Run a pull-print and a scan test to confirm end-to-end functionality.

Troubleshooting

Problem

Solution

"Connection refused" on the new port

Verify the IIS binding saved correctly and the firewall allows the new port

Devices offline after the change

Update each device's server URL (new port); reinstall the agent if needed

Printing node stops delivering jobs

Update optimidoc.url on the node and restart its service

OAuth sign-in fails for a connector

Update the redirect URI at the provider to include the new host and port

SSL warning on the new port

Ensure the SSL certificate is bound to the new port in IIS

Port already in use

Choose a different port; check conflicts with netstat -an

Related articles