Merge pull request #88 from userjack6880/dev

userjack6880 · web-flow · commit 1507f0ba95aa · 2023-04-28T15:31:58.000-05:00
Dev to main release
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -24,9 +24,9 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Software Version**
-[] Version 1 Beta 4
-[] Version 1 Beta 3
-[] Other
+[ ] Version 1 Release Candidate 1
+[ ] Version 1 Beta 4
+[ ] Other
 
 **Desktop (please complete the following information):**
  - OS [e.g. macOS]
diff --git a/.github/ISSUE_TEMPLATE/critical_report.md b/.github/ISSUE_TEMPLATE/critical_report.md
@@ -24,9 +24,9 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Software Version**
-[] Version 1 Beta 4
-[] Version 1 Beta 3
-[] Other
+[ ] Version 1 Release Candidate 1
+[ ] Version 1 Beta 4
+[ ] Other
 
 **Desktop (please complete the following information):**
  - OS [e.g. macOS]
diff --git a/README.md b/README.md
@@ -5,13 +5,13 @@ Open DMARC Analyzer is an Open Source DMARC Report Analyzer to be used with DMAR
 
 Open DMARC Analyzer was written because there didn't seem to be a full-featured self-hosted report analyzer that provided enough details to make heads or tails of a large volume of DMARC reports that come into medium to large-sized organizations. While other solutions required paid subscriptions or have part of it hosted on AWS, Open DMARC Analyzer will run on any webserver that supports PHP 7.4+ and MySQL 15.1+.
 
