From ea58f98ecb76e366eb8b01925f89b283596d9d4d Mon Sep 17 00:00:00 2001 From: Matthias Stecher Date: Sat, 24 Oct 2020 13:36:26 +0200 Subject: [PATCH] __nextcloud: added initial manpage Still somehow a draft .. --- type/__nextcloud/man.rst | 173 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 173 insertions(+) create mode 100644 type/__nextcloud/man.rst diff --git a/type/__nextcloud/man.rst b/type/__nextcloud/man.rst new file mode 100644 index 0000000..96d8eac --- /dev/null +++ b/type/__nextcloud/man.rst @@ -0,0 +1,173 @@ +cdist-type__nextcloud(7) +======================== + +NAME +---- +cdist-type__nextcloud - Installs and manages a nextcloud instance + + +DESCRIPTION +----------- +This type installs, upgrades and configure a nextcloud instance. + +It installs the application in the webspace based on the object id as relative +path from the webroot. If you want to install it directly in the webroot, you +must trick out this type by setting the webroot as parent directory. + + +REQUIRED PARAMETERS +------------------- +version + The version that should be installed. If it is already installed and the + installed version lower, it will upgrade nextcloud if ``--install-only`` is + not set. + + The type will never downgrade a nextcloud instance. Rather, it will fail, + as this is a missconfiguration. Downgrades are not recommended and + supported by upstream. Such cases can happen if the nextcloud instance was + upgraded via the built-in nextcloud installer. In such cases, it is + recommended to use the ``--install-only`` option. + +admin-password + The administrator password to access the nextcloud instance. Must be given + in plain text. + + +OPTIONAL PARAMETERS +------------------- +webroot + The webroot which will be used as basis for the installation. This may be + already detected by an explorer. Must be an absolute path (starting with a + slash). + +mode + Sets the unix file mode of the nextcloud directory. This is not inherited + to child files or folders. Defaults to `755`. + +user + The user which owns the complete nextcloud directory. The php application + should be executed with this user. All nextcloud commands will be executed + with this user. This type will not create the unix user. + + The type assumes the default `www-data` user, which is common on Debian + systems. **If you change this option, please do the same with the group + parameter!** + +group + The group all files and folders of the nextcloud installation should have. + Defaults to `www-data`. Should be changed with ``--user``. + + +BOOLEAN PARAMETERS +------------------ +install-only + Skips all nextcloud upgrades done by this type. Should be used when + nextcloud upgrades are (*exclusively*) done via the built-in updater. + + +NEXTCLOUD CONFIG PARAMETERS +--------------------------- +host + All hostnames where the the users can log into nextcloud. If you access + nextcloud via a hostname not given to this list, the access fails. This + parameter can be set multiple times. + +admin-user + The username of the administrative user which will be created while the + installation. This parameter has no effect if nextcloud will not be + installed. + +admin-email + The email address of the administrative user. This parameter has no effect + if nextcloud will not be installed. + +database-type + Sets the type of database that should be used as backend. Possible backends + are: + + SQLite + Use ``sqlite`` or ``sqlite3``. Saves everything in a database file + stored in the data directory. It is only recommended for very small + installations or test environments from upstream. + + *All further database options are ignored if SQLite is selected as + database backend.* + + MariaDB + Use ``mysql`` or ``mariadb``. MariaDB and MySQL are threated the same + way. They are the recommended database backends recommended from + upstream. + + PostgreSQL + Use ``pgsql``, ``postgres`` or ``postgresql``. + + **This parameter defaults to the SQLite database backend, as it is the + simplest one to setup and do not require extra parameters.** + +database-host + The database host to connect to. Possible are hostnames, ip addresses or + UNIX sockets. UNIX sockets must set in the format of + ``localhost:/path/to/socket``. If an non-standard port is used, set it + after the hostname or ip address seperated by an colon (``:``). + +database-name + The name of the database to connect to. + +database-user + The username to access the database. + +database-password + The password required to authorize the given user. + +database-prefix + The table prefix used by nextcloud. If nothing set, it defaults to + ``oc_``. + + +WEBROOT DETECTION +----------------- +TBA. + + +MESSAGES +-------- +installed + Nextcloud was successfully installed. + +upgraded $old to $new + The nextcloud version was upgraded from `$old` to `$new`. + +configured + Nextcloud configuration was changed. + + +ABORTS +------ +Aborts in the following cases: + +The current installed version is greather than the version that should be +installed. See the parameter description of `--version` for detailed +information. The problem can be fixed by bumping the version value to at least +the version that is currently installed or use the parameter `--install-only`. + +The type aborts if there is no webroot given as parameter and no could be +detected by the type itself. Please set the webroot via `--webroot` or extend +this type. + + +EXAMPLES +-------- +TBA. + + +AUTHORS +------- +Matthias Stecher + + +COPYRIGHT +--------- +Copyright \(C) 2020 Matthias Stecher. 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.