diff options
Diffstat (limited to '')
| -rw-r--r-- | docs/Makefile | 7 | ||||
| -rw-r--r-- | docs/admin_handbook.html | 15 | ||||
| -rw-r--r-- | docs/cca.scfg.example | 14 |
3 files changed, 8 insertions, 28 deletions
diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 6e023a7..0000000 --- a/docs/Makefile +++ /dev/null @@ -1,7 +0,0 @@ -.PHONY: docs - -docs: ../dist/docs/admin_handbook.html ../dist/docs/cca.scfg.example ../dist/docs/handbook.css - -../dist/docs/%: % - mkdir -p ../dist/docs - cp $< $@ diff --git a/docs/admin_handbook.html b/docs/admin_handbook.html index 4d3e1db..c746bd3 100644 --- a/docs/admin_handbook.html +++ b/docs/admin_handbook.html @@ -25,16 +25,17 @@ <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> + <h2>External dependencies</h2> + <p> + You need a <a href="https://go.dev">Go</a> toolchain, <a href="https://www.gnu.org/software/make/">GNU make</a>, <a href="https://tug.org/texlive/">TeX Live</a> and <a href="https://github.com/tdewolff/minify">minify</a>. If you have everything else, you could install minify via <code>make minifier</code>, which would build and install it with your Go toolchain. + </p> <p> - You need a standard Go toolchain to build the backend. You need <a href="https://github.com/tdewolff/minify">minify</a> to build the minified frontend; read the README in the frontend directory for details; if you don’t want to minify, you could just copy the files over. + The Go toolchain will fetch more dependencies. You may wish to set a Go proxy (such as via <code>export GOPROXY='https://goproxy.io'</code>) if it stalls or is too slow. This is likely necessary for users in Mainland China due to firewall restrictions. </p> - <pre>cd ./backend/ -make -cd ../frontend/ -make</pre> + <h2>Building</h2> + <p>Just type <code>make</code>.</p> <p> - Your compiled files will appear in <code>dist/</code>. + The built files will appear in <code>dist/</code>. The binary, with all runtime resources other than the configuration file embedded, is located at <code>dist/cca</code>. A minified copy of the documentation, including a sample configuration file, is located at <code>dist/docs/</code>. </p> <h2>Configuration</h2> <p> diff --git a/docs/cca.scfg.example b/docs/cca.scfg.example index c33293b..cdae443 100644 --- a/docs/cca.scfg.example +++ b/docs/cca.scfg.example @@ -6,20 +6,6 @@ url http://localhost:5555 # cookies and may come with other production-related changes in the future. prod false -# Where are the template files? Usually this should be a directory inside the -# source directory, though it might exist in /usr/local/share or /usr/share if -# this ever gets packaged or something. Remember that this is a file glob, so -# be sure to use /* or something similar. -tmpl tmpl/* - -# Where is the static directory? Reverse proxy setups are not recommended for -# performance reasons so we serve the static files ourselves. -static static/ - -# Where could the source code of this instance be found? It is important to -# keep this up to date to comply with the AGPL. -source https://git.sr.ht/~runxiyu/cca - listen { # Which protocol are we listening for? Currently only "http" is # supported because it is difficult to configure FastCGI to work with |