28 lines
1.6 KiB
TeX
28 lines
1.6 KiB
TeX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
% FILE : Introduction.tex
|
|
% SUBJECT : Document describing the portal system in general terms.
|
|
% AUTHOR : (C) Copyright 2018 by Locusworks
|
|
%
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
\chapter{Introduction}
|
|
\label{introduction}
|
|
|
|
\portal is a website designed to be a central area where a user can schedule recurring automated tasks. The user can configure the service to connect to remote machines and execute
|
|
scripts on those machines or perform execution of local tasks. It can also send and receive files to/from remote machines.
|
|
|
|
The \portal can checkout git repositories locally if need be. This allows for source controlled scripts to be utilized on the web site as well just in case certain external code needs
|
|
to be updated before local execution can be performed.
|
|
|
|
\portal consists of several interacting programs.
|
|
|
|
\begin{enumerate}
|
|
\item \bold{\Client}
|
|
The client (written in TypeScript and HTML using Angular \AngularVersion) is used by the user to create scheduled tasks, git repositories and general configuration of the \portal.
|
|
\item \bold{\Server}
|
|
The server (written in Java v\JavaVersion) manages the activity of the entire \portal system.
|
|
\end{enumerate}
|
|
|
|
This document describes the entire \portal system's requirements, design, and implementation. If you plan to work on \portal development you should read this entire document.
|
|
If you are a \portal administrator or user you may wish to read Chapter~\ref{deployment} describing how to deploy a \portal system.
|