2020-08-14 09:43:41 +00:00
|
|
|
cdist-type__wikijs(7)
|
|
|
|
|
========================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
cdist-type__wikijs - Deploy the wiki.js software.
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
See wiki.js.org for more information. This type deploys with a postgresql
|
|
|
|
|
database, since it is the upstream recommended for production, and they seem to
|
2020-08-14 11:02:17 +00:00
|
|
|
strongly suggest that in the next releases, they will not support anything else.
|
2020-08-14 09:43:41 +00:00
|
|
|
|
|
|
|
|
Currently, this type servers wikijs as standalone, listening on ports 80 and
|
|
|
|
|
443, and with a service file for OpenRC. Feel free to contribute a
|
|
|
|
|
generalisation if you require one.
|
|
|
|
|
|
|
|
|
|
REQUIRED PARAMETERS
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
database-password
|
|
|
|
|
The password to the PSQL database.
|
|
|
|
|
|
2021-01-12 06:57:34 +00:00
|
|
|
version
|
|
|
|
|
'wikijs' version to be deployed.
|
|
|
|
|
|
2020-08-14 09:43:41 +00:00
|
|
|
OPTIONAL PARAMETERS
|
|
|
|
|
-------------------
|
|
|
|
|
|
|
|
|
|
database
|
|
|
|
|
The name of the PSQL database to connect to. If omitted, then 'wikijs' is
|
|
|
|
|
used.
|
|
|
|
|
|
|
|
|
|
database-user
|
|
|
|
|
The name of the PSQL database user to connec as. If omitted, then 'wikijs' is
|
|
|
|
|
used.
|
|
|
|
|
|
|
|
|
|
letsencrypt-mail
|
|
|
|
|
If the SSL parameter is passed, then we setup wikijs to automatically obtain
|
|
|
|
|
certificates: this is the email used to sign up to a LE account.
|
|
|
|
|
|
2021-01-12 06:57:34 +00:00
|
|
|
http-port
|
|
|
|
|
Specify HTTP port, defaults to 80.
|
|
|
|
|
|
|
|
|
|
http-port
|
|
|
|
|
Specify HTTPS port, defaults to 443. Only relevant if the SSL flag is enabled.
|
|
|
|
|
|
2020-08-14 09:43:41 +00:00
|
|
|
BOOLEAN PARAMETERS
|
|
|
|
|
------------------
|
|
|
|
|
|
|
|
|
|
ssl
|
|
|
|
|
Whether or not to enable the wikijs automatic obtention of LE certificates.
|
|
|
|
|
|
|
|
|
|
AUTHORS
|
|
|
|
|
-------
|
|
|
|
|
Joachim Desroches <joachim.desroches@epfl.ch>
|
|
|
|
|
|
|
|
|
|
COPYING
|
|
|
|
|
-------
|
|
|
|
|
Copyright \(C) 2020 Joachim Desroches. You can redistribute it
|
|
|
|
|
and/or modify it under the terms of the GNU General Public License as
|
|
|
|
|
published by the Free Software Foundation, either version 3 of the
|
|
|
|
|
License, or (at your option) any later version.
|