-Open DMARC Analyzer Version 1 Beta 4 (1-β4) is an [Anomaly \<Codebase\>](https://systemanomaly.com/codebase) project by John Bradley (john@systemanomaly.com)
+Open DMARC Analyzer Version 1 Release Candidate 1 (1-rc1) is an [Anomaly \<Codebase\>](https://systemanomaly.com/codebase) project by John Bradley (john@systemanomaly.com)
 
 # Minimum Requirements
 - Apache 2 or equivalent
-- PHP 5 (PHP 7 required for phpWhois)
+- PHP 5 (PHP 7+ required for phpWhois)
 - PHP PDO
-- MySQL 15.1 or equivalent
+- MySQL 15.1 (or equivalent) *or* PostgreSQL 13
 - **A database that is pre-populated with data from [Open Report Parser](https://github.com/userjack6880/Open-Report-Parser)**
 
 # Dependencies
@@ -20,7 +20,7 @@ One of the following 2 packages are required to be installed.
 
 **[jsmitty12/phpWhois](https://github.com/jsmitty12/phpWhois/)**
 
-It is highly recommended that you install this package using composer. Instructions are found on the package's git page. This is required, and will replace most GeoIP data if you disable the MaxMind DB reader package. This package *will* require PHP 7.
+It is highly recommended that you install this package using composer. Instructions are found on the package's git page. This is required, and will replace most GeoIP data if you disable the MaxMind DB reader package. This package *will* require PHP 7 or newer.
 
 **[MaxMind DB Reader PHP API](https://github.com/maxmind/MaxMind-DB-Reader-php)**
 
@@ -57,7 +57,8 @@ define('DB_HOST', 'localhost');
 define('DB_USER', 'dmarc');
 define('DB_PASS', 'password');
 define('DB_NAME', 'dmarc');
-define('DB_PORT', '3306'); // default port 3306
+define('DB_PORT', '3306'); // default port 3306, 5432 for pgsql
+define('DB_TYPE', 'mysql'); // supported mysql and pgsql
 ```
 
 **Debug Settings**
@@ -97,8 +98,9 @@ Valid date signifiers are `m`, `w`, and `d` for "month", "week", and "day".
 
 # Latest Changes
 
-## 1-β4
-- PostgresSQL validation and fixes backported from future Version 2 Alpha 1 branch.
+## 1-rc1
+- Documentation updates.
+- Carried forward backports from beta 4.
 
 See `CHANGELOG` under `docs` for full details of all changes.
 
@@ -124,9 +126,9 @@ Support will be provided as outlined in the following schedule. For more details
 
 | Version                             | Support Level    | Released         | End of Support   | End of Life      |
 | ----------------------------------- | ---------------- | ---------------- | ---------------- | ---------------- |
-| Version 1 Beta 4                    | Full Support     | 26 April 2023    | 1-rc1 Release    | TBD              |
-| Version 1 Beta 3                    | Critical Support | 19 April 2023    | 26 April 2023    | 1-rc1 Release    |
-| Version 1 Beta 2                    | End of Life      | 29 November 2022 | 19 April 2023    | 26 April 2023    |
+| Version 1 Release Candidate 1       | Full Support     | 28 April 2023    | 15 May 2023      | 31 December 2023 |
+| Version 1 Beta 4                    | Critical Support | 26 April 2023    | 28 April 2023    | 15 May 2023      |
+| Version 1 Beta 3                    | End of Life      | 19 April 2023    | 26 April 2023    | 28 April 2023    |
 
 # Contributing
 
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 1-rc1
+- Documentation updates.
+- Carried forward backports from beta 4.
+
 ## 1-β4
 - PostgresSQL validation and fixes backported from future Version 2 Alpha 1 branch.
 
diff --git a/docs/SECURITY.md b/docs/SECURITY.md
@@ -18,11 +18,12 @@ A response should be recieved within 72 hours. If no response is given, please f
 
 Open DMARC Analyzer Version Security Support
 
-| Version                    | Supported | End of Life      |
-| -------------------------- | --------- | ---------------- |
-| Version 1 Beta 4           | YES       | TBD              |
-| Version 1 Beta 3           | YES       | 1-rc1 Release    |
-| Version 1 Beta 2           | NO        | 26 April 2023    |
-| Version 1 Beta 1           | NO        | 19 April 2023    |
-| Version 1 Feature Complete | NO        | 29 November 2022 |
-| Version 0 Alpha 9          | NO        | 4 November 2022  |
+| Version                       | Supported | End of Life      |
+| ----------------------------- | --------- | ---------------- |
+| Version 1 Release Candidate 1 | YES       | 31 December 2023 |
+| Version 1 Beta 4              | YES       | 28 April 2023    |
+| Version 1 Beta 3              | NO        | 15 May 2023      |
+| Version 1 Beta 2              | NO        | 26 April 2023    |
+| Version 1 Beta 1              | NO        | 19 April 2023    |
+| Version 1 Feature Complete    | NO        | 29 November 2022 |
+| Version 0 Alpha 9             | NO        | 4 November 2022  |
diff --git a/docs/SUPPORT.md b/docs/SUPPORT.md
@@ -1,11 +1,12 @@
-# Software Support
+# Software Support Chart
 
 Due to the limited time available to developrs to maintain support, dates must be set where support must end. The following is a chart outlining the support shedule for Open DMARC Analyzer.
 
 | Version                             | Support Level    | Released         | End of Support   | End of Life      |
 | ----------------------------------- | ---------------- | ---------------- | ---------------- | ---------------- |
-| Version 1 Beta 4                    | Full Support     | 26 April 2023    | 1-rc1 Release    | TBD              |
-| Version 1 Beta 3                    | Critical Support | 19 April 2023    | 26 April 2023    | 1-rc1 Release    |
+| Version 1 Release Candidate 1       | Full Support     | 28 April 2023    | 15 May 2023      | 31 December 2023 |
+| Version 1 Beta 4                    | Critical Support | 26 April 2023    | 28 April 2023    | 15 May 2023      |
+| Version 1 Beta 3                    | End of Life      | 19 April 2023    | 26 April 2023    | 28 April 2023    |
 | Version 1 Beta 2                    | End of Life      | 29 November 2022 | 19 April 2023    | 26 April 2023    |
 | Version 1 Beta 1                    | End of Life      | 4 November 2022  | 29 November 2022 | 19 April 2023    |
 | Version 1 Feature Complete          | End of Life      | 27 July 2022     | 4 November 2022  | 29 November 2022 |
@@ -14,6 +15,13 @@ Due to the limited time available to developrs to maintain support, dates must b
 | Version 0 Alpha 8.1                 | End of Life      | 30 March 2022    | 31 March 2022    | 2 May 2022       |
 | Version 0 Alpha 8 or Older          | End of Life      | 29 March 2022    | 30 March 2022    | 30 March 2022    |
 
+# Support Cycle
+
+- Pre-stable versions recieve one version cycle of full spport and one cycle of critical support before being considered end of life. Due to the lack of release cycle for these versions, support time can wildly vary.
+- The final release candidate will have critical support until the end of a year that the stable version is released.
+- All versions of a stable version are considered supported, though it is encouraged to keep updated to the latest stable release.
+- Stable versions reach end of life at the end of a year that a new stable version is released. The exception is LTS versions - those will recieve 3 years of support after a new stable version is released.
+
 # Support Levels
 
 - **Full Support** means that software will recieve regular bug fixes, feature updates (if applicable), and security fixes. All current versions do not have an expected End of Support or End of Life date, as new version releases are not always predictable.
diff --git a/includes/template.php b/includes/template.php
@@ -31,7 +31,7 @@
 // Versioning -----------------------------------------------------------------
 function oda_version() {
 
-  echo "1-β4";
+  echo "1-rc1";
 
 }
 

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`// Versioning -----------------------------------------------------------------`
`32`	`32`	`function oda_version() {`
`33`	`33`
`34`		`- echo "1-β4";`
	`34`	`+ echo "1-rc1";`
`35`	`35`
`36`	`36`	`}`
`37`	`37`