diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/admin_handbook.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/admin_handbook.md b/docs/admin_handbook.md index 25d0c74..38bdea3 100644 --- a/docs/admin_handbook.md +++ b/docs/admin_handbook.md @@ -1,7 +1,6 @@ --- lang: en title: CCA Admin Handbook -viewport: width=device-width, initial-scale=1 --- ## Introduction @@ -12,14 +11,14 @@ This handbook guides you in installing, configuring, and managing your CCA Selec You may obtain a stable or development version. The stable version is recommended for production. -- To obtain a stable version, go to the [release page](https://git.sr.ht/~runxiyu/cca/refs) and download the latest version that is not a pre-release. -- To obtain an unstable development version, clone the development repository at [`https://git.sr.ht/~runxiyu/cca`](https://git.sr.ht/~runxiyu/cca), or download the latest development snapshot's tarball at [`https://git.runxiyu.org/ykps/cca.git/snapshot/cca-master.tar.gz`](https://git.runxiyu.org/ykps/cca.git/snapshot/cca-master.tar.gz). +- To obtain a stable version, go to the [release page](https://git.sr.ht/~runxiyu/cca/refs) and download the latest version that is not a pre-release. +- To obtain an unstable development version, clone the development repository at [`https://git.sr.ht/~runxiyu/cca`](https://git.sr.ht/~runxiyu/cca), or download the latest development snapshot's tarball at [`https://git.runxiyu.org/ykps/cca.git/snapshot/cca-master.tar.gz`](https://git.runxiyu.org/ykps/cca.git/snapshot/cca-master.tar.gz). ## External dependencies -You need a [Go](https://go.dev) toolchain, [Pygments](https://pygments.org/), [GNU make](https://www.gnu.org/software/make/), [TeX Live](https://tug.org/texlive/) and [minify](https://github.com/tdewolff/minify). If you have everything else, you could install minify via `make minifier`, which would build and install it with your Go toolchain. +You need a [Go](https://go.dev) toolchain, [Pygments](https://pygments.org), [Pandoc](https://pandoc.org), [GNU make](https://www.gnu.org/software/make/), [TeX Live](https://tug.org/texlive/) and [minify](https://github.com/tdewolff/minify). -The Go toolchain will fetch more dependencies. You may wish to set a Go proxy (such as via `export GOPROXY='https://goproxy.io'`) if it stalls or is too slow. This is likely necessary for users in Mainland China due to firewall restrictions. +The Go toolchain will fetch a few more dependencies. You may wish to set a custom Go module proxy (such as via `export GOPROXY='https://goproxy.io'`) if it stalls or is too slow. This is likely necessary for users in Mainland China due to firewall restrictions. ## Building @@ -43,3 +42,4 @@ A working PostgreSQL setup is required. It is recommended to set up UNIX socket Before first run, run <code>psql <i>dbname</i> -f sql/schema.sql</code> to create the database tables, where <code><i>dbname</i></code> is the name of the database. Using the same database for different versions of CCASS is currently unsupported, although it should be trivial to manually migrate the database. + |