Skip to content

Commit 5f91ef8

Browse files
mefellowsmefellows
committed
docs: 2.x migration guide
1 parent 4ae3f0d commit 5f91ef8

File tree

4 files changed

+65
-57
lines changed

4 files changed

+65
-57
lines changed

‎website/docs/docs/on-premises.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ title: PactFlow On-Premises Architecture
33
sidebar_label: Architecture
44
---
55

6+
:::warning
7+
The 1.x line of PactFlow On-Prem is now in maintenance mode and will only receive security updates. It will reach end of life on March 11, 2026, after which it will no longer be supported.
8+
9+
To ensure you have access to the latest features and improvements, please upgrade to 2.x as soon as possible.
10+
:::
11+
612
## System architecture
713

814
### Minimum requirements

‎website/docs/docs/on-premises/releases/2.0.0.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,10 @@ For full details, including installation instructions, refer to the [2.x.x docum
3535

3636
Please review the following updates when migrating to version 2.0.0:
3737

38-
1. A [Redis-compatible data store](/docs/on-premises-2x/redis) is now required.
38+
1. A [Redis-compatible data store](/docs/on-premises-2x/redis) is now required
39+
1. Ensure you set the [`REDIS_URL`](/docs/on-premises-2x/environment-variables#redis_url) environment variable.
3940
2. `PACTFLOW_COOKIE_SECRET` must now be at least 64 characters. [More info](/docs/on-premises-2x/environment-variables#pactflow_cookie_secret).
4041
3. The `PACTFLOW_LOG_FORMAT` environment variable is deprecated and has no effect. All logs are now output in JSON only.
4142
4. The base image has changed from Alpine Linux to Ubuntu 24.04. If you have customized the image, review your setup and update any installed tools or libraries accordingly.
4243

43-
> **Note:** There are no breaking API or database changes in this release. All existing API calls, SDKs, and CLI integrations will continue to work as expected.
44+
> **Note:** There are no breaking API or database changes in this release. All existing API calls, SDKs, and CLI integrations will continue to work as expected.

‎website/docusaurus.config.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ module.exports = {
3838
position: "left",
3939
},
4040
{ to: "docs/examples", label: "Examples", position: "left" },
41-
{ to: "docs/on-premises", label: "On-Premises", position: "left" },
41+
{ to: "docs/on-premises-2x", label: "On-Premises", position: "left" },
4242
{ to: "notices", label: "Notices", position: "left" },
4343
{ to: "https://support.smartbear.com/pactflow/message/", label: "Support ↗", position: "left" },
4444
],

‎website/sidebars.js‎

Lines changed: 55 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -371,153 +371,154 @@ module.exports = {
371371
onprem: [
372372
{
373373
type: "category",
374-
label: "On-Premises 1.x",
374+
label: "On-Premises 2.x",
375375
items: [
376376
{
377377
type: "category",
378378
label: "Installation",
379379
items: [
380-
"docs/on-premises",
381-
"docs/on-premises/system-requirements",
382-
"docs/on-premises/docker-image-registry",
383-
"docs/on-premises/network-configuration",
384-
"docs/on-premises/installation/migrating",
385-
"docs/on-premises/database",
386-
"docs/on-premises/observability",
387-
"docs/on-premises/logging",
380+
"docs/on-premises-2x",
381+
"docs/on-premises-2x/system-requirements",
382+
"docs/on-premises-2x/migrating-from-1x",
383+
"docs/on-premises-2x/docker-image-registry",
384+
"docs/on-premises-2x/network-configuration",
385+
"docs/on-premises-2x/installation/migrating",
386+
"docs/on-premises-2x/database",
387+
"docs/on-premises-2x/redis",
388+
"docs/on-premises-2x/observability",
389+
"docs/on-premises-2x/logging",
388390
{
389391
type: "category",
390392
label: "Authentication",
391393
items: [
392-
"docs/on-premises/authentication/demo",
393-
"docs/on-premises/authentication/saml",
394+
"docs/on-premises-2x/authentication/demo",
395+
"docs/on-premises-2x/authentication/saml",
394396
],
395397
},
396398
{
397399
type: "category",
398400
label: "Application configuration",
399401
items: [
400-
"docs/on-premises/environment-variables",
401-
"docs/on-premises/environment-variables/templates",
402-
"docs/on-premises/environment-variables/timezones",
403-
"docs/on-premises/license",
402+
"docs/on-premises-2x/environment-variables",
403+
"docs/on-premises-2x/environment-variables/templates",
404+
"docs/on-premises-2x/environment-variables/timezones",
405+
"docs/on-premises-2x/license",
404406
],
405407
},
406-
"docs/on-premises/docker-compose-example",
407-
"docs/on-premises/installation/load-testing",
408-
"docs/on-premises/installation/checklist",
408+
"docs/on-premises-2x/docker-compose-example",
409+
"docs/on-premises-2x/installation/load-testing",
410+
"docs/on-premises-2x/installation/checklist",
409411
],
410412
},
411413
{
412414
type: "category",
413415
label: "Upgrading",
414-
items: ["docs/on-premises/upgrading/database-migrations"],
416+
items: ["docs/on-premises-2x/upgrading/database-migrations"],
415417
},
416418
{
417419
type: "category",
418420
label: "Operation",
419-
items: ["docs/on-premises/authentication"],
421+
items: ["docs/on-premises-2x/authentication"],
420422
},
421423
{
422424
type: "category",
423425
label: "Maintenance",
424-
items: ["docs/on-premises/maintenance/database"],
426+
items: ["docs/on-premises-2x/maintenance/database"],
425427
},
426428
{
427429
type: "category",
428430
label: "SCIM",
429-
items: ["docs/on-premises/scim"],
431+
items: ["docs/on-premises-2x/scim"],
430432
},
431433
{
432434
type: "category",
433435
label: "Security and support",
434436
items: [
435-
"docs/on-premises/security-audit-report",
436-
"docs/on-premises/support-policy",
437+
"docs/on-premises-2x/security-audit-report",
438+
"docs/on-premises-2x/support-policy",
437439
],
438440
},
439441
{
440442
type: "category",
441443
label: "Troubleshooting",
442-
items: ["docs/on-premises/troubleshooting"],
443-
}
444+
items: ["docs/on-premises-2x/troubleshooting"],
445+
},
444446
],
445447
},
446448
{
447449
type: "category",
448-
label: "On-Premises 2.x",
450+
label: "On-Premises 1.x",
449451
items: [
450452
{
451453
type: "category",
452454
label: "Installation",
453455
items: [
454-
"docs/on-premises-2x",
455-
"docs/on-premises-2x/system-requirements",
456-
"docs/on-premises-2x/docker-image-registry",
457-
"docs/on-premises-2x/network-configuration",
458-
"docs/on-premises-2x/installation/migrating",
459-
"docs/on-premises-2x/database",
460-
"docs/on-premises-2x/redis",
461-
"docs/on-premises-2x/observability",
462-
"docs/on-premises-2x/logging",
456+
"docs/on-premises",
457+
"docs/on-premises/system-requirements",
458+
"docs/on-premises/docker-image-registry",
459+
"docs/on-premises/network-configuration",
460+
"docs/on-premises/installation/migrating",
461+
"docs/on-premises/database",
462+
"docs/on-premises/observability",
463+
"docs/on-premises/logging",
463464
{
464465
type: "category",
465466
label: "Authentication",
466467
items: [
467-
"docs/on-premises-2x/authentication/demo",
468-
"docs/on-premises-2x/authentication/saml",
468+
"docs/on-premises/authentication/demo",
469+
"docs/on-premises/authentication/saml",
469470
],
470471
},
471472
{
472473
type: "category",
473474
label: "Application configuration",
474475
items: [
475-
"docs/on-premises-2x/environment-variables",
476-
"docs/on-premises-2x/environment-variables/templates",
477-
"docs/on-premises-2x/environment-variables/timezones",
478-
"docs/on-premises-2x/license",
476+
"docs/on-premises/environment-variables",
477+
"docs/on-premises/environment-variables/templates",
478+
"docs/on-premises/environment-variables/timezones",
479+
"docs/on-premises/license",
479480
],
480481
},
481-
"docs/on-premises-2x/docker-compose-example",
482-
"docs/on-premises-2x/installation/load-testing",
483-
"docs/on-premises-2x/installation/checklist",
482+
"docs/on-premises/docker-compose-example",
483+
"docs/on-premises/installation/load-testing",
484+
"docs/on-premises/installation/checklist",
484485
],
485486
},
486487
{
487488
type: "category",
488489
label: "Upgrading",
489-
items: ["docs/on-premises-2x/upgrading/database-migrations"],
490+
items: ["docs/on-premises/upgrading/database-migrations"],
490491
},
491492
{
492493
type: "category",
493494
label: "Operation",
494-
items: ["docs/on-premises-2x/authentication"],
495+
items: ["docs/on-premises/authentication"],
495496
},
496497
{
497498
type: "category",
498499
label: "Maintenance",
499-
items: ["docs/on-premises-2x/maintenance/database"],
500+
items: ["docs/on-premises/maintenance/database"],
500501
},
501502
{
502503
type: "category",
503504
label: "SCIM",
504-
items: ["docs/on-premises-2x/scim"],
505+
items: ["docs/on-premises/scim"],
505506
},
506507
{
507508
type: "category",
508509
label: "Security and support",
509510
items: [
510-
"docs/on-premises-2x/security-audit-report",
511-
"docs/on-premises-2x/support-policy",
511+
"docs/on-premises/security-audit-report",
512+
"docs/on-premises/support-policy",
512513
],
513514
},
514515
{
515516
type: "category",
516517
label: "Troubleshooting",
517-
items: ["docs/on-premises-2x/troubleshooting"],
518-
},
518+
items: ["docs/on-premises/troubleshooting"],
519+
}
519520
],
520-
},
521+
},
521522
{
522523
type: "category",
523524
label: "Releases",

0 commit comments

Comments
 (0)