diff options
Diffstat (limited to 'docs/admin_handbook.html')
| -rw-r--r-- | docs/admin_handbook.html | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/admin_handbook.html b/docs/admin_handbook.html new file mode 100644 index 0000000..e46ea55 --- /dev/null +++ b/docs/admin_handbook.html @@ -0,0 +1,49 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <title>CCA Admin Handbook</title> + <link rel="stylesheet" href="./handbook.css" /> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1" /> + </head> + <body> + <header> + <h1> + CCA Admin Handbook + </h1> + </header> + <main> + <h2>Introduction</h2> + <p> + This handbook guides you in installing, configuring, and managing your CCA Selection System (CCASS) instance. + </p> + <h2>Downloading</h2> + <p> + You may obtain a stable or development version. The stable version is recommended for production. + </p> + <ul> + <li>To obtain a stable version, go to the <a href="https://git.sr.ht/~runxiyu/cca/refs">release page</a> and download the latest version that is not a pre-release.</li> + <li>To obtain an unstable development version, clone the development repository at <a href="https://git.sr.ht/~runxiyu/cca"><code>https://git.sr.ht/~runxiyu/cca</code></a>, or download the latest development snapshot’s tarball at <a href="https://git.runxiyu.org/ykps/cca.git/snapshot/cca-master.tar.gz"><code>https://git.runxiyu.org/ykps/cca.git/snapshot/cca-master.tar.gz</code></a>.</li> + </ul> + <h2>Building</h2> + <p> + There is a top-level <code>Makefile</code> that builds the backend. This is all the compilation necessary at the moment; in the future, the front-end code such as the CSS and JavaScript may be minified too. + </p> + <p> + You may also wish to strip the binary’s debug symbols to shrink the file size: + </p> + <pre>make && strip cca</pre> + <h2>Configuration</h2> + <p> + The <code>static</code> and <code>tmpl</code> directories must be available to the running program, in addition to a configuration file <code>cca.scfg</code>. + </p> + <p> + Copy <a href="./cca.scfg.example">the example configuration file</a> to <code>cca.scfg</code> in the working directory where you intend to run CCASS. Then, edit it, while paying attention to the following: + </p> + <ul> + <li> + </li> + </ul> + </main> + </body> +</html> |