Updated tex files with latest information about the program
This commit is contained in:
iparenteau committed
1 parent
f0716b0073
commit
0f8db48407
91 files changed
+489
-822
No files matched your search
@@ -1,10 +1,11 @@
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% FILE : ApacheAppendix.tex
|
||||
% SUBJECT : ApacheApendex.
|
||||
% AUTHOR : (C) Copyright 2018 by Locusworks
|
||||
%
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
\chapter{Apache Configuration}
|
||||
\label{sample-httpd.conf}
|
||||
\lstinputlisting[caption=httpd.conf]{figures/httpd.conf}
|
||||
For Apache HTTP Server 2.4.47 or newer, \command{mod\_proxy\_http} can forward WebSocket upgrades. Enable \command{mod\_proxy}, \command{mod\_proxy\_http}, \command{mod\_headers}, and the TLS modules. Place these directives in your HTTPS virtual host, with your hostname and certificates configured separately:
|
||||
\begin{lstlisting}[caption={Apache forwarding directives}]
|
||||
ProxyRequests Off
|
||||
ProxyPreserveHost On
|
||||
RequestHeader set X-Forwarded-Proto "https"
|
||||
ProxyPass /portal/ http://127.0.0.1:8080/portal/ upgrade=websocket
|
||||
ProxyPassReverse /portal/ http://127.0.0.1:8080/portal/
|
||||
\end{lstlisting}
|
||||
Redirect the HTTP site to HTTPS. Match proxy request limits and timeouts to the application. Consult \url{https://httpd.apache.org/docs/2.4/mod/mod_proxy_http.html} for the installed Apache version's upgrade handling.
|
||||
@@ -1,10 +1,24 @@
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% FILE : Architecture.tex
|
||||
% SUBJECT : Document describing architecture issues in the entire Patch Repository system.
|
||||
% AUTHOR : (C) Copyright 2018 by Locusworks
|
||||
%
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
\chapter{NGINX Configuration}
|
||||
\label{sample-nginx.conf}
|
||||
\lstinputlisting[caption=portal.conf]{figures/portal.conf}
|
||||
Place the map in the \command{http} context and the location in your site's HTTPS server block. Configure your hostname, TLS certificates, and HTTP-to-HTTPS redirect in the surrounding site configuration. This forwards the application context and supports WebSocket upgrades.
|
||||
\begin{lstlisting}[caption={NGINX forwarding directives}]
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
'' close;
|
||||
}
|
||||
|
||||
# Inside the HTTPS server block:
|
||||
location /portal/ {
|
||||
client_max_body_size 10m;
|
||||
proxy_pass http://127.0.0.1:8080;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_read_timeout 600s;
|
||||
}
|
||||
\end{lstlisting}
|
||||
See \url{https://nginx.org/en/docs/http/websocket.html} for WebSocket forwarding details.
|
||||
@@ -1,10 +1,29 @@
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% FILE : Architecture.tex
|
||||
% SUBJECT : Document describing architecture issues in the entire Patch Repository system.
|
||||
% AUTHOR : (C) Copyright 2018 by Locusworks
|
||||
%
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
\chapter{Portal Properties File}
|
||||
\label{sample-portal.properties}
|
||||
\lstinputlisting[caption=portal.properties]{figures/portal.properties}
|
||||
Portal initializes persistent settings from its bundled defaults. The file lives in the resolved application home (Section~\ref{portal-home}). New installations use \command{dbType=h2}; existing installations retain their configured database type. The following excerpt shows the current non-secret defaults:
|
||||
\begin{lstlisting}[caption={Portal database and runtime settings}]
|
||||
userExpirationDays=3650
|
||||
logLevel=INFO
|
||||
dbType=h2
|
||||
h2Url=jdbc:h2:file:${portal.home}/data/portal;MODE=MySQL;DATABASE_TO_LOWER=TRUE;DEFAULT_NULL_ORDERING=HIGH;NON_KEYWORDS=VALUE;DB_CLOSE_ON_EXIT=FALSE;INIT=CREATE SCHEMA IF NOT EXISTS portal
|
||||
h2Username=sa
|
||||
h2Password=
|
||||
dbHost=localhost
|
||||
dbPort=3306
|
||||
dbUsername=portalAdmin
|
||||
dbRootUser=root
|
||||
caCertFile=${user.home}/cacerts.jks
|
||||
aesSeedFile=${portal.home}/portal.tomcat
|
||||
\end{lstlisting}
|
||||
The database and certificate password values are omitted from this excerpt. Preserve installation-specific encrypted values and use Portal's configuration facilities to change them. Do not copy ciphertext from a different installation with a different seed.
|
||||
|
||||
Spring Boot settings are packaged separately in \filename{application.properties}:
|
||||
\begin{lstlisting}[caption={Spring Boot settings}]
|
||||
spring.application.name=portal
|
||||
server.servlet.context-path=/portal
|
||||
server.servlet.session.timeout=540m
|
||||
spring.jpa.open-in-view=false
|
||||
spring.jpa.hibernate.ddl-auto=none
|
||||
spring.servlet.multipart.max-file-size=10MB
|
||||
spring.servlet.multipart.max-request-size=10MB
|
||||
\end{lstlisting}
|
||||
@@ -0,0 +1,5 @@
|
||||
% Jenkins replaces this placeholder before compiling release documentation.
|
||||
\chapter{Release Notes}
|
||||
\label{release-notes}
|
||||
Release notes are generated during the Jenkins \command{Build LaTeX} stage on
|
||||
\command{release/**} branches. Build a release to include its changes here.
|
||||
@@ -8,9 +8,10 @@
|
||||
\chapter{Revision History}
|
||||
\label{revisions}
|
||||
\begin{center}
|
||||
\begin{tabular}{|C{0.1\textwidth}|C{0.5\textwidth}|C{0.15\textwidth}|C{0.15\textwidth}|}
|
||||
\begin{tabular}{|C{0.1\textwidth}|C{\dimexpr0.6\linewidth-8\tabcolsep-5\arrayrulewidth\relax}|C{0.15\textwidth}|C{0.15\textwidth}|}
|
||||
\hline
|
||||
\bold{Revision Number} & \bold{Comment} & \bold{Date} & \bold{Name} \\ \hline
|
||||
2.0 & Align tool versions, Angular client, executable Spring Boot deployment, H2 defaults, and build instructions with the current project & 4 September, 2026 & Locusworks \\ \hline
|
||||
1.0 & Initial documentation draft & 10 April, 2018 & Isaac Parenteau \\ \hline
|
||||
\end{tabular}
|
||||
\end{center}
|
||||
\end{center}
|
||||
@@ -1,10 +1,15 @@
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
% FILE : Architecture.tex
|
||||
% SUBJECT : Document describing architecture issues in the entire Patch Repository system.
|
||||
% AUTHOR : (C) Copyright 2018 by Locusworks
|
||||
%
|
||||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
||||
|
||||
\chapter{Sample Settings.xml}
|
||||
\chapter{Sample Maven Settings}
|
||||
\label{sample-settings.xml}
|
||||
\lstinputlisting[language=XML, caption=settings.xml]{figures/settings.xml}
|
||||
Use these server IDs when Nexus authentication is required. Supply the referenced environment variables locally. Add \command{nexus-release} and \command{nexus-snapshot} entries with deployment credentials when publishing artifacts.
|
||||
\begin{lstlisting}[language=XML,caption={User Maven settings.xml}]
|
||||
<settings xmlns="http://maven.apache.org/SETTINGS/1.2.0">
|
||||
<servers>
|
||||
<server>
|
||||
<id>locusworks-public</id>
|
||||
<username>${env.NEXUS_USERNAME}</username>
|
||||
<password>${env.NEXUS_PASSWORD}</password>
|
||||
</server>
|
||||
</servers>
|
||||
</settings>
|
||||
\end{lstlisting}
|
||||
The Nexus URL is configured in the project POM. Maven settings do not configure the application's runtime database or embedded Tomcat. An optional server named \command{oss-index} supplies credentials for the opt-in dependency analyzer.
|
||||
Reference in new issue
Block a user