Manage Nextcloud Server installation, updates, apps, users, groups and more with Salt.
This formula includes an execution and state module to achieve tight integration with Nextcloud and thus makes administration much more convenient. Many of the occ functions have been wrapped.
This formula takes care of the Nextcloud part only. To be able to run Nextcloud, you will need to configure PHP as well as an HTTP server, at least. I use my own formulae for PHP, MariaDB, Nginx and Redis, but most of those are a bit simpler than the official ones found in the official organization. You can find sample parameters for my formulae in the docs.
Table of Contents
See the full SaltStack Formulas installation and usage instructions.
If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.
If you want to use this formula, please pay attention to the FORMULA file and/or git tag,
which contains the currently released version. This formula is versioned according to Semantic Versioning.
See Formula Versioning Section for more details.
If you need (non-default) configuration, please refer to:
- how to configure the formula with map.jinja
- the
pillar.examplefile - the Special notes section
An example pillar is provided, please see pillar.example. Note that you do not need to specify everything by pillar. Often, it's much easier and less resource-heavy to use the parameters/<grain>/<value>.yaml files for non-sensitive settings. The underlying logic is explained in map.jinja.
The following states are found in this formula:
nextcloudnextcloud.packagenextcloud.confignextcloud.config.basenextcloud.config.filenextcloud.servicenextcloud.usersnextcloud.groupsnextcloud.appsnextcloud.cleannextcloud.package.cleannextcloud.config.cleannextcloud.service.cleannextcloud.users.cleannextcloud.groups.cleannextcloud.apps.clean
Meta-state.
This installs the nextcloud package, manages the nextcloud configuration file and then starts the associated nextcloud service.
Installs the nextcloud package only.
Manages the nextcloud service configuration. Has a dependency on nextcloud.package.
Starts the Nextcloud Cron service and enables it at boot time. Has a dependency on nextcloud.config.
Meta-state.
Undoes everything performed in the nextcloud meta-state
in reverse order, i.e.
stops the service,
removes the configuration file and then
uninstalls the package.
Removes the nextcloud package. Has a dependency on nextcloud.config.clean.
Removes the configuration of the nextcloud service and has a dependency on nextcloud.service.clean.
Stops the Nextcloud Cron service and disables it at boot time.
Commit message formatting is significant!
Please see How to contribute for more details.
pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes.
First install the pre-commit package manager using the appropriate method, then run bin/install-hooks and
now pre-commit will run automatically on each git commit.
$ bin/install-hooks pre-commit installed at .git/hooks/pre-commit pre-commit installed at .git/hooks/commit-msg
There is a script that semi-autodocuments available states: bin/slsdoc.
If a .sls file begins with a Jinja comment, it will dump that into the docs. It can be configured differently depending on the formula. See the script source code for details currently.
This means if you feel a state should be documented, make sure to write a comment explaining it.
Linux testing is done with kitchen-salt.
- Ruby
- Docker
$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]Where [platform] is the platform name defined in kitchen.yml,
e.g. debian-9-2019-2-py3.
Creates the docker instance and runs the nextcloud main state, ready for testing.
Runs the inspec tests on the actual instance.
Removes the docker instance.
Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.
Gives you SSH access to the instance for manual testing.
- manage log config
- manage 2fa
- manage theme config
- manage app/user config