nextcloud-formula

A SaltStack formula to manage a Nextcloud server.

The scope of this formula is rather narrow. It manages only Nextcloud code and configuration. (We do not try to be smart and tell you how your Nextcloud setup should exactly look like.) Nginx, Apache, PHP, MySQL, MariaDB and PostgreSQL themselves are to be dealt with in their respective formulas, although this formula may provide ready-to-use snippets or configuration hints.

Table of Contents

• General notes
• Contributing to this repo
• Special notes
• Available states
• Testing

General notes

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 pay attention to the pillar.example file and/or Special notes section.

Contributing to this repo

Commit messages

Commit message formatting is significant!!

Please see How to contribute for more details.

pre-commit

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

Special notes

None

Available states

• nextcloud
• nextcloud.package
• nextcloud.config
• nextcloud.clean
• nextcloud.config.clean
• nextcloud.package.clean
• nextcloud.apache
• nextcloud.apache.config
• nextcloud.apache.config.clean
• nextcloud.client
• nextcloud.client.remove

nextcloud

Meta-state (This is a state that includes other states).

This installs the nextcloud package, manages the nextcloud configuration.

nextcloud.package

This state will install the nextcloud package only.

nextcloud.config

This state will configure nextcloud and has a dependency on nextcloud.install via include list.

nextcloud.clean

Meta-state (This is a state that includes other states).

this state will undo everything performed in the nextcloud meta-state in reverse order, i.e. removes the configuration file and then uninstalls the package.

nextcloud.config.clean

This state will remove the configuration of nextcloud.

nextcloud.package.clean

This state will remove the nextcloud package and has a depency on nextcloud.config.clean via include list.

nextcloud.apache

Meta-state (This is a state that includes other states).

This state installs a Apache configuration file for you to include. Changes in the snippet trigger a reload of the webserver.

nextcloud.apache.config

This state will create a config snippet for Apache and has a dependency on nextcloud.config via include list.

nextcloud.apache.config.clean

This state will remove the Apache config snippet and reload the webserver.

nextcloud.client

This state will install the Nextcloud client.

nextcloud.client.remove

This state will remove the Nextcloud client.

Testing

Linux testing is done with kitchen-salt.

Requirements

• 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.

bin/kitchen converge

Creates the docker instance and runs the nextcloud main state, ready for testing.

bin/kitchen verify

Runs the inspec tests on the actual instance.

bin/kitchen destroy

Removes the docker instance.

bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.

bin/kitchen login

Gives you SSH access to the instance for manual testing.