Skip to content

Commit

Permalink
Merge pull request #116 from cisagov/improvement/get-rid-of-latex-war…
Browse files Browse the repository at this point in the history
…nings

Get rid of LaTeX warning
  • Loading branch information
jsf9k authored Nov 28, 2023
2 parents d15058b + 065e579 commit 051b5b7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ expects the secrets in a different location.
To run the `cisagov/trustymail_reporter` image via Docker:

```console
docker run cisagov/trustymail_reporter:1.5.3
docker run cisagov/trustymail_reporter:1.5.4
```

### Running with Docker Compose ###
Expand All @@ -43,7 +43,7 @@ docker run cisagov/trustymail_reporter:1.5.3

services:
trustymail_reporter:
image: cisagov/trustymail_reporter:1.5.3
image: cisagov/trustymail_reporter:1.5.4
volumes:
- type: bind
source: <your_log_dir>
Expand Down Expand Up @@ -102,7 +102,7 @@ environment variables. See the
services:
trustymail_reporter:
image: cisagov/trustymail_reporter:1.5.3
image: cisagov/trustymail_reporter:1.5.4
volumes:
- type: bind
source: <your_log_dir>
Expand Down Expand Up @@ -141,7 +141,7 @@ environment variables. See the
1. Pull the new image:

```console
docker pull cisagov/trustymail_reporter:1.5.3
docker pull cisagov/trustymail_reporter:1.5.4
```

1. Recreate and run the container by following the [previous instructions](#running-with-docker).
Expand All @@ -151,11 +151,11 @@ environment variables. See the
The images of this container are tagged with [semantic
versions](https://semver.org) of the underlying example project that they
containerize. It is recommended that most users use a version tag (e.g.
`:1.5.3`).
`:1.5.4`).

| Image:tag | Description |
|-----------|-------------|
|`cisagov/trustymail_reporter:1.5.3`| An exact release version. |
|`cisagov/trustymail_reporter:1.5.4`| An exact release version. |
|`cisagov/trustymail_reporter:1.5`| The most recent release matching the major and minor version numbers. |
|`cisagov/trustymail_reporter:1`| The most recent release matching the major version number. |
|`cisagov/trustymail_reporter:edge` | The most recent image built from a merge into the `develop` branch of this repository. |
Expand Down Expand Up @@ -220,7 +220,7 @@ Build the image locally using this git repository as the [build context](https:/

```console
docker build \
--tag cisagov/trustymail_reporter:1.5.3 \
--tag cisagov/trustymail_reporter:1.5.4 \
https://github.com/cisagov/trustymail_reporter.git#develop
```

Expand Down Expand Up @@ -251,7 +251,7 @@ Docker:
--file Dockerfile-x \
--platform linux/amd64 \
--output type=docker \
--tag cisagov/trustymail_reporter:1.5.3 .
--tag cisagov/trustymail_reporter:1.5.4 .
```

## Contributing ##
Expand Down
5 changes: 3 additions & 2 deletions src/report/trustymail_report.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -367,14 +367,15 @@
\newpage
\renewcommand{\footrulewidth}{0.4pt}
\section{Executive Summary}
\label{sec:executive summary}
\label{sec:executive_summary}
Email underpins interactions between government agencies and enables direct correspondence with US citizens, immigrants, and international users. However, email was not built with security in mind, and without supplementary configuration or architecture it lacks important properties of trusted communication. Several email authentication technologies work in harmony to enable a recipient to detect and mitigate fraudulent email, particularly SPF and DMARC.

This weekly report, created by the \href{https://www.cisa.gov/}{Cybersecurity and Infrastructure Security Agency (CISA)}, is intended to assist your agency to comply with the email security aspects of \href{https://cyber.dhs.gov}{Binding Operational Directive (BOD) 18-01}. Implementation guidance can be found at \href{https://cyber.dhs.gov/bod/18-01}{https://cyber.dhs.gov/bod/18-01/\#compliance-guide}.

\vspace*{-3mm}
\phantomsection
\addcontentsline{toc}{subsection}{Overview} % Adds a subsection to toc
\subsection*{Overview}
\hypertarget{Overview}{\subsection*{Overview}}
\vspace*{-3mm}
\raggedright
We measure the presence of SPF and DMARC records in the DNS for your agency's publicly accessible .gov hostnames, as well as support for STARTTLS by your agency's SMTP servers. This report includes all agency-registered \href{https://github.com/cisagov/dotgov-data/blob/main/current-federal.csv}{second-level .gov domains} and known subdomains, collectively referred to as ``hostnames" in this document. Any hostnames that respond with NXDOMAIN (``nonexistent") in the public DNS are removed from the compliance figures below.\\~\\
Expand Down
2 changes: 1 addition & 1 deletion src/version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.5.3"
__version__ = "1.5.4"

0 comments on commit 051b5b7

Please sign in to comment.